diff --git a/README.md b/README.md index e484f56..c5b17dd 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,31 @@ This repository was forked from [GitHub](https://github.com/sergei-bondarenko/ml ## Description -A light PHP web interface for [mlmmj](http://mlmmj.org/). It does not use a database. Available in two languages: English and Russian. +A light PHP web interface for [mlmmj](http://mlmmj.org/). It does **not** use a database. Available in English only. + ## Installation -Change values in `misc/config.txt` -Navigate to directory `misc` -Untar the following two archives: +Change the values in `init.php` + +| Variable | Description | Default value | +| --- | --- | --- | +| `$lists_path` | Path to the parent directory where the folder named at `$domain_global` is located at | `/home/pacs/ecg00/users/mlmmj` | +| `$web_path` | Full path to the webinterface | `/home/pacs/ecg00/users/mlmmj/doms/list.ecogood.org/htdocs-ssl/mlmmj-light-web-ecg/` | +| `$web_url` | URL to the webinterface with leading https:// | `https://list.ecogood.org/` +| `$language` | As the original tool had two languages this is not relevant anymore. Currently the tool supports English only | `en` | +| `$domain_global` | Name of the folder within `$lists_path` where all mailing lists are stored | `mlmmj` | +| `$rc_webhook` | The Rocket:Chat webhook string to be able to send notifications regarding errors | | +| `$current_version` | No need to change this | depends on the current version | +| `$headline` | No need to change this | `Manage your ECG mailing lists " . $current_version` | +| `$debug` | Turns the debug mode on which prints error messages on the screen | `false` | + +If you want to restore the original templates: +1. Navigate to directory `misc` +2. Untar the following two archives: ```bash tar xzvf ./templates.tar.gz -C . tar xzvf ./smarty.tar.gz -C . ``` + diff --git a/init.php b/init.php index 4022145..1e9633f 100644 --- a/init.php +++ b/init.php @@ -19,10 +19,12 @@ $web_path = "/home/pacs/ecg00/users/mlmmj/doms/list.ecogood.org/htdocs-ssl/mlmmj $web_url = "https://list.ecogood.org/"; $language = "en"; $domain_global = "mlmmj"; +$rc_webhook = ""; + +# No need to change this values $current_version = "v1.0"; $headline = "Manage your ECG mailing lists " . $current_version; -$debug = true; -$rc_webhook = ""; +$debug = false; # -------------------------------------------------------------