From 3cfcc86e261227d1bbbc189b9cfb42ba371e6524 Mon Sep 17 00:00:00 2001 From: Andrei Andreev Date: Mon, 3 Jun 2024 11:42:35 +0200 Subject: [PATCH] Add README for Tribler config 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. --- src/tribler/core/config/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 src/tribler/core/config/README.md diff --git a/src/tribler/core/config/README.md b/src/tribler/core/config/README.md new file mode 100644 index 00000000000..25ce287fe04 --- /dev/null +++ b/src/tribler/core/config/README.md @@ -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//triblerd.conf` +* Windows: `%Appdata%\.Tribler\\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 +``` \ No newline at end of file