Updated README, env_dist, pg_init_user.sh and docker example

Author: MasterGroosha

README.md

@@ -10,8 +10,8 @@ with bombs on them. If you open a cell with a bomb, the game is over.
 ![screenshot](screenshot.png)
 
 ## Used technology
-* Python (tested with 3.9, should work on 3.7+);
-* aiogram (Telegram Bot framework);
+* Python 3.9;
+* aiogram 3.x (Telegram Bot framework);
 * Docker and Docker Compose (containerization);
 * PostgreSQL (database);
 * Redis (persistent storage for some ongoing game data);
@@ -21,16 +21,18 @@ with bombs on them. If you open a cell with a bomb, the game is over.
 
 ## Installation
 
-Create a directory of your choice. Inside it, make 3 directories for bot's data:  
-`mkdir -p {pg-data,redis-data,redis-config}`
+Create a directory of your choice, let's say `/opt/bombsweeper`. Inside it, make 3 directories for bot's data:  
+`mkdir -p {pg/init,pg/data,redis/config,redis/data}`
 
-Grab `docker-compose-example.yml`, rename it to `docker-compose.yml` and put it next to your 
-directories.
+Grab `docker-compose-example.yml`, rename it to `docker-compose.yml` and put it to `/opt/bombsweeper`.
 
-Grab `redis.example.conf` file, rename it to `redis.conf` and put into `redis-config` directory. 
+Grab `redis.example.conf` file, rename it to `redis.conf` and put into `redis/config` directory. 
 Change its values for your preference.
 
+Grab `pg_init_user.sh`, put it into `pg/init` and make executable (add "x" flag). Open it, replace  
+`myuser` and `mydb` values with your own. Save file.
+
 Grab `env_dist` file, rename it to `.env` and put it next to your `docker-compose.yml`, open 
-and fill the necessary data.
+and fill the necessary data. Pay attention to POSTGRES_DSN value, sync it with `pg_init_user` values.
 
 Finally, start your bot with `docker-compose up -d` command.

docker-compose-example.yml

@@ -1,33 +1,32 @@
 version: '3.8'
 services:
+    # You can remove redis section and all its mentions if using "memory" storage
     redis:
-        image: redis:6.0-alpine
+        image: redis:6-alpine
         restart: "unless-stopped"
-        environment:
-            - REDIS_HOST
         volumes:
             # don't forget to put redis.conf to redis_config directory!
-            - "/path/to/bombsweeper/redis_config:/usr/local/etc/redis"
-            - "/path/to/bombsweeper/redis_data:/data"
+            - "/opt/bombsweeper/redis/config:/usr/local/etc/redis"
+            - "/opt/bombsweeper/redis/data:/data"
         command: "redis-server /usr/local/etc/redis/redis.conf"
     db:
         image: postgres:13-alpine
         restart: "unless-stopped"
         environment:
-            POSTGRES_USER: ${DB_USER}
-            POSTGRES_PASSWORD: ${DB_PASS}
-            POSTGRES_DB: ${DB_NAME}
+            POSTGRES_PASSWORD: ${SUPERUSER_PASSWORD}
         volumes:
-            - "/path/to/bombsweeper/postgres_data:/var/lib/postgresql/data"
+            - "/opt/bombsweeper/pg/data:/var/lib/postgresql/data"
+            - "/opt/bombsweeper/pg/init:/docker-entrypoint-initdb.d"
     db_migration:
-        image: "groosha/telegram-bombsweeper-bot:${IMAGE}"
+        # You can override this tag using docker-compose.override.yml
+        image: "groosha/telegram-bombsweeper-bot:latest"
         restart: "on-failure"
         depends_on:
-            -   db
+            - db
         env_file: .env
         command: sh -c "python -m alembic upgrade head"
     bot:
-        image: "groosha/telegram-bombsweeper-bot:${IMAGE}"
+        image: "groosha/telegram-bombsweeper-bot:latest"
         stop_signal: SIGINT
         restart: "unless-stopped"
         env_file: .env

env_dist

@@ -1,18 +1,39 @@
-# telegram
+# Bot settings
+## Token (required). Get it from @BotFather
 BOT_TOKEN=1234567890:abcdefghijklmnopqrstuvwxyz
-# database
-DB_HOST=db
-DB_PORT=5432
-DB_NAME=yourdb
-DB_USER=user
-DB_PASS=s3cr3t
-# redis (FSM)
-REDIS_HOST=redis
-# docker image
-IMAGE=latest
-# webhooks
-WEBHOOK_ENABLED=1
-WEBHOOK_DOMAIN=bombsweeper.example.com
-WEBHOOK_PATH=/extra/path/from/root
-APP_HOST=0.0.0.0
-APP_PORT=9000
+## FSM Storage for game data. Values allowed: memory, redis
+BOT_FSM_STORAGE=redis
+
+# Storages
+## Redis connection string. Required if BOT_FSM_STORAGE=redis
+REDIS_DSN=redis://localhost:6379/0
+## PostgreSQL connection string. Always required
+POSTGRES_DSN=postgresql+asyncpg://USER:PASSWORD@HOST:PORT/DBNAME
+
+# Database settings
+## Password for superuser in PostgreSQL.
+## If upgrading from existing versions, this is PASSWORD from POSTGRES_DSN above
+## If creating a new instance, set it to some strong random password
+SUPERUSER_PASSWORD=1234567890
+
+## Name of superuser in PostgreSQL
+## If upgrading from existing versions, this is USER from POSTGRES_DSN above
+## If creating a new instance, either skip it or set it to both here and docker-compose.yml
+## SUPERUSER_USER=admin
+
+# Webhooks (optional)
+# You can skip this section if you want to use polling
+## Domain part of your webhook.
+# WEBHOOK_DOMAIN=http://localhost:9000
+## Actual path for your webhook on your domain
+# WEBHOOK_PATH=/bombsweeper/s89ytjr5dh
+
+# App settings (optional)
+# You can skip this section if you want to use polling
+# or if default settings are sufficient.
+# APP_HOST=0.0.0.0
+# APP_PORT=9000
+
+# Using local Bot API server (Optional)
+# You can skip this section if you want to use primary Bot API server
+# CUSTOM_BOT_API=http://localhost:8081

pg_init_user.sh

@@ -2,8 +2,11 @@
 
 set -e
 
+# Replace myuser and mydb with your own values
+# Don't forget to change them in .env file too!
+
 psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
-    CREATE USER user;
-    CREATE DATABASE sweeperdb;
-    GRANT ALL PRIVILEGES ON DATABASE sweeperdb TO user;
+    CREATE USER myuser;
+    CREATE DATABASE mydb;
+    GRANT ALL PRIVILEGES ON DATABASE mydb TO myuser;
 EOSQL