Initial dockerization

Author: AbstractUmbra

.template.env

@@ -0,0 +1,3 @@
+POSTGRES_USER=pythonistabot
+POSTGRES_PASSWORD=pythonistabot
+POSTGRES_DB=pythonistabot

Dockerfile

@@ -0,0 +1,50 @@
+FROM python:3.11-slim
+
+ENV PYTHONUNBUFFERED=1 \
+    # prevents python creating .pyc files
+    PYTHONDONTWRITEBYTECODE=1 \
+    \
+    # pip
+    PIP_NO_CACHE_DIR=off \
+    PIP_DISABLE_PIP_VERSION_CHECK=on \
+    PIP_DEFAULT_TIMEOUT=100 \
+    \
+    # poetry
+    # https://python-poetry.org/docs/configuration/#using-environment-variables
+    # make poetry install to this location
+    POETRY_HOME="/opt/poetry" \
+    # make poetry create the virtual environment in the project's root
+    # it gets named `.venv`
+    POETRY_VIRTUALENVS_IN_PROJECT=true \
+    # do not ask any interactive question
+    POETRY_NO_INTERACTION=1 \
+    \
+    # paths
+    # this is where our requirements + virtual environment will live
+    PYSETUP_PATH="/opt/pysetup" \
+    VENV_PATH="/opt/pysetup/.venv"
+
+ENV PATH="$POETRY_HOME/bin:$VENV_PATH/bin:$PATH"
+
+RUN apt-get update \
+    && apt-get install --no-install-recommends -y \
+    git \
+    # deps for installing poetry
+    curl \
+    # deps for building python deps
+    build-essential \
+    libcurl4-gnutls-dev \
+    gnutls-dev \
+    libmagic-dev
+
+RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python -
+
+# copy project requirement files here to ensure they will be cached.
+WORKDIR /app
+COPY poetry.lock pyproject.toml ./
+
+# install runtime deps - uses $POETRY_VIRTUALENVS_IN_PROJECT internally
+RUN poetry install --without=dev
+
+COPY . /app/
+ENTRYPOINT poetry run python bot.py

README.md

@@ -21,6 +21,20 @@ In the future we'll provide a systemd unit, pm2 config and maybe a Dockerfile fo
 python bot.py
 ```
 
+### Docker
+
+We also provide both `Dockerfile` and `docker-compose.yml` files for running the bot in Docker.
+The default compose file assumes you want snekbox too, however you can comment out or remove that entire key if this is not the case.
+
+Make a copy of `.template.env` and name it to `.env`, edit the values as you see fit (the defaults will work too, and be okay so long as you don't expose this database to the internet).
+Then a simple `docker compose up` will bring your bot up!
+
+(or `docker-compose` if you are not on the latest versions...)
+
+#### Notes
+
+This also means that it will use internal docker networking to resolve the database and snekbox names. By default these will be `database` and `snekbox`, but these will be the **service names** in `docker-compose.yml` if you change them. Please keep this in mind when editing your config file.
+
 ### Support
 
 As this bot is not really designed for use outside of our Guild, support provided will be **very** limited.

config.template.toml

@@ -5,7 +5,7 @@ idevision = ''
 mystbin = ''
 
 [DATABASE]
-dsn = ''
+dsn = 'postgres://pythonistabot:pythonistabot@database:5432/pythonistabot' # assumed default
 
 # 50 = CRITICAL
 # 40 = ERROR
@@ -17,4 +17,4 @@ webhook_url = ""
 level = 20
 
 [SNEKBOX] # optional
-url = 'http://localhost:8060' # default url
+url = 'http://snekbox:8060' # default url

database/schema.sql

@@ -1,4 +1,35 @@
 services:
+  bot:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: pythonista-bot
+    depends_on:
+      - database
+
+  database:
+    container_name: pythonista-bot-db
+    env_file:
+      - .env
+    environment:
+      - POSTGRES_USER=${POSTGRES_USER}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+      - POSTGRES_DB=${POSTGRES_DB}
+    healthcheck:
+      interval: 1s
+      retries: 10
+      test:
+        [
+          "CMD-SHELL",
+          "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"
+        ]
+      timeout: 5s
+    image: postgres
+    restart: always
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+      - ./database/schema.sql:/docker-entrypoint-initdb.d/schema.sql:ro
+
   snekbox:
     container_name: snekbox-eval
     image: ghcr.io/python-discord/snekbox
@@ -8,3 +39,5 @@ services:
     privileged: true
 
 version: "3"
+volumes:
+  pgdata: