Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
664 changes: 657 additions & 7 deletions COPYRIGHT

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ documentation.workspace = true
edition.workspace = true
homepage.workspace = true
keywords.workspace = true
license-file.workspace = true
license.workspace = true
publish.workspace = true
repository.workspace = true
rust-version.workspace = true
Expand All @@ -22,7 +22,7 @@ documentation = "https://docs.rs/crate/torrust-tracker/"
edition = "2021"
homepage = "https://torrust.com/"
keywords = ["bittorrent", "file-sharing", "peer-to-peer", "torrent", "tracker"]
license-file = "COPYRIGHT"
license = "AGPL-3.0-only"
publish = true
repository = "https://github.com/torrust/torrust-tracker"
rust-version = "1.72"
Expand Down
38 changes: 31 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ __Torrust Tracker__, is a [BitTorrent][bittorrent] Tracker (a service that match
- [BEP 27] : Private Torrents.
- [BEP 48] : Tracker Protocol Extension: Scrape.


## Getting Started

### Container Version
Expand Down Expand Up @@ -120,7 +119,6 @@ The following services are provided by the default configuration:
- API _(management)_
- `http://127.0.0.1:1212/api/v1/stats?token=MyAccessToken`.


## Documentation

- [Management API (Version 1)][api]
Expand All @@ -141,7 +139,29 @@ __How can you contribute?__

## License

The project is licensed under a dual license. See [COPYRIGHT].
**Copyright (c) 2023 The Torrust Developers.**

This program is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License][AGPL_3_0] as published by the [Free Software Foundation][FSF], 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][AGPL_3_0] for more details.

You should have received a copy of the *GNU Affero General Public License* along with this program. If not, see <https://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][MIT_0] license in addition to the existing [AGPL-3.0-only][AGPL_3_0] license.

## Contributions

The copyright of the Torrust Tracker is retained by the respective authors.

**Contributors agree:**
- That all their contributions be granted a license(s) **compatible** with the [Torrust Trackers License](#License).
- 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)*.

**The Torrust-Tracker project has no copyright assignment agreement.**

## Acknowledgments

Expand Down Expand Up @@ -179,16 +199,20 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D

[containers.md]: ./docs/containers.md

[api]: https://docs.rs/torrust-tracker/3.0.0-alpha.12-develop/torrust_tracker/servers/apis/v1
[http]: https://docs.rs/torrust-tracker/3.0.0-alpha.12-develop/torrust_tracker/servers/http
[udp]: https://docs.rs/torrust-tracker/3.0.0-alpha.12-develop/torrust_tracker/servers/udp
[api]: https://docs.rs/torrust-tracker/latest/torrust_tracker/servers/apis/v1
[http]: https://docs.rs/torrust-tracker/latest/torrust_tracker/servers/http
[udp]: https://docs.rs/torrust-tracker/latest/torrust_tracker/servers/udp

[good first issues]: https://github.com/torrust/torrust-tracker/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[documentation]: https://docs.rs/torrust-tracker/
[API documentation]: https://docs.rs/torrust-tracker/3.0.0-alpha.12-develop/torrust_tracker/servers/apis/v1
[API documentation]: https://docs.rs/torrust-tracker/latest/torrust_tracker/servers/apis/v1
[discussions]: https://github.com/torrust/torrust-tracker/discussions

[COPYRIGHT]: ./COPYRIGHT
[AGPL_3_0]: ./docs/licenses/LICENSE-AGPL_3_0
[MIT_0]: ./docs/licenses/LICENSE-MIT_0
[FSF]: https://www.fsf.org/


[nautilus]: https://github.com/orgs/Nautilus-Cyberneering/
[Dutch Bits]: https://dutchbits.nl
Expand Down
File renamed without changes.
File renamed without changes.
20 changes: 18 additions & 2 deletions docs/release_process.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Torrust Tracker Release Process (v2.2.1)
# Torrust Tracker Release Process (v2.2.2)

## Version:
> **The `[semantic version]` is bumped according to releases, new features, and breaking changes.**
Expand All @@ -7,6 +7,20 @@

## Process:

**Note**: this guide assumes that the your git `torrust` remote is like this:

```sh
git remote show torrust
```

```s
* remote torrust
Fetch URL: git@github.com:torrust/torrust-tracker.git
Push URL: git@github.com:torrust/torrust-tracker.git
...
```


### 1. The `develop` branch is ready for a release.
The `develop` branch should have the version `[semantic version]-develop` that is ready to be released.

Expand All @@ -22,6 +36,7 @@ git push --force torrust develop:staging/main
```sh
git stash
git switch staging/main
git reset --hard torrust/staging/main
# change `[semantic version]-develop` to `[semantic version]`.
git add -A
git commit -m "release: version [semantic version]"
Expand Down Expand Up @@ -65,7 +80,8 @@ git push --force torrust main:staging/develop

```sh
git stash
git switch staging/main
git switch staging/develop
git reset --hard torrust/staging/develop
# change `[semantic version]` to `(next)[semantic version]-develop`.
git add -A
git commit -m "develop: bump to version (next)[semantic version]-develop"
Expand Down
2 changes: 1 addition & 1 deletion packages/configuration/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors.workspace = true
documentation.workspace = true
edition.workspace = true
homepage.workspace = true
license-file.workspace = true
license.workspace = true
publish.workspace = true
repository.workspace = true
rust-version.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion packages/located-error/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors.workspace = true
documentation.workspace = true
edition.workspace = true
homepage.workspace = true
license-file.workspace = true
license.workspace = true
publish.workspace = true
repository.workspace = true
rust-version.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion packages/primitives/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors.workspace = true
documentation.workspace = true
edition.workspace = true
homepage.workspace = true
license-file.workspace = true
license.workspace = true
publish.workspace = true
repository.workspace = true
rust-version.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion packages/test-helpers/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors.workspace = true
documentation.workspace = true
edition.workspace = true
homepage.workspace = true
license-file.workspace = true
license.workspace = true
publish.workspace = true
repository.workspace = true
rust-version.workspace = true
Expand Down