Hal De 4 жил өмнө
parent
commit
ef7d784f8c
1 өөрчлөгдсөн 35 нэмэгдсэн , 11 устгасан
  1. 35 11
      README.md

+ 35 - 11
README.md

@@ -9,6 +9,7 @@ cp app.env.dist app.env
 Edit `.env` and `app.env` with your preffered editor.
 Adjust environment variables for your needs.
 The most important variables to set are:
+
 | Variable | Description |
 | -------- | ----------- |
 | PERSISTENT_STORAGE_PATH | Host path for persistent data storage |
@@ -28,16 +29,14 @@ The most important variables to set are:
 | HTTPD_HTTPS_ENABLED | Set to "true" to enable HTTPS for Freepbx |
 | HTTPD_REDIRECT_HTTP_TO_HTTPS | Set to "true" to redirect HTTP requests to HTTPS |
 | LETSENCRYPT_ENABLED | Set to "true" to automatically request and maintain LetsEncrypt cert for HTTPS |
-| | Change following variables to desired values. Not required if SENDMAIL_TG=true. |
-| SMTP_MAIL_FROM |
-| ROOT_MAILTO |
-| FAIL2BAN_DEFAULT_DESTEMAIL |
-| FAIL2BAN_DEFAULT_SENDER |
+| SMTP_MAIL_FROM | Change following to desired value. Not required if SENDMAIL_TG=true. |
+| ROOT_MAILTO | Change following to desired value. Not required if SENDMAIL_TG=true. |
+| FAIL2BAN_DEFAULT_DESTEMAIL | Change following to desired value. Not required if SENDMAIL_TG=true. |
+| FAIL2BAN_DEFAULT_SENDER | Change following to desired value. Not required if SENDMAIL_TG=true. |
 
 Run:
 
 ```sh
-
 docker-compose build
 ```
 Wait paitently until you see:
@@ -47,29 +46,54 @@ If running for first time it can take long to build everything.
 Run:
 
 ```
-
 docker-compose up -d
 ```
 
 Run:
 
 ```
-
 docker-compose logs -f pbx
 ```
+
 Watch pbx container initialization for errors and wait for:
 ` fail2ban entered RUNNING state, process has stayed up for > than 5 seconds`
 Close container log output with `Ctrl+C` keys.
 
-Restart container with `docker restart pbx` if you set `LETSENCRYPT_ENABLED` to `true`.
+Restart container one extra time with `docker-compose restart pbx` if you set `LETSENCRYPT_ENABLED` to `true`.
 
 Open the address you set for APP_FQDN in browser and configure Freepbx superadmin username and password. Proceed to voice language configuration. Finally press "Apply Config" button.
 
 Run:
 
-```
-
+```sh
 docker-compose logs -f app
 ```
 Open `http://APP_FQDN:8000/ui`
 Test the API with youre configured `APP_AUTH_SECRET`
+
+# Upgrading:
+```sh
+git pull
+docker-compose build
+docker-compose up -d
+```
+
+# Start from scratch:
+```sh
+docker-compose stop
+docker compose rm
+```
+
+remove the `PERSISTENT_STORAGE_PATH` directory, e.g.:
+
+```sh
+rm -rf ./data
+```
+
+Repeat steps from Quick Start:
+
+```
+git pull
+docker-compose build
+docker-compose up -d
+```