Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maelstrom-rs/maelstrom
High performance Matrix Home Server in rust.
https://github.com/maelstrom-rs/maelstrom
chat decentralized matrix matrix-org rust web3
Last synced: about 2 months ago
JSON representation
High performance Matrix Home Server in rust.
- Host: GitHub
- URL: https://github.com/maelstrom-rs/maelstrom
- Owner: maelstrom-rs
- License: apache-2.0
- Created: 2020-04-03T12:35:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-13T21:36:15.000Z (over 4 years ago)
- Last Synced: 2024-02-13T21:45:58.283Z (11 months ago)
- Topics: chat, decentralized, matrix, matrix-org, rust, web3
- Language: Rust
- Size: 295 KB
- Stars: 221
- Watchers: 18
- Forks: 20
- Open Issues: 105
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Maelstrom 
A high-performance [Matrix](https://matrix.org) Home-Server written in [Rust](rust-lang.org) designed to have a plugable storage engine, scalable, and light on resources.
General discussion for development is at [#maelstrom-server:matrix.org](https://matrix.to/#/#maelstrom-server:matrix.org)
## Project Status
This is a brand new project under **daily** active development. It is not currently in usable form yet.
### Completed Features
You can review the [Closed `matrix-spec` Issues](https://github.com/maelstrom-rs/maelstrom/issues?q=is%3Aissue+is%3Aclosed+sort%3Acreated-asc+label%3Amatrix-spec+) in the issue tracker for a list of completed features.
## Project Goals
1. Performance, both in terms of scale and minimal resources.
2. From scratch design, no legacy architecture decisions.
3. Support for embedded (Raspi, Jetson Nano, etc.) or clustered deployment with configurable storage engine (e.g. Postgres, Sqlite, Sled, etc.).
4. First-class e2e encryption and p2p support (as Matrix.org works towards a direction).
5. Designed for not only chat, but decentralized IoT use cases as well.
6. SOCKS5 Proxy support to enable .onion homeservers ([Relevant Synapse Issue](https://github.com/matrix-org/synapse/issues/7088))
## Why
This project started due to a strong interest/support of Web 3.0 (decentralized web applications). Additionally,
having a performant embeddable home server can enable a stronger usecase for decentralized IoT applications in addition to chat.
## Building & Running
### Using Rust
```bash
# install rust if needed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# clone repo and cd
git clone https://github.com/maelstrom-rs/maelstrom.git && cd maelstrom
# copy .env-example and set with your specific settings
cp Settings-example.yml Settings.yml
# build & run
cargo run --release
```
### Generating the AUTH_KEY
```bash
openssl ecparam -genkey -name prime256v1 | openssl pkcs8 -topk8 -nocrypt -out ec_private.pem
```
Make sure you set AUTH_KEY_FILE to `path/to/ec_private.pem`
## Technologies Used
- [Actix-web](https://actix.rs) A high performance webserver written in Rust
- [sqlx](https://github.com/launchbadge/sqlx) A rust version of the popular sqlx db library
- [jwt](https://jwt.io)
- [Ruma](https://github.com/ruma)
## Similar Projects
The following are some other Rust based Home Server projects worth looking at:
- [Ruma](https://github.com/ruma) The server isn't maintained, but he client libraries appear so.
- [Conduit](https://git.koesters.xyz/timo/conduit) A new Rust based Home Server under development.
## License
Licensed under either of [Apache License](LICENSE-APACHE), Version
2.0 or [MIT license](LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Maelstrom by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.