From 1bab3747d4dfe65043b8f72bdd41f3b04e5e6d20 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Wed, 18 May 2022 17:33:57 +0200 Subject: [PATCH] update docs --- "docs/10_\360\237\223\221_Features.md" | 1 + "docs/20_\342\226\266\357\270\217_Installation.md" | 2 +- "docs/30_\342\232\231\357\270\217_Configuration.md" | 12 ++++++++++-- readme.md | 6 +++--- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git "a/docs/10_\360\237\223\221_Features.md" "b/docs/10_\360\237\223\221_Features.md" index 57c07ba..2a3466a 100644 --- "a/docs/10_\360\237\223\221_Features.md" +++ "b/docs/10_\360\237\223\221_Features.md" @@ -5,3 +5,4 @@ * aliases can be defined to handle same redirects * optional debugging (will be written into http reponse header) * admin to list and filter all existing domains and redirects +* debug processing diff --git "a/docs/20_\342\226\266\357\270\217_Installation.md" "b/docs/20_\342\226\266\357\270\217_Installation.md" index a274efa..8b22780 100644 --- "a/docs/20_\342\226\266\357\270\217_Installation.md" +++ "b/docs/20_\342\226\266\357\270\217_Installation.md" @@ -26,7 +26,7 @@ to the public_html directory. The config folder is outside the webroot. ## Redirect all requests to index.php ## Redirect all requests to the index.php. Activate the .htaccess or (better) -add the config of the htaccess file to the vhost config. +add the config to the vhost config. ```text RewriteEngine On diff --git "a/docs/30_\342\232\231\357\270\217_Configuration.md" "b/docs/30_\342\232\231\357\270\217_Configuration.md" index 0897a78..210eab0 100644 --- "a/docs/30_\342\232\231\357\270\217_Configuration.md" +++ "b/docs/30_\342\232\231\357\270\217_Configuration.md" @@ -3,8 +3,16 @@ In the *./config/* folder are json files. Copy the dist files to the same filename without ".dist" -* redirects_[FQDN].json -* aliases.json +* redirects_[FQDN].json - +* aliases.json - + +You can create multipe redirect files `redirects_[FQDN].json`. We suggest to use the main domain as FQDN. +If you have multiple domains that should use exactly the same redirects then use the `aliases.json`. + +Other requirements: + +* In the DNS you must point each domain to the redirect website. +* In the apache web with multiple vhosts: add the need a server alias to process the hostname in the wanted vhost ## Redirects ## diff --git a/readme.md b/readme.md index d59789d..71ad0b2 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,6 @@ Redirect urls of any domain that points here. Author: Axel Hahn; Institute for Medical Education; University of Bern -License: GNUP GPL 3.0 - -See the [docs](./docs) +📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/redirect-handler> \ +📜 License: GNU GPL 3.0 \ +📖 Docs: <https://os-docs.iml.unibe.ch/redirect-handler/> or see the [docs](./docs) -- GitLab