domainlink/README.md
Neshura add30dcfdd
All checks were successful
Run Tests on Code / run-tests (push) Successful in 13s
Updated Readme
2024-04-10 23:28:23 +02:00

1,023 B

DomainLink

Lightweight tool for handling (sub-)domain to URL redirects instead of having to deal with copy and pasting proxy rules.

System Configuration

The package provides a default configuration in /usr/share/local/domainlink/config.toml. Modifying this is not recommended as updates may override any changes, instead make a copy at /etc/domainlink/config.toml. Any changes there will persist updates and supersede the default config. The System Config only contains the settings for listen addresses and ports.

User Configuration

DomainLink currently expects redirect files to be placed in any home directory, specifically /home/{user}/.config/domainlink/domains.toml or /root/.config/domainlink/domains.toml. Redirects are configured in an array, below is an example config.

[[domain_configs]]
domains = ["sub.domain.tld", "sub2.domain.tld"]
target = "https://sub.domain.tld/query"

By default, DomainLink does not create any redirect rules, you will have to create these yourself.