conduit/README.md

# Conduit
### A Matrix homeserver written in Rust

[![Liberapay](https://img.shields.io/liberapay/receives/timokoesters?logo=liberapay)](https://liberapay.com/timokoesters)
[![Matrix](https://img.shields.io/matrix/conduit:koesters.xyz?server_fqdn=matrix.koesters.xyz&logo=matrix)](https://matrix.to/#/#conduit:koesters.xyz)

#### 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.

#### Is it fast?

See it in action: <https://www.youtube.com/watch?v=HoBslDtqC1k>

#### 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.

#### How can I deploy my own?

##### From source

Clone the repo, build it with `cargo build --release` and call the binary
(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY_FROM_SOURCE.md)

##### Using Docker

Build the docker image 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?

- Federation (Talk to other Matrix servers)
- Appservices (Bridges and Bots)
- 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 PR

#### Donate

Liberapay: <https://liberapay.com/timokoesters/>\
Bitcoin: `bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n`
Update 'README.md' 2020-04-09 15:39:45 +00:00			`# Conduit`
			`### A Matrix homeserver written in Rust`
Add README.md 2020-04-03 15:53:06 +00:00
Update readme and cargo.toml 2020-04-10 05:53:20 +00:00			`[![Liberapay](https://img.shields.io/liberapay/receives/timokoesters?logo=liberapay)](https://liberapay.com/timokoesters)`
			`[![Matrix](https://img.shields.io/matrix/conduit:koesters.xyz?server_fqdn=matrix.koesters.xyz&logo=matrix)](https://matrix.to/#/#conduit:koesters.xyz)`
Add liberapay, change pr template 2020-04-08 20:28:03 +00:00
docs: add documentation to the repo and improve layout 2020-08-12 19:17:53 +00:00			`#### What is the goal?`
Update 'README.md' 2020-05-29 07:54:30 +00:00
			`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.`

improvement: video link in readme 2020-05-21 15:36:07 +00:00			`#### Is it fast?`

			`See it in action: <https://www.youtube.com/watch?v=HoBslDtqC1k>`

Update 'README.md' 2020-05-29 07:54:30 +00:00			`#### Can I try it out?`
Add README.md 2020-04-03 15:53:06 +00:00
Update README, fix CI (#148) Update 'README.md' Update README, fix CI Co-authored-by: timokoesters <timo@koesters.xyz> Reviewed-on: https://git.koesters.xyz/timo/conduit/pulls/148 2020-07-16 05:50:11 +00:00			Yes! Just open a Matrix client (<https://app.element.io> or Element Android for example) and register on the `https://conduit.koesters.xyz` homeserver.
Update 'README.md' 2020-05-29 07:54:30 +00:00
			`#### How can I deploy my own?`

docs: add documentation to the repo and improve layout 2020-08-12 19:17:53 +00:00			`##### From source`
Add README.md 2020-04-03 15:53:06 +00:00
docs: add documentation to the repo and improve layout 2020-08-12 19:17:53 +00:00			Clone the repo, build it with `cargo build --release` and call the binary
			`(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY_FROM_SOURCE.md)`

			`##### Using Docker`

			`Build the docker image and run it with docker or docker-compose. [Read more](docker/README.md)`
Add README in docker folder and mention docker in Conduit's README 2020-08-04 20:06:13 +00:00
Add README.md 2020-04-03 15:53:06 +00:00			`#### 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`

Update 'README.md' 2020-05-29 07:54:30 +00:00			`#### What are the biggest things still missing?`

Improve README 2020-07-11 07:51:58 +00:00			`- Federation (Talk to other Matrix servers)`
			`- Appservices (Bridges and Bots)`
			`- Push notifications on mobile`
			`- Notification settings`
Update 'README.md' 2020-05-29 07:54:30 +00:00			`- Lots of testing`
Add liberapay, change pr template 2020-04-08 20:28:03 +00:00
Update 'README.md' 2020-05-29 08:04:19 +00:00			`Also check out the [milestones](https://git.koesters.xyz/timo/conduit/milestones).`

Update README.md 2020-04-12 20:29:48 +00:00			`#### How can I contribute?`

Improve README 2020-07-11 07:51:58 +00:00			`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 PR`
Update README.md 2020-04-12 20:29:48 +00:00
Add liberapay, change pr template 2020-04-08 20:28:03 +00:00			`#### Donate`

Update 'README.md' 2020-06-16 06:43:46 +00:00			`Liberapay: <https://liberapay.com/timokoesters/>\`
Update 'README.md' 2020-06-16 06:21:06 +00:00			Bitcoin: `bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n`