From 5fcdddde03b729bc3510bd0b1f8f76a5a6ce6e83 Mon Sep 17 00:00:00 2001 From: Neshura Date: Mon, 8 Apr 2024 23:20:42 +0200 Subject: [PATCH] Updated Readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2313251..8417635 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # DomainLink -Lightweight tool for handling (sub-)domain to URL redirects instead of having to deal with copy and pasting proxy rules. \ No newline at end of file +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/config.toml`. +Redirects are configured in an array, below is an example config. +```toml +[[domain_configs]] +domains = ["sub.domain.tld", "sub2.domain.tld"] +target = "sub.domain.tld/query" +``` +By default, DomainLink does not create any redirect rules, you will have to create these yourself. +Support for `/root/.config/domainlink/redirects` may come in the future. \ No newline at end of file