Torrust Index Backend

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.

Documentation

You can read the Torrust Index documentation here.

Installation

1. Setup Rust / Cargo in your Environment.

2. Clone this repo.

3. Set the database connection URI in the projects /.env file:

   cd torrust-index-backend
   echo "DATABASE_URL=sqlite://data.db?mode=rwc" >> .env
   

4. Install sqlx-cli and build the sqlite database:

   cargo install sqlx-cli
   sqlx db setup
   

5. Build the binaries:

   cargo build --release
   

6. Run the backend once to generate the config.toml file:

   ./target/release/torrust-index-backend
   

7. Review and edit the default /config.toml file.

Please view the configuration documentation.

8. Run the backend again:

   ./target/torrust-index-backend
   

Contact and Contributing

Please consider the Torrust Contribution Guide.

Please report issues:

• Torrust Index Backend specifically: here.
• Torrust Index in general: here.

Credits & Sponsors

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!