From d2bdbd319d023bc7a3a430d515ac9611b76e385f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikki=20S=C3=B8rensen?= Date: Mon, 12 Mar 2018 17:54:07 +0100 Subject: [PATCH] Updating readme with with latest information, examples and help, based on latest update in the php scipt --- scripts/readme.md | 46 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 42 insertions(+), 4 deletions(-) diff --git a/scripts/readme.md b/scripts/readme.md index c732039..e851e91 100644 --- a/scripts/readme.md +++ b/scripts/readme.md @@ -6,11 +6,49 @@ Run the index.php file using php folow the guide in the script. The CLI mode support to choose from categories or a single or more services at onces. -* Enter server ip -* Enter DNS server +####Running without arguments (running in terminal) +* Decide if you want to use different cache servers (using same cache server can result in a cache collision) + * Yes, is also default if enter is hit (you enter ip's for the cache based on the service you want to cache later in the script) + * No, you type a global ip adresse for the cache +* Enter DNS server type + * 1 = unbound + * More to come * Enter output mode and file + * Enter = default (makes config (file extension) based on dns server) + * 1 = default (makes config (file extension) based on dns server) + * 2 = txt (makes a txt file) + * 3 = echo (prints the output in the terimnal) * choose from categories or a single or more services at onces - * choose more categories or services by separating using space + * Choose more categories or services by separating using space + * Example "g u" (gives games and updates) + * Categories + * A = All dns records (note need spi proxy) + * G = Games + * GO = Games plus games that need spi proxy + * GOS = Only spi proxy games + * U = Updates + * O = Other + * Single services + * Based on the txt files + * Use there number example 1 for apple or just type apple it is up to you + * Seperate using space + +####Running with arguments +* The script takes 3 inputs + * DNS server + * unbound + * more to come + * File extension (just a string example "conf" or "txt") + * Services + * Use the names of the txt files (without ".txt") and the cache server ip + * Example "steam=192.168.1.1,uplay=192.168.1.2" + * All spaces is trimt so "steam = 192.168.1.1 , uplay = 192.168.1.2" is also okay +* Full example + * Linux + * php /path/to/file/cache-domains/scripts/index.php unbound conf "steam=192.168.1.1,uplay=192.168.1.2" + * Windows + * "C:\Program Files\PHP\v7.0\PHP.exe" C:\path\to\file\cache-domains\scripts\index.php unbound conf "steam=192.168.1.1,uplay=192.168.1.2" ###Web mode (hosting on webserver) -The web mode do not support what kind of servies you want all is exported by default. \ No newline at end of file +The web mode do not support what kind of servies you want, all is exported by default. +Functions is to come. \ No newline at end of file