You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
__Torrust Index__, is a library for [BitTorrent][bittorrent] Files. Written in [Rust Language][rust] with the [axum] web framework. ___This index aims to be respectful to established standards, (both [formal][BEP 00] and [otherwise][torrent_source_felid]).___
5
+
__Torrust Index__ is a library for [BitTorrent][bittorrent] Files. Written in [Rust Language][rust] with the [Axum] web framework. ___This index aims to be respectful to established standards, (both [formal][BEP 00] and [otherwise][torrent_source_felid]).___
6
6
7
7
> This is a [Torrust][torrust] project and is in active development. It is community supported as well as sponsored by [Nautilus Cyberneering][nautilus].
8
8
9
9
## About
10
-
The core purpose of a [BitTorrent][bittorrent] Index is to maintain a database that connects torrent files with useful metadata. Allowing a community of users to keep track their torrents in a well organized and informative manner.
11
10
12
-
The __Torrust Index__ serves a [high-level api][api] for our [Torrust Index GUI][gui] client. It also connects to the [management api][api_tracker] of our [Torrust Tracker][tracker], to provide statistic and whitelisting functionally.
11
+
The core purpose of a [BitTorrent][bittorrent] Index is to maintain a database that connects torrent files with useful metadata. Allowing a community of users to keep track of their torrents in a well-organized and informative manner.
12
+
13
+
The __Torrust Index__ serves as a [high-level API][API] for our [Torrust Index GUI][gui] client. It also connects to the [management api][api_tracker] of our [Torrust Tracker][tracker], to provide statistics and whitelisting functionally.
13
14
14
15

15
16
16
17
## Key Features
17
-
**
18
+
18
19
-[x] High Quality and Modern Rust Codebase.
19
20
-[x][Documentation][docs] Generated from Code Comments.
20
21
-[x][Comprehensive Suit][coverage] of Unit and Functional Tests.
@@ -25,30 +26,33 @@ The __Torrust Index__ serves a [high-level api][api] for our [Torrust Index GUI]
25
26
## Getting Started
26
27
27
28
### Upgrading
29
+
28
30
If you are using `Version 1` of `torrust-tracker-backend`, please view our [upgrading guide][upgrade.md].
29
31
30
32
### Container Version
31
33
32
34
The Torrust Index is [deployed to DockerHub][dockerhub], you can run a demo immediately with the following commands:
33
35
34
-
#### Docker:
36
+
#### Docker
35
37
36
38
```sh
37
39
docker run -it torrust/index:develop
38
40
```
41
+
39
42
> Please read our [container guide][containers.md] for more information.
40
43
41
-
#### Podman:
44
+
#### Podman
42
45
43
46
```sh
44
47
podman run -it torrust/index:develop
45
48
```
49
+
46
50
> Please read our [container guide][containers.md] for more information.
47
51
48
52
### Development Version
49
53
50
-
- Please assure you have the ___[latest stable (or nightly) version of rust][rust]___.
51
-
- Please assure that you computer has enough ram. ___Recommended 16GB.___
54
+
- Please assure you have the ___[latest stable (or nightly) version of Rust][Rust]___.
55
+
- Please assure that your computer has enough RAM. ___Recommended 16GB.___
> Please view our [crate documentation][docs] for more detailed instructions.
102
107
103
108
### Services
109
+
104
110
The following services are provided by the default configuration:
105
111
106
112
- API
@@ -111,14 +117,15 @@ The following services are provided by the default configuration:
111
117
-[API (Version 1)][api]
112
118
113
119
## Contributing
120
+
114
121
We are happy to support and welcome new people to our project. Please consider our [contributor guide][guide.md].</br>
115
-
This is an open-source communitysupported project. We welcome contributions from the community!
122
+
This is an open-source community-supported project. We welcome contributions from the community!
116
123
117
124
__How can you contribute?__
118
125
119
126
- Bug reports and feature requests.
120
127
- Code contributions. You can start by looking at the issues labeled "[good first issues]".
121
-
- Documentation improvements. Check the [documentation][docs] and [API documentation][api] for typos, errors, or missing information.
128
+
- Documentation improvements. Check the [documentation][docs] and [API documentation][API] for typos, errors, or missing information.
122
129
- Participation in the community. You can help by answering questions in the [discussions].
123
130
124
131
## License
@@ -138,11 +145,13 @@ Some files include explicit copyright notices and/or license notices.
138
145
For prosperity, versions of Torrust Tracker that are older than five years are automatically granted the [MIT-0][MIT_0] license in addition to the existing [AGPL-3.0-only][AGPL_3_0] license.
139
146
140
147
## Contributor Agreement
148
+
141
149
The copyright of the Torrust Tracker is retained by the respective authors.
142
150
143
-
**Contributors agree:**
144
-
- That all their contributions be granted a license(s) **compatible** with the [Torrust Trackers License](#License).
145
-
- That all contributors signal **clearly** and **explicitly** any other compilable licenses if they are not: *[AGPL-3.0-only with the legacy MIT-0 exception](#License)*.
151
+
**Contributors agree that:**
152
+
153
+
- All their contributions be granted a license(s) __compatible__ with the [Torrust Trackers License](#license).
154
+
- All contributors signal __clearly__ and __explicitly__ any other compilable licenses if they are not: __[AGPL-3.0-only with the legacy MIT-0 exception](#license)__.
146
155
147
156
**The Torrust-Tracker project has no copyright assignment agreement.**
148
157
@@ -152,8 +161,6 @@ _We kindly ask you to take time and consider The Torrust Project [Contributor Ag
152
161
153
162
This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [Dutch Bits].
0 commit comments