- We have made the installation of the Index as easy and enjoyable as possible. First at all, - offering different ways to run it. You can - compile from sources - or use the - pre-built container images. We have - also taken into consideration cloud environments, making it easy to deploy the index to - multiple hosting providers (using either VMs or containers). -
- -- We have also taken into consideration cloud environments, making it easy to deploy the index - to multiple hosting providers (using either VMs or containers). We run a demo site - on Digital Ocean to collect direct feedback about how easy it is to manage the application on production. - Our goal is to make sure sysadmins can: -
- -- Besides that, the application also provides two ways to inject the configuration, via TOML - files or environment variables. We've make an extra effort to make it clear, easy to change - and provide the admin concise error messages when is wrong. -
- -- Check the latest documentation - for more details about installation and requirements. -
- -You can easily build the Rust app with cargo.
- -
+
+ Installation
+
+
+ We have made the installation of the Index as easy and enjoyable as possible. First at all,
+ offering different ways to run it. You can
+ compile from sources
+ or use the
+ pre-built container images. We
+ have also taken into consideration cloud environments, making it easy to deploy the index to
+ multiple hosting providers (using either VMs or containers).
+
+
+
+ We have also taken into consideration cloud environments, making it easy to deploy the index
+ to multiple hosting providers (using either VMs or containers). We run a demo site
+ on Digital Ocean to collect direct feedback about how easy it is to manage the application on
+ production. Our goal is to make sure sysadmins can:
+
+
+
+ - Easily backup the database or app configuration.
+ - Collect logs to check if the application is running without errors.
+ - Access the running services.
+ - Monitor services with automatic healthchecks.
+
+
+
+ Besides that, the application also provides two ways to inject the configuration, via TOML
+ files or environment variables. We've make an extra effort to make it clear, easy to change
+ and provide the admin concise error messages when is wrong.
+
+
+ Software requirements
+
+
+ - SQLite 3 or MySQL 8.0.
+ - Rust Stable 1.68 if you compile from sources.
+ -
+ A running Torrust Tracker. You can check the Tracker page for
+ installation instructions.
+
+
+
+
+ Check the latest documentation
+ for more details about installation and requirements.
+
+
+ Build from sources
+
+ You can easily build the Rust app with cargo.
+
+
+
git clone git@github.com:torrust/torrust-index.git \
&& cd torrust-index && cargo build --release \
&& mkdir -p ./storage/database
+ >
+
- Then you can run it with:
+ Then you can run it with:
- ./target/release/torrust-index
+ ./target/release/torrust-index
- Run with docker
+ Run with docker
-
- You can use docker or
- podman
- to run the containerized application:
-
+
+ You can use docker or
+ podman
+ to run the containerized application:
+
-
-
+
+
cd /tmp \
&& mkdir torrust-index \
&& cd torrust-index \
@@ -103,143 +103,158 @@ cd /tmp \
--volume "$(pwd)/storage/index/etc":"/etc/torrust/index" \
torrust/index:develop
-
- Please refer to the [official
- documentation](https://docs.rs/torrust-index/3.0.0-rc.1/torrust_index/#run-with-docker) to learn
- more about running the index with docker.
-
- Roadmap
-
-
- Torrust vision is to provide a good set of tools for the BitTorrent ecosystem. We know that
- this take a big effort and a long time. That's why we plan for the future. This is a summary
- of all things we are planning to implement.
-
-
-
- You can participate in defining the future of Torrust. Join our public discussions on GitHub.
-
-
-
-
- - Persistence
-
- - Support other databases
-
- - Integrations
-
- - Webhooks
-
- - Administration
-
- - Improve categories and tag management
- - User management: list, ban users
- - Full-private mode
- - User statistics
-
- - User management
-
- - Reset or change password
- - User profile
- - Invitation system
- - User moderation
- - Add torrent providing only infohash
- - Improve search: Import torrents documents and provide better search capabilities
-
- - Torrents
-
- - Customize "source" and "creator" torrent fields after uploading
- -
- Implement BEP 19:
- WebSeed - HTTP/FTP Seeding (GetRight style)
-
- -
- Implement BEP 32:
- BitTorrent DHT Extensions for IPv6
-
-
- - Others
+ >
+
+
+ Please refer to the [official
+ documentation](https://docs.rs/torrust-index/3.0.0-rc.1/torrust_index/#run-with-docker) to
+ learn more about running the index with docker.
+
+ Roadmap
+
+
+ Torrust vision is to provide a good set of tools for the BitTorrent ecosystem. We know that
+ this take a big effort and a long time. That's why we plan for the future. This is a summary
+ of all things we are planning to implement.
+
+
+
+ You can participate in defining the future of Torrust. Join our public discussions on GitHub.
+
+
+
- - Multi-tracker
- - Multi-language
+ - Persistence
+
+ - Support other databases
+
+ - Integrations
+
+ - Webhooks
+
+ - Administration
+
+ - Improve categories and tag management
+ - User management: list, ban users
+ - Full-private mode
+ - User statistics
+
+ - User management
+
+ - Reset or change password
+ - User profile
+ - Invitation system
+ - User moderation
+ - Add torrent providing only infohash
+ - Improve search: Import torrents documents and provide better search capabilities
+
+ - Torrents
+
+ - Customize "source" and "creator" torrent fields after uploading
+ -
+ Implement BEP 19:
+ WebSeed - HTTP/FTP Seeding (GetRight style)
+
+ -
+ Implement BEP 32:
+ BitTorrent DHT Extensions for IPv6
+
+
+ - Others
+
+ - Multi-tracker
+ - Multi-language
+
-
-
- License
-
- We want the software to be as useful and spread as possible.
-
-
-
- Copyright
-
-
- This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License
- as published by the Free Software Foundation, version 3.
-
-
-
- This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
- without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
- the GNU Affero General Public License for more details.
-
-
-
- You should have received a copy of the GNU Affero General Public License along with this
- program. If not, see www.gnu.org/licenses. Some files include explicit copyright notices and/or license notices.
-
-
-
-
- Legacy Exception
-
-
- For prosperity, versions of Torrust Tracker that are older than five years are automatically
- granted the MIT-0
- license in addition to the existing
- AGPL-3.0-only license.
-
+
+ License
+
+ We want the software to be as useful and spread as possible.
+
+
+
+ Copyright
+
+
+ This program is free software: you can redistribute it and/or modify it under the terms of
+ the GNU Affero General Public License
+ as published by the Free Software Foundation, version 3.
+
+
+
+ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU Affero General Public License for more details.
+
+
+
+ You should have received a copy of the GNU Affero General Public License along with this
+ program. If not, see www.gnu.org/licenses. Some files include explicit copyright notices and/or license notices.
+
+
+
+
+ Legacy Exception
+
+
+ For prosperity, versions of Torrust Tracker that are older than five years are automatically
+ granted the MIT-0
+ license in addition to the existing
+ AGPL-3.0-only license.
+
+
diff --git a/src/routes/(pages)/community/+page.svelte b/src/routes/(pages)/community/+page.svelte
index 8a4c3ba..bd69d61 100644
--- a/src/routes/(pages)/community/+page.svelte
+++ b/src/routes/(pages)/community/+page.svelte
@@ -4,222 +4,238 @@
- Why Contribute to our Project?
-
- At Torrust, we aim to build a decentralized and transparent ecosystem for BitTorrent
- technology. By contributing to our project, you're joining a passionate community of
- developers and users who value open-source software, innovation, and collaboration. Whether
- you're a Rust enthusiast, a BitTorrent advocate, or simply looking to improve your skills,
- your contributions will help shape the future of this project and the broader file-sharing
- infrastructure.
-
-
-
- - Modern development with Rust
- - Comprehensive and detailed documentation
- - Commitment to high-quality code
- - Extensive test coverage
- - Long-term project sustainability
- - Open to sponsorship opportunities
-
-
- Embrace Rust: a language of choice
-
-
- Why Rust? We’ve chosen Rust for its unmatched safety, performance, and reliability. If you
- share a passion for writing efficient, modern code, you’ll feel right at home here. Our
- project provides a great platform for Rust developers to innovate and push boundaries.
-
-
- Prioritizing Code Quality
-
-
- We hold ourselves to the highest coding standards. Every contribution undergoes a thorough
- review process to ensure robustness and maintainability. Rather than rushing new features, we
- focus on refining existing functionality to ensure long-term stability.
-
-
-
- With a rigorous suite of automated tests, we ensure that our software remains stable and
- regression-free. Your contributions will help maintain this legacy of quality.
-
-
- A welcoming community for newcomers
-
-
- We pride ourselves on being inclusive and supportive, especially for those new to open-source
- contributions. You’ll find a wealth of documentation, clear explanations of concepts, and a
- community ready to assist you as you get started.
-
-
-
- Whether you’re looking to improve your Rust skills, learn more about open-source development,
- or share your expertise, we’re here to help you grow.
-
-
- Influence the Project’s Future
-
-
- As an open-source project, your feedback, contributions, and ideas are crucial. Whether you're
- interested in improving our tracker or enhancing the index, you have the opportunity to
- directly shape the project’s roadmap.
-
-
-
- When you contribute, you become a key part of the Torrust community. Together, we’re building
- software that will leave a lasting impact.
-
-
- Join us today
-
-
- By contributing to our project, you're not just writing code; you're joining a movement
- dedicated to creating something truly outstanding with Rust. Together, we can build software
- that's not only powerful and efficient but also accessible and enjoyable for everyone in the
- open-source community.
-
-
- How to contribute?
-
-
- There are many ways to get involved with Torrust. Whether you're a seasoned developer or a
- newcomer, your contributions are welcome. Here are some ways you can contribute:
-
-
-
- - Submit bug reports
- - Request new features
- -
- Contribute to the code. Feel free to ask how if you don't find issues suitable for you
-
- - Review and improve documentation
- - Provide financial support through sponsorship
- - Engage in community discussions
-
-
- Torrent Knowledge Base
-
- What Are Torrents?
-
-
- A torrent is a small file that contains metadata about the files and folders to
- be shared and information about the network of computers that share these files. It's used with
- BitTorrent protocol, which enables fast and efficient distribution of large files over the internet
- by allowing users to connect directly to each other to download and upload portions of the file
- simultaneously. This decentralized method of sharing files reduces the load on any single server
- and can lead to faster download speeds for the users involved. Torrents themselves do not contain
- the actual content being shared, only the information needed to find and download the content from
- peers in the BitTorrent network.
-
-
- What Is a Tracker?
-
-
- A BitTorrent tracker is a server that facilitates communication between peers
- using the BitTorrent protocol. When you open a torrent file with a BitTorrent client, the tracker
- is contacted to help find other users who are sharing the same files. It does not store or distribute
- the content itself but keeps track of the IP addresses of the peers in the swarm (the group of
- computers involved in sharing a particular file). The tracker responds to requests from clients
- with a list of peers, allowing them to connect directly to each other to start downloading and
- uploading pieces of the file. Essentially, the tracker acts as a central hub that enables peers
- to find each other, significantly improving the efficiency and speed of file distribution.
-
-
- What Is a Torrent Index?
-
-
- A BitTorrent index site is a website that lists torrent files for download. These
- sites serve as search engines or directories for finding specific files or content within the BitTorrent
- network. Users can search for and download torrent files based on various categories such as movies,
- music, software, games, and more. Each torrent file listed on an index site contains metadata about
- the content it represents, such as the file name, size, and the address of the tracker managing
- the distribution of the content.
-
-
-
- BitTorrent index sites do not host the content files themselves; instead, they provide the
- torrent files which users can then open with their BitTorrent clients to download the actual
- content from other peers in the network. These sites play a crucial role in the BitTorrent
- ecosystem by making it easier for users to find and access content distributed via BitTorrent.
-
-
- List of projects using BitTorrent
-
-
- - WebTorrent:
-
- -
- https://webtorrent.io/faq
-
+
+ Why Contribute to our Project?
+
+ At Torrust, we aim to build a decentralized and transparent ecosystem for BitTorrent
+ technology. By contributing to our project, you're joining a passionate community of
+ developers and users who value open-source software, innovation, and collaboration. Whether
+ you're a Rust enthusiast, a BitTorrent advocate, or simply looking to improve your skills,
+ your contributions will help shape the future of this project and the broader file-sharing
+ infrastructure.
+
+
+
+ - Modern development with Rust
+ - Comprehensive and detailed documentation
+ - Commitment to high-quality code
+ - Extensive test coverage
+ - Long-term project sustainability
+ - Open to sponsorship opportunities
- - Others:
-
- -
- torrent-paradise
-
- -
- https://academictorrents.com/
-
+
+ Embrace Rust: a language of choice
+
+
+ Why Rust? We’ve chosen Rust for its unmatched safety, performance, and reliability. If you
+ share a passion for writing efficient, modern code, you’ll feel right at home here. Our
+ project provides a great platform for Rust developers to innovate and push boundaries.
+
+
+ Prioritizing Code Quality
+
+
+ We hold ourselves to the highest coding standards. Every contribution undergoes a thorough
+ review process to ensure robustness and maintainability. Rather than rushing new features,
+ we focus on refining existing functionality to ensure long-term stability.
+
+
+
+ With a rigorous suite of automated tests, we ensure that our software remains stable and
+ regression-free. Your contributions will help maintain this legacy of quality.
+
+
+ A welcoming community for newcomers
+
+
+ We pride ourselves on being inclusive and supportive, especially for those new to
+ open-source contributions. You’ll find a wealth of documentation, clear explanations of
+ concepts, and a community ready to assist you as you get started.
+
+
+
+ Whether you’re looking to improve your Rust skills, learn more about open-source
+ development, or share your expertise, we’re here to help you grow.
+
+
+ Influence the Project’s Future
+
+
+ As an open-source project, your feedback, contributions, and ideas are crucial. Whether
+ you're interested in improving our tracker or enhancing the index, you have the opportunity
+ to directly shape the project’s roadmap.
+
+
+
+ When you contribute, you become a key part of the Torrust community. Together, we’re
+ building software that will leave a lasting impact.
+
+
+ Join us today
+
+
+ By contributing to our project, you're not just writing code; you're joining a movement
+ dedicated to creating something truly outstanding with Rust. Together, we can build software
+ that's not only powerful and efficient but also accessible and enjoyable for everyone in the
+ open-source community.
+
+
+ How to contribute?
+
+
+ There are many ways to get involved with Torrust. Whether you're a seasoned developer or a
+ newcomer, your contributions are welcome. Here are some ways you can contribute:
+
+
+
+ - Submit bug reports
+ - Request new features
-
- https://github.com/bigscience-workshop/petals
+ Contribute to the code. Feel free to ask how if you don't find issues suitable for you
+ - Review and improve documentation
+ - Provide financial support through sponsorship
+ - Engage in community discussions
-
- Resources
+ Torrent Knowledge Base
+
+ What Are Torrents?
+
+
+ A torrent is a small file that contains metadata about the files and folders
+ to be shared and information about the network of computers that share these files. It's used
+ with BitTorrent protocol, which enables fast and efficient distribution of large files over the
+ internet by allowing users to connect directly to each other to download and upload portions
+ of the file simultaneously. This decentralized method of sharing files reduces the load on any
+ single server and can lead to faster download speeds for the users involved. Torrents themselves
+ do not contain the actual content being shared, only the information needed to find and download
+ the content from peers in the BitTorrent network.
+
+
+ What Is a Tracker?
+
+
+ A BitTorrent tracker is a server that facilitates communication between peers
+ using the BitTorrent protocol. When you open a torrent file with a BitTorrent client, the tracker
+ is contacted to help find other users who are sharing the same files. It does not store or distribute
+ the content itself but keeps track of the IP addresses of the peers in the swarm (the group of
+ computers involved in sharing a particular file). The tracker responds to requests from clients
+ with a list of peers, allowing them to connect directly to each other to start downloading and
+ uploading pieces of the file. Essentially, the tracker acts as a central hub that enables peers
+ to find each other, significantly improving the efficiency and speed of file distribution.
+
+
+ What Is a Torrent Index?
+
+
+ A BitTorrent index site is a website that lists torrent files for download.
+ These sites serve as search engines or directories for finding specific files or content within
+ the BitTorrent network. Users can search for and download torrent files based on various categories
+ such as movies, music, software, games, and more. Each torrent file listed on an index site contains
+ metadata about the content it represents, such as the file name, size, and the address of the
+ tracker managing the distribution of the content.
+
+
+
+ BitTorrent index sites do not host the content files themselves; instead, they provide the
+ torrent files which users can then open with their BitTorrent clients to download the actual
+ content from other peers in the network. These sites play a crucial role in the BitTorrent
+ ecosystem by making it easier for users to find and access content distributed via
+ BitTorrent.
+
+
+ List of projects using BitTorrent
-
- - Discussions
- -
- Tracker
-
- -
- Index
-
- -
- Index GUI
-
+ - WebTorrent:
+
+ -
+ https://webtorrent.io/faq
+
+
+ - Others:
+
- - Documentation
+
+ Resources
+
-
+