Built and pushed Docker image to Github Packages (#121)

Author: tobiasmcnulty

.dockerignore

@@ -0,0 +1,8 @@
+.direnv/
+.dockerignore
+.envrc
+.git/
+.github/
+.gitignore
+docker-compose.yml
+*.pyc

.github/workflows/docker-publish.yml

@@ -0,0 +1,46 @@
+name: Create and publish a Docker image
+
+on:
+  push:
+    branches: ['main']
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          flavor: |
+            latest=true
+          tags: |
+            type=ref,event=branch
+            type=sha
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -1,4 +1,7 @@
+*.bak
 *.pyc
+.direnv/
+.envrc
 .sass-cache/
 DjangoPlugin/Django_Plugin.egg-info/
 trac-env/htdocs/css/trachacks.css*

Dockerfile

@@ -0,0 +1,62 @@
+# The official python:2.7 image no longer receives automatic rebuilds (it's
+# a year old as of October, 2021), so use the latest LTS release of Ubuntu
+# that includes Python 2.7 instead.
+FROM ubuntu:20.04
+
+# Install packages needed to run your application (not build deps).
+RUN set -x \
+    && RUN_DEPS=" \
+    ca-certificates \
+    git \
+    libpq5 \
+    make \
+    postgresql-client \
+    python2.7 \
+    " \
+    && apt-get update && apt-get install -y --no-install-recommends $RUN_DEPS \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy requirements
+ADD requirements.txt /requirements.txt
+ADD DjangoPlugin /DjangoPlugin
+
+# Install build deps, then run `pip install`, then remove unneeded build deps all in a single step.
+# Correct the path to your production requirements file, if needed.
+# For installing a python2.7-compatible pip: https://stackoverflow.com/a/54335642/166053
+# Since we are using the system Python, also isolate the code in its own virtualenv.
+RUN set -x \
+    && BUILD_DEPS=" \
+    build-essential \
+    libpq-dev \
+    python2.7-dev \
+    wget \
+    " \
+    && apt-get update && apt-get install -y --no-install-recommends $BUILD_DEPS \
+    && wget -q -O /tmp/get-pip.py https://bootstrap.pypa.io/pip/2.7/get-pip.py \
+    && python2.7 /tmp/get-pip.py \
+    && rm /tmp/get-pip.py \
+    && python2.7 -m pip install virtualenv \
+    && virtualenv /venv \
+    && /venv/bin/python -m pip install --no-cache-dir -r /requirements.txt \
+    \
+    && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false $BUILD_DEPS \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy application code
+RUN mkdir /code/
+WORKDIR /code/
+ADD . /code/
+
+RUN PATH=/venv/bin:${PATH} make compile-scss
+
+VOLUME /code/trac-env/files/
+
+# gunicorn or tracd will listen on this port
+EXPOSE 9000
+
+ENV DJANGO_SETTINGS_MODULE=tracdjangoplugin.settings TRAC_ENV=/code/trac-env/
+
+ENTRYPOINT ["/code/docker-entrypoint.sh"]
+
+# Start gunicorn
+CMD ["/venv/bin/gunicorn", "tracdjangoplugin.wsgi:application", "--bind", "0.0.0.0:9000", "--workers", "4", "--max-requests", "1000"]

README.rst

@@ -7,16 +7,38 @@ Local install
 Getting a local Trac install running is a bit tricky. Here are a few tricks
 that can help:
 
-* Install the requirements in the same virtualenv as djangoproject.com.
 * Follow the installation instructions in djangoproject/README.rst (especially
   the database creation).
-* Use ``psql -U code.djangoproject -d code.djangoproject -c "INSERT INTO permission (username, action) VALUES ('anonymous', 'TRAC_ADMIN')"``
+* Use ``trac-admin ./trac-env/ permission add anonymous TRAC_ADMIN``
   to give all permissions to the anonymous user.
 * Use the command ``tracd --port 9000 -s trac-env`` to serve Trac locally.
 * If you've modified the ``trackhack.scss`` file, use
   ``sassc scss/trachacks.scss trac-env/htdocs/css/trachacks.css -s compressed``
   to compile it to CSS.
 
+Using Docker
+------------
+
+* Install Docker
+* ``pip install docker-compose``
+* ``docker-compose up --build``
+* Follow instructions above to create/load the DB, grant permissions, create the
+  config, etc. For example::
+
+    docker-compose up --build
+    export DATABASE_URL=postgres://code.djangoproject:secret@db/code.djangoproject
+    docker-compose exec -T db psql $DATABASE_URL < ../djangoproject.com/tracdb/trac.sql
+    docker-compose exec trac /venv/bin/trac-admin /code/trac-env/ permission add anonymous TRAC_ADMIN
+
+Using Podman
+------------
+
+It may be possible to use Podman for local development to more closely simulate
+production. The above Docker instructions should work for Podman as well,
+however, be aware that ``podman-compose`` is not as well battle-tested as
+``docker-compose`` (e.g., it may require pruning or forcefully stopping a
+container before it will rebuild properly).
+
 How to port the CSS from djangoproject.com
 ------------------------------------------
 
@@ -31,3 +53,29 @@ same directory (adjust paths if needed).
    ``cp -rT ../djangoproject.com/static/js trac-env/htdocs/js``
 4. Compile trackhacks.scss:
    ``make compile-scss``
+
+How to recreate `trac.sql` after upgrading Trac
+-----------------------------------------------
+
+
+Start with a clean slate::
+
+  docker-compose down
+  sh -c 'cd ../djangoproject.com && git checkout tracdb/trac.sql'
+
+Bring up database and Trac via docker-compose::
+
+  docker-compose up --build -d
+  export DATABASE_URL=postgres://code.djangoproject:secret@db/code.djangoproject
+  docker-compose exec -T db psql $DATABASE_URL < ../djangoproject.com/tracdb/trac.sql
+  docker-compose exec trac /venv/bin/trac-admin /code/trac-env/ upgrade
+  docker-compose exec db pg_dump --column-inserts -d $DATABASE_URL > ../djangoproject.com/tracdb/trac.sql
+
+
+Note:
+
+* There's no need to run the ``trac-admin ... wiki upgrade`` command
+* Be careful with changes that ``trac-admin ... upgrade`` makes to
+  ``trac.ini``. We usually don't want them.
+* Review the diff carefully to make sure no unexpected database changes
+  are inadvertently included.

docker-compose.yml

@@ -0,0 +1,27 @@
+version: '3.7'
+
+services:
+  trac:
+    image: ghcr.io/django/code.djangoproject.com:latest
+    # Comment out to use the ghcr.io image:
+    build:
+      context: ./
+      dockerfile: Dockerfile
+    command: ["/venv/bin/tracd", "--port", "9000", "-s", "trac-env"]
+    environment:
+     - TRAC_INI_database=postgres://code.djangoproject:secret@db/code.djangoproject
+    volumes:
+      - ./:/code/
+    ports:
+      - 9000:9000
+    depends_on:
+      - db
+  db:
+    image: postgres:10-alpine
+    ports:
+      # Port 5435 might be handy for loading trac.sql from the djangoproject.com repo
+      - 5435:5432
+    environment:
+      - POSTGRES_USER=code.djangoproject
+      - POSTGRES_PASSWORD=secret
+      - POSTGRES_DB=code.djangoproject

docker-entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Fail loudly, don't echo variables to logs
+set -e
+
+# Trac doesn't read environment variables, so allow setting arbitrary lines in
+# trac.ini from the environment before Trac starts. E.g.,
+#   export TRAC_INI_database = postgres://...
+# will become
+#   database = postgres://...
+
+for var in "${!TRAC_INI_@}"; do
+    sed -i "s;^${var:9} = .*;${var:9} = ${!var};" trac-env/conf/trac.ini
+done
+
+if [ "x$TRAC_COLLECT_STATIC" = 'xon' ]; then
+    # Collect trac static files to be served by nginx
+    /venv/bin/trac-admin ./trac-env/ deploy ./static/
+fi
+
+exec "$@"

requirements.txt

@@ -2,7 +2,7 @@ Trac==1.2.6
 Pygments==2.5.2
 dnspython==1.15
 spambayes == 1.1b1
-psycopg2-binary==2.7.6.1
+psycopg2==2.7.6.1 --no-binary=psycopg2
 docutils==0.14
 Django==1.11.29
 libsass==0.17.0
@@ -16,4 +16,6 @@ requests==2.20.1
 requests-oauthlib==1.0.0
 trac-github==2.3
 
+gunicorn==19.10.0
+
 -e ./DjangoPlugin

trac-env/conf/trac.ini

@@ -139,7 +139,7 @@ default_anonymous_query = status!=closed&desc=1&order=id
 default_query = status!=closed&desc=1&order=id
 
 [repositories]
-.dir = /home/www/trac/django-mirror
+.dir = /django-mirror
 .type = git
 
 [search]