Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README for Tribler config #8047

Merged
merged 1 commit into from
Jun 4, 2024
Merged

Add README for Tribler config #8047

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions src/tribler/core/config/README.md
View file
Open in desktop
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
```
Loading