This repository serves as the backend for the Torrust Index project, that implements the Torrust Index Application Interface.
We also provide the Torrust Index Frontend project, that is our reference web-application that consumes the API provided here.
You can read the Torrust Index documentation here.
-
Setup Rust / Cargo in your Environment.
-
Clone this repo.
-
Set the database connection URI in the projects
/.env
file:cd torrust-index-backend echo "DATABASE_URL=sqlite://data.db?mode=rwc" >> .env
-
Install sqlx-cli and build the sqlite database:
cargo install sqlx-cli sqlx db setup
-
Build the binaries:
cargo build --release
-
Run the backend once to generate the
config.toml
file:./target/release/torrust-index-backend
-
Review and edit the default
/config.toml
file.
Please view the configuration documentation.
-
Run the backend again:
./target/torrust-index-backend
Please consider the Torrust Contribution Guide.
Please report issues:
This project was developed by Dutch Bits for Nautilus Cyberneering GmbH.
The project has been possible through the support and contribution of both Nautilus Cyberneering, its team and collaborators, as well as that of our great open source contributors. Thank you to you all!