Docker compose configuration for the Torrust Index

This repo contains different sample Docker Compose configurations for the Torrust Index.

The current configurations are:

• demo: demo configuration, just to try the index locally.
• droplet: configuration to install the Index in a Digital Ocean Droplet. It should be very similar to any virtual machine.

Requirements

• Docker version 24.0.3, build 3713ee1.
• GNU bash, version 5.2.15(1)-release (x86_64-pc-linux-gnu).

Setup

After running the application remember the following:

• There is no user created by default, you need to sign up. The first user to sign up will be the admin.
• There are no torrent tags created by default, you need to create them.
• Check the config***.toml files to see the default values.

Recommendations

• If you are using SQLite as the database engine, you can use DB Browser for SQLite.
• Make sure you mount a volume to persist database data. That should be the default behavior, but it's better to be sure. Some configurations use a mail catcher container to catch emails sent by the index. You can access the mail catcher web interface at http://localhost:1080.

MegaLinter

Running MegaLinter locally:

npx mega-linter-runner

Run and try to fix issues:

npx mega-linter-runner --fix

Run only one type of linter using the linter Descriptor:

npx mega-linter-runner -e "'ENABLE=MARKDOWN'"

Run only one linter using the linter Key:

npx mega-linter-runner -e "'ENABLE_LINTERS=JSON_PRETTIER'"

Contributing

We welcome contributions from the community!

How can you contribute?

• Add new examples.
• Bug reports and feature requests.
• Code contributions. You can start by looking at the issues labeled "good first issues".

Links

• In the Torrust Demo Repository, we are tracking issues with the Index Live Demo which uses the droplet configuration in this repo.