Skip to content

Commit

Permalink
Add README for Tribler config
Browse files Browse the repository at this point in the history
Introduced a README file to provide guidance on how to configure the Tribler instance. The document includes information about the location of the configuration files across different operating systems, structure of the configuration file, and an example on how to modify settings within it.
  • Loading branch information
drew2a committed Jun 4, 2024
1 parent 308f3c9 commit 3cfcc86
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions src/tribler/core/config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Tribler config is intended to configure the Tribler instance on both users' machines and developers' machines.

The config can be found at the following locations:
* macOS/Ubuntu: `~/.Tribler/<tribler_version>/triblerd.conf`
* Windows: `%Appdata%\.Tribler\<tribler_version>\triblerd.conf`

The structure of the `triblerd.conf` follows the structure of an [INI file](https://en.wikipedia.org/wiki/INI_file).

The list of sections can be found here: [Tribler Config Sections](https://github.com/Tribler/tribler/blob/main/src/tribler/core/config/tribler_config.py#L40-L55). The settings themselves can be found in the corresponding Settings class.

### Example

For example, general settings are located in the `GeneralSettings` class and can be found here: [GeneralSettings Class](https://github.com/Tribler/tribler/blob/main/src/tribler/core/settings.py#L6-L10).

If we want to change the `version_checker_enabled` value in `GeneralSettings`, we should add the following lines to `triblerd.conf`:

```ini
[general]
version_checker_enabled = True
```

0 comments on commit 3cfcc86

Please sign in to comment.