From e103adc944b7f1d5ac2190846f5b87bf0542537f Mon Sep 17 00:00:00 2001
From: Marcel <110860055+Morethanevil@users.noreply.github.com>
Date: Tue, 26 Sep 2023 10:03:46 +0200
Subject: [PATCH] Created Startupparameters for Zoraxy (markdown)

---
 Startupparameters-for-Zoraxy.md | 36 +++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Startupparameters-for-Zoraxy.md

diff --git a/Startupparameters-for-Zoraxy.md b/Startupparameters-for-Zoraxy.md
new file mode 100644
index 0000000..c3d7500
--- /dev/null
+++ b/Startupparameters-for-Zoraxy.md
@@ -0,0 +1,36 @@
+# An overview of possible startupparameters for Zoraxy
+
+Defaults are always loaded if nothing is set! You only need to use additional parameters if you want to change values (except port)
+
+### Usage: 
+
+Just add additional parameters as wish to the zoraxy start command.
+
+Example:
+
+`sudo ./zoraxy -port=:8000 -fastgeoip=true -webroot=/my/awesome/website`
+
+This can be used in the systemd-file as well!
+
+
+## port (obligatory)
+
+Needed for startup, sets the default port for the webinterface, default to `:8000`. To set another port use `-port=:8080` for example
+
+## webroot
+
+Sets the webroot directory for the static webserver introduced in v2.6.7, default to `./www/html/` - [More info](https://github.com/tobychui/zoraxy/releases/tag/2.6.7)
+
+##  fastgeoip (true / false)
+
+Allows to use more RAM for faster GEO-IP-Localation, default to `false` to save RAM, to enable use `-fastgeoip=true`
+
+## noauth (true / false)
+
+If you want to use an additional authmanager in front of Zoraxy, you can enable this with `-noauth=true`. 
+
+USE CAREFULLY, this can be a security risk if the authmanager is not setup properly!
+
+## sshlb (true / false)
+
+Allows loopback connecting for ssh via webinterface. If you want to connect from the webinterface via ssh to the host, you need to enable this with `-sshlb=true`, defaults to `false`
\ No newline at end of file