Docker

.gitignore

@@ -3,3 +3,6 @@ siikr/dev/**
 siikr/auth/**
 siikr/internal/disks.php
 siikr/management/archive_blogs.php
+siikr.env
+
+postgres_data/

Makefile

@@ -0,0 +1,49 @@
+DOCKER_REPO?=meyerkev248/siikr
+
+reset:
+	$(MAKE) build
+	$(MAKE) down
+	$(MAKE) up
+
+reset-clean:
+	$(MAKE) build
+	$(MAKE) clean
+	$(MAKE) up
+
+.PHONY: build
+build:
+	docker-compose build
+
+.PHONY: up
+up:
+
+	docker-compose up -d
+
+.PHONY: down
+down:
+	docker-compose down
+
+.PHONY: clean
+clean:
+	docker-compose down -v
+
+.PHONY: logs
+logs:
+	docker-compose logs -f
+
+.PHONY: docker-push
+docker-push:
+	@IMAGES="my-postgres:latest my-php-fpm:latest"; \
+	TAG=$$(git rev-parse --short HEAD); \
+	if [ -n "$$(git status --porcelain)" ]; then \
+		TAG="$$TAG-dirty"; \
+	fi; \
+	for IMAGE in $$IMAGES; do \
+		docker tag $$IMAGE ${DOCKER_REPO}:$$TAG; \
+		echo "Pushing $$IMAGE to ${DOCKER_REPO}:$$TAG"; \
+		docker push ${DOCKER_REPO}:$$TAG; \
+	done
+
+.PHONY: debug
+debug:
+	docker-compose exec php bash

README.md

@@ -7,9 +7,20 @@ IYKYK.
 Best done on a clean Ubuntu or debian server.
 
 0. clone this repo.
-1. Fill out (at a minimum) the first three lines in `siikr.conf`
+1. Copy `siikr.example.env` to `siikr.env` and fill out (at a minimum) the first three lines.
 2. If not already in a terminal, switch to one and run `chmod +x setup_simple.sh`
 3. Then run `sudo ./setup_simple.sh` and follow the prompts.
 4. Pray.
 5. Submit an issue if it fails.
 
+# Docker installation
+
+Docker gives you a clean server, but the install may be a little more involved.
+
+0. clone this repo.
+1. Make sure you have both Docker and `docker-compose` installed.
+    1. TODO: Document how to setup the API key sanely
+2. Copy `siikr.example.env` to `siikr.env` and fill out (at a minimum) the first three lines while noticing the hardcoded postgres user siikrweb.
+3. `make build up && open localhost:8080 && make logs` - This will follow logs in the terminal and open the browser window
+4. You'll need to do some magic with DDNS for callback reasons in your router or via some other mechanism.  This is _not_ documented.  
+

docker-compose.yaml

@@ -0,0 +1,43 @@
+
+version: '3'
+
+services:
+  postgres:
+    build:
+      context: .
+      dockerfile: docker/postgres.Dockerfile
+    image: my-postgres:latest
+    env_file: 
+      - siikr.env
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+      - ./siikr/siikr_db_setup.sql:/docker-entrypoint-initdb.d/01_siikr_db_setup.sql
+    healthcheck:
+      test: ["CMD", "pg_isready", "-U", "postgres"]
+      interval: 10s
+      retries: 5
+      start_period: 30s
+      timeout: 5s
+
+  php:
+    build:
+      context: .
+      dockerfile: docker/php-fpm.Dockerfile
+    image: my-php-fpm:latest
+    ports:
+      - "8080:80"
+    env_file: 
+      - siikr.env
+    depends_on: 
+      postgres:
+        condition: service_healthy
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:80"]
+      interval: 1m30s
+      timeout: 30s
+      retries: 5
+      start_period: 30s
+
+volumes:
+  postgres_data:
+

docker/create_database.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+set -eo pipefail
+
+script_path="$(realpath "$0")"
+script_dir="$(realpath "$(dirname "$script_path")"/..)"
+
+if [[ ! -f "$script_dir/siikr.env" ]]; then
+    echo "Could not find $script_dir/siikr.env. Make sure to copy siikr.example.env and fill it out with your deploy information."
+    exit 1
+fi
+
+source "$script_dir/siikr.env"
+
+docker-compose up -d postgres
+echo "Waiting for the database to be created and to come online..."
+sleep 3
+docker-compose exec -T -u postgres postgres psql -U "$POSTGRES_USER" -d "$POSTGRES_DB" < "$script_dir/siikr/siikr_db_setup.sql"
+#docker-compose down postgres

docker/entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+if [ -f siikr.env ]; then
+  export $(cat siikr.env | xargs)
+fi
+
+cat > /var/www/html/auth/credentials.php <<EOF
+<?php
+\$api_key = '$tumblr_API_consumer_key';
+\$db_name = '$POSTGRES_DB';
+\$db_user = '$POSTGRES_USER';
+\$db_pass = '$POSTGRES_PASSWORD';
+\$db_host = 'postgres';
+EOF
+
+exec "$@"

docker/nginx-siikr.conf

@@ -0,0 +1,23 @@
+server {
+    listen          80  default_server;
+    server_name     _;
+
+    root /var/www/html;
+
+    index index.html index.php;
+
+
+    location / {
+        # First attempt to serve request as file, then
+        # as directory, then fall back to displaying a 404.
+        try_files $uri $uri/ =404;
+    }
+
+    location ~ \.php$ {
+        include snippets/fastcgi-php.conf;
+        fastcgi_pass 127.0.0.1:9000;
+    }
+
+    error_log /dev/stdout;
+    access_log /dev/stdout;
+}

docker/php-fpm-siikr.conf

@@ -0,0 +1 @@
+[www]

docker/php-fpm.Dockerfile

@@ -0,0 +1,65 @@
+FROM php:8.2-fpm
+
+# Install dependencies
+RUN apt-get update && \
+    apt-get install -y libpq-dev hunspell hunspell-en-us libzmq5-dev supervisor nginx gcc git
+
+# Compile and install php-zmq
+#
+# PHP-ZMQ has some ... interesting issues with the Docker container.
+# * There does not appear to be a package for it(?) and it doesn't come installed
+#   with PHP.
+# * The package available on PECL is about 8 years old and the repo is abandoned.
+# So we have to compile it from source. However, this is not that painful. Just
+# annoying that we have to do it ourselves.
+
+# TODO: make this into a script and just copy it over rather than having this
+#       all embedded in the Dockerfile
+# TODO: choose a specific tag or commit to clone from rather than using master,
+#       for reproducible builds
+
+RUN cd /tmp && \
+    git clone "https://github.com/zeromq/php-zmq" && \
+    cd php-zmq && \
+    phpize && \
+    ./configure && \
+    make && make install && \
+    cd .. && rm -rf php-zmq
+
+# Enable PHP extensions
+RUN docker-php-ext-configure pgsql && \
+    docker-php-ext-install pgsql && \
+    docker-php-ext-enable zmq
+
+# Add php-fpm config
+COPY docker/php-fpm-siikr.conf /usr/local/etc/php-fpm.d
+
+# Add nginx config
+COPY docker/nginx-siikr.conf /etc/nginx/sites-available/default
+
+# Initialize supervisord
+RUN mkdir -p /var/log/supervisor
+COPY docker/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+
+WORKDIR /var/www/html
+
+# TODO: set up php-fpm config like the setup_simple.sh script does
+
+# Clean out /var/www/html and then copy siikr
+RUN rm /var/www/html/* -rf
+COPY siikr/. /var/www/html
+
+# Create database configuration
+RUN mkdir -p /var/www/html/auth
+
+
+RUN cat > /var/www/html/internal/disks.php <<EOF
+<?php
+\$db_disk = '$pg_disk';
+EOF
+
+COPY docker/entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT [ "/entrypoint.sh" ]
+
+CMD ["/usr/bin/supervisord"]

docker/postgres.Dockerfile

@@ -0,0 +1,4 @@
+ARG POSTGRES_VERSION=14
+FROM postgres:$(POSTGRES_VERSION)-bookworm
+RUN apt-get update && \
+    apt-get -y install hunspell hunspell-en-us postgresql-$(POSTGRES_VERSION)-pgvector

docker/supervisord.conf

@@ -0,0 +1,35 @@
+[supervisord]
+user=root
+nodaemon=true
+logfile=/dev/null
+logfile_maxbytes=0
+
+[program:php-fpm]
+command=php-fpm
+user=root
+autostart=true
+autorestart=true
+# Redirect stderr to stdout, and log to stdout
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+
+[program:msgrouter]
+command=php /var/www/html/routing/msgRouter.php
+user=root
+autostart=true
+autorestart=true
+# Redirect stderr to stdout, and log to stdout
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+
+[program:nginx]
+command=nginx -g 'daemon off;'
+user=root
+autostart=true
+autorestart=true
+# Redirect stderr to stdout, and log to stdout
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true

setup_simple.sh

@@ -4,8 +4,12 @@ set -eo pipefail
 script_path="$(realpath "$0")"
 script_dir="$(dirname "$script_path")"
 
-source "$script_dir/siikr.conf"
+if [[ ! -f "$script_dir/siikr.env" ]]; then
+    echo "Could not find $script_dir/siikr.env. Make sure to copy siikr.example.env and fill it out with your deploy information."
+    exit 1
+fi
 
+source "$script_dir/siikr.env"
 
 update_install_packages() {
     local confirm
@@ -81,6 +85,7 @@ set_credentials_file() {
 \$db_name = '$siikr_db';
 \$db_user = '$pg_user';
 \$db_pass = '$pg_pass';
+\$db_host = '$pg_host';
 EOF
 
     cat > "$script_dir/siikr/internal/disks.php" << EOF

siikr.example.env

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+tumblr_API_consumer_key="PUT YOUR KEY HERE"
+pg_pass="PUT YOUR DB PASSWORD HERE"
+# If using Docker, this should be set to /var/lib/postgresql/data
+pg_disk="PUT THE MOUNTPOINT OF WHEREVER THE DISK DRIVE STORING THE DB DATA IS HERE"
+document_root="/var/www/html/" #location you want to install siikr into
+php_dir="/usr/bin/php" #location of your active php install
+php_user="www-data" #the user your php server runs as
+pg_user="siikrweb" #postgres username that database access will be performed as.
+siikr_db="siikrdb" #name of siikr database to create
+
+# These are Docker-specific environment variables, don't touch these.
+POSTGRES_USER="$pg_user"
+POSTGRES_PASSWORD="$pg_pass"
+POSTGRES_DB="$siikr_db"
+
+# If you're using Docker, follow these
+# These are Docker-specific environment variables, don't touch these.
+# https://github.com/containers/podman-compose/issues/718
+# POSTGRES_USER="$pg_user"
+# POSTGRES_PASSWORD="$pg_pass"
+# POSTGRES_DB="$siikr_db"
+
+POSTGRES_USER=siikrweb
+POSTGRES_PASSWORD="testtesttest"
+POSTGRES_DB=siikrdb

siikr/get_tags.php

@@ -2,7 +2,7 @@
 require_once 'internal/globals.php';
 $blog_uuid = $_GET["blog_uuid"];
 try {
-    $db = new PDO("pgsql:dbname=$db_name", "www-data", null);
+    $db = get_db();
     $blog_info = (object)[
         "valid" => false,
         "blog_uuid" => $blog_uuid,

siikr/index.php

@@ -1,6 +1,6 @@
 <?php
 require_once "squid_game.php";
-if($_GET['lemmein']==true) {
+if(isset($_GET['lemmein'])) {
     require_once "show_page.php";
 } else if($squid_game_warn == false && $squid_game == true) {
     require_once "maintenance.php";

siikr/internal/archive.php

@@ -2,8 +2,7 @@
 require_once 'globals.php';
 
 $archiver_uuid = uuid_create(UUID_TYPE_RANDOM);
-$userInfo = posix_getpwuid(posix_geteuid());
-$db = new PDO("pgsql:dbname=$db_name", $userInfo["name"], null);
+$db = get_db();
 
 require_once 'lease.php';