diff --git a/README.md b/README.md index 0d32d7e..d1aa982 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Git based automatic web deployment system -This repository will be automagically pulled by the web server each time something is pushed by a user. The following files and directories are linked to areas where they can be accessed by the web server: +This repository will be automagically pulled by the web server each time something is pushed by a user. + +## Symlinks +The following files and directories are linked to areas where they can be accessed by the web server: * `index.html` → `*/common/index.html` (the website as seen by the majority of the users, maybe a login page?) * `icon.png` → `*/common/icon.png` (self-explanatory) * `stylesheet.css` → `*/common/stylesheet.css` (self-explanatory) @@ -10,8 +13,13 @@ This repository will be automagically pulled by the web server each time somethi * `commands_status.conf` → `strassenkind.ip/commands_status.conf` * `commands_ondemand.conf` → `strassenkind.ip/commands_ondemand.conf` -## Some server variables that might turn out to be useful: +## Variables handled by the deployment script +Here is the place for variables that will be replaced automatically on the server. Using them is encouraged. Using the paths is DISCOURAGED. +This way, it is possible to change folder names around and fix the URLs in one place for all files simultaneously. + * `%CONTENT_DIR%` → The part of the URL between the domain name and the destination (e.g. https://lostcave.ddnss.de**/common/content/**about/) + +## Some server variables that might turn out to be useful (example): { "HTTP_USER_AGENT":"Mozilla\/5.0 (X11; Ubuntu; Linux x86_64; rv:73.0) Gecko\/20100101 Firefox\/73.0", "REMOTE_ADDR":"10.1.1.3" -} \ No newline at end of file +}