Merge pull request #1 from poontology/main

add docker setup

Author: UBTL

README.md

@@ -7,8 +7,28 @@ An offline E-hentai browser for archival purposes, keeping Hentai history around
 
 - MySQL 5.3+ / MariaDB 10+
 
+- Docker (optional)
 
-## Setup & Start Up
+## Setup & Start Up using docker-compose
+
+    # change dbHost to point to docker db container (or edit config.js manually)
+    sed -i 's,localhost,mariadb,' config.js
+
+    # run it
+    docker-compose up -d
+
+Docker installs mariadb+node images (<1GB total, to see what they contain try `docker history mariadb:lts`), it inserts SQL on first startup (takes a minute, DB persists on restart) and then starts app which accepts connections on http://localhost:6969/
+
+If you're paranoid about app making undesired outgoing connection there's an alternate startup command in docker-compose.yml which sets up a firewall within the container (ofc then you also can't run sync script from the container).
+
+To interact with the containers:
+
+    # query db
+    docker exec -it pandabrowser_mariadb_1 mariadb -p69 panda
+    # run scripts
+    docker exec -it pandabrowser_app_1 npm run fetch
+
+## Setup & Start Up manually
 
 1. Install the provided database file (panda_2024_01_01.sql) into MySQL, the default database name being "panda" here.
 

docker-compose.yml

@@ -0,0 +1,36 @@
+version: '3.5'
+
+services:
+  mariadb:
+    image: mariadb:lts
+    environment:
+      MARIADB_ROOT_PASSWORD: 69
+      MARIADB_DATABASE: panda
+    # for external access
+    #ports:
+    #  - "3306:3306"
+    volumes:
+      - ./panda_2024_01_01.sql.gz:/docker-entrypoint-initdb.d/1.sql.gz
+      - ./mariadb:/var/lib/mysql
+  app:
+    image: node:22-alpine
+    working_dir: /app
+    ## --[ Alternative commands (have only one uncommented) ]--
+    command: npm start
+    ## --[ webpack-dev-server ]--
+    #command: sh -c 'npm start & npm run dev'
+    ## to run webpack in docker edit webpack.config.js, add
+    ## under devServer `host: '0.0.0.0', disableHostCheck: true,`,
+    ## for thumbs proxy /pandathumbs same as /api, then expose 8080
+    ## --[ paranoid net setup preventing outgoing connections ]--
+    #command: /app/docker-paranoid-net.sh "npm start"
+    #cap_add:
+    #  - NET_ADMIN  # required to config firewall within the container
+    ## --[ /commands ]--
+    ports:
+      - "6969:8880"
+      #- "8080:8080"
+    volumes:
+      - ./:/app
+    depends_on:
+      - mariadb

docker-paranoid-net.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+DB_IP=$(getent hosts mariadb | cut -d' ' -f1)
+apk add ufw
+ufw default deny outgoing
+ufw allow out to 127.0.0.1
+ufw allow out to "$DB_IP" port 3306
+ufw allow in to any port 6969
+ufw enable
+
+su -c "$@" node
+