Update prommanager release + doc

matbgn · Nov 8, 2022 · 8ebd211 · 8ebd211
1 parent 9be8bd4
commit 8ebd211
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/.env.example b/.env.example
@@ -14,7 +14,7 @@ ALERT_EMAIL_SMTP_PASS=""
 SYSTEM_ARCH=amd64
 
 # [RECOMMENDED] Set the .env & .versions file path location. Don't forget final slash "/"
-ENV_FILE_PATH="./"
+ENV_FILE_PATH="/opt/prommanager"
 
 # [OPTIONAL] Set custom ports for services otherwise the port range from 9500-9600 will be used
 NODE_EXPORTER_PORT=9500

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 *Labels: Added // Changed // Deprecated // Removed // Fixed // Security // Chore*
 
 ## [Unreleased]
+...
+
+## [5.1.0] - 2022-11-08
 ### Add
 - Add env file path variable to specify custom location
 
@@ -115,7 +118,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ### Removed
 - [WARNING] Breaking changes for script arguments
 
-[Unreleased]: https://github.com/matbgn/prommanager/compare/v5.0.0...HEAD
+[Unreleased]: https://github.com/matbgn/prommanager/compare/v5.1.0...HEAD
+[5.1.0]: https://github.com/matbgn/prommanager/compare/v5.0.0...v5.1.0
 [5.0.0]: https://github.com/matbgn/prommanager/compare/v4.1.0...v5.0.0
 [4.1.0]: https://github.com/matbgn/prommanager/compare/v4.0.2...v4.1.0
 [4.0.2]: https://github.com/matbgn/prommanager/compare/v4.0.1...v4.0.2

diff --git a/docs/README.md b/docs/README.md
@@ -119,6 +119,8 @@ Prommanager requires a very minimal configuration to work, but aditionnal ones g
 All the communications services have corresponding environment variables associated with it. You
 have to provide those within the .env file. See the [PingMe CLI Documentation Page](https://pingme.lmno.pk/#/services) for more details.
 
+Prefer an installation in `/opt/prommanager/` as it is a good practice. If you want you can override this location via `ENV_FILE_PATH` variable (see below).
+
 To activate configuration start by moving the provided .env.example as .env next to prommanager executable and edit it as needed :
 
 ```bash
@@ -134,8 +136,8 @@ ALERT_EMAIL_SMTP_USER=""
 # ALERT_EMAIL_SMTP_PASS="my_top_secret_pass"
 ALERT_EMAIL_SMTP_PASS=""
 
-# [RECOMMENDED] Set the .env & .versions file path location. Don't forget final slash "/"
-ENV_FILE_PATH="./"
+# [RECOMMENDED] Set the .env & .versions file path location
+ENV_FILE_PATH="/opt/prommanager/"
 
 # [OPTIONAL] Add supplementary services to be notified from (space separated!)
 # (see https://pingme.lmno.pk/ - except Email and Zulip NOT SUPPORTED HERE because provided by default, see above)

diff --git a/prommanager b/prommanager
@@ -21,7 +21,7 @@ UPDATE_VERSIONS=false
 UPDATE_CONFIGS=false
 INSTALL=false
 
-ENV_FILE_PATH="./"
+ENV_FILE_PATH="/opt/prommanager"
 
 # Default configuration if not override by .env file
 NODE_EXPORTER_PORT=9500