Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
conduwuit
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
🥺
conduwuit
Commits
bb1064ce
Unverified
Commit
bb1064ce
authored
4 years ago
by
Timo Kösters
Browse files
Options
Downloads
Patches
Plain Diff
docs: small readme changes
parent
bd6507ea
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+25
-24
25 additions, 24 deletions
README.md
with
25 additions
and
24 deletions
README.md
+
25
−
24
View file @
bb1064ce
# Conduit
### A Matrix homeserver written in Rust
[

](https://liberapay.com/timokoesters)
[

](https://matrix.to/#/#conduit:matrix.org)
#### What is the goal?
A fast Matrix homeserver that's easy to set up and just works. You can install
it on a mini-computer like the Raspberry Pi to host Matrix for your family,
friends or company.
#### Can I try it out?
Yes! Just open a Matrix client (
<https://app.element.io>
or Element Android for
example) and register on the
`https://conduit.koesters.xyz`
homeserver.
#### What is it build on?
-
[
Ruma
](
https://www.ruma.io
)
: Useful structures for endpoint requests and
responses that can be (de)serialized
-
[
Sled
](
https://github.com/spacejam/sled
)
: A simple (key, value) database with
good performance
-
[
Rocket
](
https://rocket.rs
)
: A flexible web framework
#### What are the biggest things still missing?
-
Most federation features (invites, e2ee)
-
Push notifications on mobile
-
Notification settings
-
Lots of testing
Check out the
[
Conduit 1.0 Release Milestone
](
https://gitlab.com/famedly/conduit/-/milestones/3
)
.
#### How can I deploy my own?
##### Deploy
Download or compile a
c
onduit binary and call it from somewhere like a systemd script.
[
Read
Download or compile a
C
onduit binary
, set up the config
and call it from somewhere like a systemd script.
[
Read
more
](
DEPLOY.md
)
##### Deploy using Docker
...
...
@@ -33,32 +51,15 @@ ##### Deploy using Docker
Or build and run it with docker or docker-compose.
[
Read more
](
docker/README.md
)
#### What is it build on?
-
[
Ruma
](
https://www.ruma.io
)
: Useful structures for endpoint requests and
responses that can be (de)serialized
-
[
Sled
](
https://github.com/spacejam/sled
)
: A simple (key, value) database with
good performance
-
[
Rocket
](
https://rocket.rs
)
: A flexible web framework
#### What are the biggest things still missing?
-
Appservices (Bridges and Bots)
-
Most federation features (invites, e2ee)
-
Push notifications on mobile
-
Notification settings
-
Lots of testing
Also check out the
[
milestones
](
https://git.koesters.xyz/timo/conduit/milestones
)
.
#### How can I contribute?
1.
Look for an issue you would like to work on and make sure it's not assigned
to other users
2.
Ask someone to assign the issue to you (comment on the issue or chat in
#conduit:
matrix.org
)
3.
Fork the repo and work on the issue. #conduit:
matrix.org
is happy to help :)
4.
Submit a
P
R
#conduit:
nordgedanken.dev
)
3.
Fork the repo and work on the issue. #conduit:
nordgedanken.dev
is happy to help :)
4.
Submit a
M
R
#### Donate
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment