Update installation docs #821
Conversation
We updated the installation part of lib.rs and changed some other small bugs in the Configuration part.
Update on the fmt charge
We update the library with new data
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #821 +/- ##
===========================================
+ Coverage 78.91% 78.93% +0.02%
===========================================
Files 163 163
Lines 9186 9196 +10
===========================================
+ Hits 7249 7259 +10
Misses 1937 1937 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Hi @ivan9989-pkj there are some things that have to be fixed.
| //! In order to run the tracker you need to provide the configuration. If you run the tracker without providing the configuration, | ||
| //! the tracker will generate the default configuration the first time you run it. It will generate a `tracker.toml` file with | ||
| //! the tracker will generate the default configuration the first time you run it. It will generate a `Cargo.toml` file with | ||
| //! in the root directory. |
There was a problem hiding this comment.
Hi @ivan9989-pkj, this is not true anymore. Now, the tracker uses the default config file ./share/default/config/tracker.development.sqlite3.toml.
You can use any name for the config file, but we usually use this name tracker.toml or config.toml but never Cargo.toml. That's the Rust crate config file.
| @@ -191,18 +208,18 @@ | |||
| //! | |||
| //! For more information about each service and options you can visit the documentation for the [torrust-tracker-configuration crate](https://docs.rs/torrust-tracker-configuration). | |||
| //! | |||
| //! Alternatively to the `tracker.toml` file you can use one environment variable `TORRUST_TRACKER_CONFIG` to pass the configuration to the tracker: | |||
| //! Alternatively to the `Cargo.toml` file you can use one environment variable `TORRUST_TRACKER_CONFIG` to pass the configuration to the tracker: | |||
There was a problem hiding this comment.
Change Cargo.toml to tracker.toml.
| //! | ||
| //! ```text | ||
| //! TORRUST_TRACKER_CONFIG=$(cat tracker.toml) | ||
| //! TORRUST_TRACKER_CONFIG=$(cat Cargo.toml) |
There was a problem hiding this comment.
Change Cargo.toml to tracker.toml.
| //! cargo run | ||
| //! ``` | ||
| //! | ||
| //! In the previous example you are just setting the env var with the contents of the `tracker.toml` file. | ||
| //! In the previous example you are just setting the env var with the contents of the `Cargo.toml` file. |
There was a problem hiding this comment.
Change Cargo.toml to tracker.toml.
| //! | ||
| //! The env var contains the same data as the `tracker.toml`. It's particularly useful in you are [running the tracker with docker](https://github.com/torrust/torrust-tracker/tree/develop/docker). | ||
| //! The env var contains the same data as the `Cargo.toml`. It's particularly useful in you are [running the tracker with docker](https://github.com/torrust/torrust-tracker/tree/develop/docker). |
There was a problem hiding this comment.
Change Cargo.toml to tracker.toml.
| //! | ||
| //! > NOTE: The `TORRUST_TRACKER_CONFIG` env var has priority over the `tracker.toml` file. | ||
| //! > NOTE: The `TORRUST_TRACKER_CONFIG` env var has priority over the `Cargo.toml` file. |
There was a problem hiding this comment.
Change Cargo.toml to tracker.toml.
| //! ```text | ||
| //! mkdir torrust | ||
| //! cd torrust/ | ||
| //! ``` |
There was a problem hiding this comment.
I would remove the indentation.
mkdir torrust
cd torrust
| @@ -121,11 +121,19 @@ | |||
| //! | |||
| //! By default the tracker uses `SQLite` and the database file name `data.db`. | |||
| //! | |||
| //! We will have to have a file to save the torrust-tracker, which we will call "torrust". | |||
There was a problem hiding this comment.
"We need a folder to clone the repository".
Folder not file.
|
Hi @ivan9989-pkj I've resolved these issues in a new PR. |
Update installation docs.