Add documentation for listening port configuration

Signed-off-by: Steven Kriegler <sk.bunsenbrenner@gmail.com>

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.2.1
+
+### 🤖 Application
+
+- Allow configuring listening port
+
+### 🐳 Docker image
+
+- Add `GITEA_SQ_BOT_PORT` environment variable
+
 ## v0.2.0
 
 ### 🤖 Application

Dockerfile

@@ -41,6 +41,7 @@ ENV HOME=/home/bot
 EXPOSE 3000
 ENV GIN_MODE "release"
 ENV GITEA_SQ_BOT_CONFIG_PATH "/home/bot/config/config.yaml"
+ENV GITEA_SQ_BOT_PORT "3000"
 
 VOLUME ["/home/bot/config/"]
 RUN ["chmod", "+x", "/usr/local/bin/docker-entrypoint.sh"]

README.md

@@ -53,6 +53,15 @@ See [config.example.yaml](config/config.example.yaml) for a full configuration s
 
 ## Installation
 
+Supported environment variables for application runtime configuration:
+
+| Environment Variable        | Purpose                         |
+|-----------------------------|---------------------------------|
+| `GITEA_SQ_BOT_PORT`         | Port the bot will listen on     |
+| `GITEA_SQ_BOT_CONFIG_PATH`  | Full path to configuration file |
+
+For detailed information, use the `--help` flag.
+
 ### Docker
 
 Create a directory `config` and place your [config.yaml](config/config.example.yaml) inside it. Open a terminal next to this directory