You probably don't want to use this, yet. Federation is WIP, etc.
We currently have authentication, users, profiles, statuses, content warnings, actors and statuses published as both HTML and AS2, and timelines. We do not have a job system, status delivery, inboxes, outboxes, notifcations, mentions, post privacy, or account privacy.
If you want to work on making Rustodon feature-complete, check out the issue tracker! We're not just looking for Rust devs, either; CSS witches, documentarians, UI/UX aficionados, etc, are highly welcome
Hacking on the code
You will need to install several base dependencies:
- Rust. Make sure you have followed the official instructions regarding your
In the Rust development environment, all tools are installed to the ~/.cargo/bin directory, and this is where you will find the Rust toolchain, including rustc, cargo, and rustup. Accordingly, it is customary for Rust developers to include this directory in their PATH environment variable. During installation rustup will attempt to configure the PATH. Because of differences between platforms, command shells, and bugs in rustup, the modifications to PATH may not take effect until the console is restarted, or the user is logged out, or it may not succeed at all. If, after installation, running rustc --version in the console fails, this is the most likely reason.
- Postgres. If you don't have a Postgres instance available, you can use the supplied docker-compose configuration file to start an instance:
The instance will be started in the background. The default username and password is
docker-compose up -d
rustodon. The corresponding connection string would be:
On some operating systems, you may need to separately install the Postgres client library:
apt install libpq-dev
pacman -S postgresql-libs
- SASS. To install, follow the official directions, and make sure the
sassbinary is somewhere in your
Once you have installed these base components, you should run
scripts/setup to install the remainder of the application dependencies.
Running the application
To run the application once you have installed all dependencies, you should run either:
cargo run: Runs just the server
fors start: Runs the server and additional helper processes
Rustodon will launch on
http://localhost:8000 by default; this can be overriden by setting certain environment variables.
Federation requires that the application know where it's hosted, and (thanks to Webfinger) also forces us to serve over HTTPS. To get around this in a development environment, you can use ngrok or a similar service. To make sure the app knows where it's serving from (used to compute, eg, AS2 UIDs), set
Running database migrations
diesel database setup
Running the tests
cargo test --all
Thanks goes to these wonderful people (emoji key):
iliana destroyer of worlds
This project follows the all-contributors specification. Contributions of any kind welcome!