Erooster
A mail suite written in rust meant to be easy to use.
Getting started
Currently the setup is quite rough.
You need some certificates for your server (pem format) and a postgres database.
To get started you need a config.yml like this it can either be in /etc/erooster or the working dir:
tls:
key_path: "./certs/key.pem"
cert_path: "./certs/cert.pem"
mail:
maildir_folders: "./maildir"
hostname: "localhost"
database:
postgres_url: ""
listen_ips:
- "[::1]"
- "127.0.0.1"
webserver:
port: "80"
tls: false
displayname: Erooster
sentry: false
The maildir_folders defines where the emails and folders can be found at. This is close to the maildir format postfix uses. (We use other files to keep track of the state of it)
After that you can just do cargo run --release to run it. The server is reachable via the usual IMAP ports. STARTTLS is currently not supported.
Setting up users
To set up users you can use the eroosterctl command. It will talk to the database. So make sure your config file is set up.
To register a user you simply run eroosterctl register and follow the questions. The password is safed as an argon2 hash inside the database.
To change a password there is the change-password subcommand. You need to provide the old password and the new one. It is planned that admins can also change this using a preencrypted password instead. In the future this is going to be replaced by an integrated web interface users can directly use.
Note: The status subcommand at this time doesn't actually check the server status.
Features
- Imap4rev2 compatible
- Maildir support
- TLS by default
- Single binary
- Low Resource usage
- Postgres first
- Integrated SMTP server
Non Goal
- Implementing every single peace of optional spec
- MySQL/Mariadb support
- Support for imap LOGIN command (It is per rev2 spec)
- Support for POP3
- Support for Exchange
Error Reporting
Erosster by default does not auto report an panics or errors. It provides however a github reporting link on panics.
Additionally it is able to let ou auto report to a sentry. This also will record performance using tracing. Due to how sentry works this is not public. It is disabled by default due to gdpr rules.
To enable sentry please set sentry: true in yout config file.
Comparisons
As I made a reddit post some comparisons were made in the commands. You can check them out at https://www.reddit.com/r/rust/comments/uyxxrg/comment/ia7qwcg/?utm_source=share&utm_medium=web2x&context=3
150 Dec 27, 2022
158 Jan 1, 2023
14.8k Jan 6, 2023
2.1k Jan 7, 2023
3.5k Dec 31, 2022
3 Apr 15, 2023
39 Sep 13, 2020
88 Dec 27, 2022
1.3k Jan 4, 2023
228 Dec 28, 2022
3 Apr 26, 2023
18 Oct 11, 2022
79 Sep 19, 2023
52 Mar 25, 2022