Configuration overhaul: version 2 for the configuration toml file (breaking changes)

[josecelano]

Parent issue: #586
Relates to: torrust/torrust-tracker#878
Updated on: 2024-06-02 (added more changes)

There are two groups of changes. Changes in the 2024-05 group have already been implemented and merged.

Changes (2024-07)

After a discussion, we decided to make more changes:

• Config overhaul: rename config option verified to verification_required #674
• Config overhaul: use an explicit section for metadata #672
• Config overhaul: make some fields mandatory #673

Changes (2024-06)

After a discussion, we decided to make more changes:

• Configuration overhaul: add version to the configuration #651
• Configuration overhaul: print the final configuration to console #657
• Configuration overhaul: rename log_level to threshold #652
• Configuration overhaul: split TrackerModeinto two flags private and listed #655
• Configuration overhaul: make mail-related configuration clearer #654

Some are pending confirmation/feedback:

• Configuration overhaul: rename auth::secret_key to auth::user_claim_token_pepper #653

Old toml version (before 2024-06 changes)

[logging]
log_level = "info"

[tracker]
mode = "public"

[auth]
email_on_signup = "optional"
secret_key = "MaxVerstappenWC2021"

[mail]
email_verification_enabled = false
from = "example@email.com"
reply_to = "noreply@email.com"

NOTE: omitted non-changed fields.

New toml version (after 2024-06 changes)

version = "2"

[logging]
threshold = "info"

[tracker]
private = false
listed = false

[auth]
password_database_pepper = "MaxVerstappenWC2021"

[registration]
# Other future options related to registration in addition to mail.
# All options related to mail go into the mail subtype.

  [registration.mail]
  required = true
  verification_required = true

[mail]
from = "example@email.com"
reply_to = "noreply@email.com"

NOTE: omitted non-changed fields.

Changes (2024-05)

1. Use TrackerMode from torrust-tracker-primitives crate.

Enum variants (Index -> Tracker):

• Public -> Public
• Private -> Private
• Whitelisted -> Listed
• PrivateWhitelisted -> PrivateListed

Enum serialized values (Index -> Tracker):

• Public -> public
• Private -> private
• Whitelisted -> listed
• PrivateWhitelisted -> private_listed

We have to use the Tracker version (enum variant -> serialized value):

• Public -> public
• Private -> private
• Listed -> listed
• PrivateListed -> private_listed

2. Include log_level in a new section [loggging].

Old toml version (before 2024-05 changes)

log_level = "info"

[website]
name = "Torrust"

[tracker]
api_url = "http://localhost:1212"
mode = "Public"
token = "MyAccessToken"
token_valid_seconds = 7257600
url = "udp://localhost:6969"

[net]
port = 3001

# Uncomment if you want to enable TSL for development
#[net.tsl]
#ssl_cert_path = "./storage/index/lib/tls/localhost.crt"
#ssl_key_path = "./storage/index/lib/tls/localhost.key"

[auth]
email_on_signup = "Optional"
max_password_length = 64
min_password_length = 6
secret_key = "MaxVerstappenWC2021"

[database]
connect_url = "sqlite://data.db?mode=rwc"

[mail]
email_verification_enabled = false
from = "example@email.com"
password = ""
port = 25
reply_to = "noreply@email.com"
server = ""
username = ""

[image_cache]
capacity = 128000000
entry_size_limit = 4000000
max_request_timeout_ms = 1000
user_quota_bytes = 64000000
user_quota_period_seconds = 3600

[api]
default_torrent_page_size = 10
max_torrent_page_size = 30

[tracker_statistics_importer]
port = 3002
torrent_info_update_interval = 3600

New toml version (alfter 2024-05 changes)

[logging]
log_level = "info"

[website]
name = "Torrust"

[tracker]
api_url = "http://localhost:1212"
mode = "public"
token = "MyAccessToken"
token_valid_seconds = 7257600
url = "udp://localhost:6969"

[net]
base_url = "http://localhost"
bind_address = "0.0.0.0:3001"

# Uncomment if you want to enable TSL for development
#[net.tsl]
#ssl_cert_path = "./storage/index/lib/tls/localhost.crt"
#ssl_key_path = "./storage/index/lib/tls/localhost.key"

[auth]
email_on_signup = "Optional"
secret_key = "MaxVerstappenWC2021"

[auth.password_constraints]
max_password_length = 64
min_password_length = 6

[database]
connect_url = "sqlite://data.db?mode=rwc"

[mail]
email_verification_enabled = false
from = "example@email.com"
reply_to = "noreply@email.com"

[mail.smtp]
port = 25
server = ""

[mail.smtp.credentials]
password = ""
username = ""

[image_cache]
capacity = 128000000
entry_size_limit = 4000000
max_request_timeout_ms = 1000
user_quota_bytes = 64000000
user_quota_period_seconds = 3600

[api]
default_torrent_page_size = 10
max_torrent_page_size = 30

[tracker_statistics_importer]
port = 3002
torrent_info_update_interval = 3600

Notice:

• The new value mode = "public" instead of mode = "Public".
• The [net] bind_address

cc @da2ce7

[josecelano]

Should we serialize all enums in lowercase? @da2ce7 . For example: email_on_signup.

[josecelano]

The conenct_url field in [database] section is actually defined in the sqlx crate

• Sqlite: sqlite://data.db?mode=rwc.
• Mysql: mysql://root:root_secret_password@mysql:3306/torrust_index_e2e_testing.
• PostgreSQL: postgres://postgres:password@localhost/database

It's a URL. We should decide if we want to stick to that representation. I think URL is a generic and standard enough format. So it's not a problem to be coupled to that format.

[josecelano]

Another question @da2ce7 is: should the default configuration be the development configuration?

pub const DEFAULT_PATH_CONFIG: &str = "./share/default/config/index.development.sqlite3.toml";

./share/default/config/index.development.sqlite3.toml:

log_level = "info"

Default values:

[website]
name = "Torrust"

[tracker]
url = "udp://localhost:6969"
mode = "Public"
api_url = "http://localhost:1212/"
token = "MyAccessToken"
token_valid_seconds = 7257600

[net]
port = 3001

[auth]
email_on_signup = "Optional"
min_password_length = 6
max_password_length = 64
secret_key = "MaxVerstappenWC2021"

[database]
connect_url = "sqlite://data.db?mode=rwc"

[mail]
email_verification_enabled = false
from = "example@email.com"
reply_to = "noreply@email.com"
username = ""
password = ""
server = ""
port = 25

[image_cache]
max_request_timeout_ms = 1000
capacity = 128000000
entry_size_limit = 4000000
user_quota_period_seconds = 3600
user_quota_bytes = 64000000

[api]
default_torrent_page_size = 10
max_torrent_page_size = 30

[tracker_statistics_importer]
torrent_info_update_interval = 3600
port = 3002

I think it makes more sense if the default configuration is the production default configuration. That leads to another question: What should be the default production configuration? I think It could be the same. Maybe we just need to remove the ./share/default/config/index.development.sqlite3.toml file and just use the default config when the user doesn't provide a config file path.

[josecelano]

I've also starting using this struct:

struct PasswordConstraints {
    pub min_password_length: usize,
    pub max_password_length: usize,
}

For the auth section in the toml file:

[auth]
email_on_signup = "Optional"
min_password_length = 6
max_password_length = 64
secret_key = "MaxVerstappenWC2021"

So maybe we could change it to:

[auth]
email_on_signup = "Optional"
secret_key = "MaxVerstappenWC2021"

[auth.password_constraints]
min_password_length = 6
max_password_length = 64