Merge b4bcc3b196 into 376f687c38

The minimum version requirements are rough guesses, in practice any decently modern docker installation should work.

client/build.js

@@ -315,8 +315,13 @@ function makeOutputDirs() {
 }
 
 function watch() {
-    let wss = new WebSocket.Server({ port: 8080 });
+    let wss = new WebSocket.Server({ port: 8081 });
     const liveReload = !process.argv.includes('--no-live-reload');
+    const polling = process.argv.includes("--polling");
+
+    const chokidarOptions = {
+        usePolling: polling,
+    };
 
     function emitReload() {
         if (liveReload) {
@@ -329,7 +334,7 @@ function watch() {
         }
     }
 
-    chokidar.watch('./fonts/**/*').on('change', () => {
+    chokidar.watch('./fonts/**/*', chokidarOptions).on('change', () => {
         try {
             bundleBinaryAssets();
             emitReload();
@@ -337,7 +342,7 @@ function watch() {
             console.error(pe.render(e));
         }
     });
-    chokidar.watch('./img/**/*').on('change', () => {
+    chokidar.watch('./img/**/*', chokidarOptions).on('change', () => {
         try {
             bundleWebAppFiles();
             emitReload();
@@ -345,14 +350,14 @@ function watch() {
             console.error(pe.render(e));
         }
     });
-    chokidar.watch('./html/**/*.tpl').on('change', () => {
+    chokidar.watch('./html/**/*.tpl', chokidarOptions).on('change', () => {
         try {
             bundleHtml();
         } catch (e) {
             console.error(pe.render(e));
         }
     });
-    chokidar.watch('./css/**/*.styl').on('change', () => {
+    chokidar.watch('./css/**/*.styl', chokidarOptions).on('change', () => {
         try {
             bundleCss()
             emitReload();

client/docker-start-dev.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/dumb-init /bin/sh
+
+# Integrate environment variables
+sed -i "s|__BACKEND__|${BACKEND_HOST}|" \
+    /etc/nginx/nginx.conf
+
+# Start server
+nginx&
+
+# Watch source for changes and build app
+npm run watch -- --polling

client/js/main.js

@@ -3,7 +3,7 @@
 const config = require("./config.js");
 
 if (config.environment == "development") {
-    var ws = new WebSocket("ws://" + location.hostname + ":8080");
+    var ws = new WebSocket("ws://" + location.hostname + ":8081");
     ws.addEventListener("open", function (event) {
         console.log("Live-reloading websocket connected.");
     });

doc/API.md

@@ -789,7 +789,7 @@ data.
     | `fav-time`           | alias of `fav-date`                                                                                                                     |
     | `feature-date`       | featured at given date                                                                                                                  |
     | `feature-time`       | alias of `feature-time`                                                                                                                 |
-    | `safety`             | having given safety. `<value>` can be either `safe`, `sketchy` (or `questionable`) or `unsafe`.                                         |
+    | `safety`             | having given safety. `<value>` can be either `safe`, `sketchy` or `unsafe`.                                         |
     | `rating`             | alias of `safety`                                                                                                                       |
 
     **Sort style tokens**

doc/INSTALL.md

@@ -1,5 +1,5 @@
-This assumes that you have Docker (version 17.05 or greater)
-and Docker Compose (version 1.6.0 or greater) already installed.
+This assumes that you have Docker (version 19.03 or greater)
+and the Docker Compose CLI (version 1.27.0 or greater) already installed.
 
 ### Prepare things
 
@@ -38,7 +38,7 @@ and Docker Compose (version 1.6.0 or greater) already installed.
 
     This pulls the latest containers from docker.io:
     ```console
-    user@host:szuru$ docker-compose pull
+    user@host:szuru$ docker compose pull
     ```
 
     If you have modified the application's source and would like to manually
@@ -49,17 +49,17 @@ and Docker Compose (version 1.6.0 or greater) already installed.
 
     For first run, it is recommended to start the database separately:
     ```console
-    user@host:szuru$ docker-compose up -d sql
+    user@host:szuru$ docker compose up -d sql
     ```
 
     To start all containers:
     ```console
-    user@host:szuru$ docker-compose up -d
+    user@host:szuru$ docker compose up -d
     ```
 
     To view/monitor the application logs:
     ```console
-    user@host:szuru$ docker-compose logs -f
+    user@host:szuru$ docker compose logs -f
     # (CTRL+C to exit)
     ```
 
@@ -84,13 +84,13 @@ and Docker Compose (version 1.6.0 or greater) already installed.
 2. Build the containers:
 
     ```console
-    user@host:szuru$ docker-compose build
+    user@host:szuru$ docker compose build
     ```
 
     That will attempt to build both containers, but you can specify `client`
     or `server` to make it build only one.
 
-    If `docker-compose build` spits out:
+    If `docker compose build` spits out:
 
     ```
     ERROR: Service 'server' failed to build: failed to parse platform : "" is an invalid component of "": platform specifier component must match "^[A-Za-z0-9_-]+$": invalid argument
@@ -102,7 +102,7 @@ and Docker Compose (version 1.6.0 or greater) already installed.
     user@host:szuru$ export DOCKER_BUILDKIT=1; export COMPOSE_DOCKER_CLI_BUILD=1
     ```
 
-    ...and run `docker-compose build` again.
+    ...and run `docker compose build` again.
 
 *Note: If your changes are not taking effect in your builds, consider building
 with `--no-cache`.*
@@ -117,7 +117,7 @@ with `--no-cache`.*
     run from docker:
 
     ```console
-    user@host:szuru$ docker-compose run server ./szuru-admin --help
+    user@host:szuru$ docker compose run server ./szuru-admin --help
     ```
 
     will give you a breakdown on all available commands.

docker-compose.dev.yml

@@ -0,0 +1,58 @@
+version: "2"
+
+services:
+  server:
+    build:
+      context: ./server
+      target: development
+    depends_on:
+      - sql
+    environment:
+      ## These should be the names of the dependent containers listed below,
+      ## or FQDNs/IP addresses if these services are running outside of Docker
+      POSTGRES_HOST: sql
+      ## Credentials for database:
+      POSTGRES_USER:
+      POSTGRES_PASSWORD: ## Commented Values are Default:
+
+      #POSTGRES_DB: defaults to same as POSTGRES_USER
+      #POSTGRES_PORT: 5432
+      #LOG_SQL: 0 (1 for verbose SQL logs)
+      DEBUG: 1
+      WAIT_FOR_CLIENT: 0
+    volumes:
+      - "data:/data"
+      - "./server/:/opt/app/"
+    ports:
+      - "5678:5678"
+
+  client:
+    build:
+      context: ./client
+      target: development
+    depends_on:
+      - server
+    environment:
+      BACKEND_HOST: server
+      BASE_URL:
+    volumes:
+      - "data:/data:ro"
+      - "./client/:/opt/app/"
+      - "/opt/app/public/"
+    ports:
+      - "${PORT}:80"
+      # Port 8081 is used for the live-reload when the source code is changed.
+      - "8081:8081"
+
+  sql:
+    image: postgres:11-alpine
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER:
+      POSTGRES_PASSWORD:
+    volumes:
+      - "sql:/var/lib/postgresql/data"
+
+volumes:
+  data:
+  sql:

docker-compose.yml

@@ -1,9 +1,7 @@
 ## Example Docker Compose configuration
 ##
-## Use this as a template to set up docker-compose, or as guide to set up other
+## Use this as a template to set up docker compose, or as guide to set up other
 ## orchestration services
-version: '2'
-
 services:
 
   server:

server/Dockerfile

@@ -61,6 +61,35 @@ ENTRYPOINT ["pytest", "--tb=short"]
 CMD ["szurubooru/"]
 
 
+FROM prereqs as development
+WORKDIR /opt/app
+
+ARG PUID=1000
+ARG PGID=1000
+
+RUN apk --no-cache add \
+    dumb-init \
+    py3-pip \
+    py3-setuptools \
+    py3-waitress \
+    && pip3 install --no-cache-dir --disable-pip-version-check \
+    hupper \
+    debugpy \
+    && mkdir -p /opt/app /data \
+    && addgroup -g ${PGID} app \
+    && adduser -SDH -h /opt/app -g '' -G app -u ${PUID} app \
+    && chown -R app:app /opt/app /data
+
+USER app
+CMD ["/opt/app/docker-start-dev.sh"]
+
+ARG PORT=6666
+ENV PORT=${PORT}
+EXPOSE ${PORT}
+
+VOLUME ["/data/"]
+
+
 FROM prereqs as release
 WORKDIR /opt/app
 

server/docker-start-dev.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/dumb-init /bin/sh
+set -e
+cd /opt/app
+
+alembic upgrade head
+
+echo "Starting szurubooru API on port ${PORT}"
+exec hupper -m waitress --port ${PORT} szurubooru.facade:app

server/szurubooru/facade.py

@@ -162,4 +162,18 @@ def create_app() -> Callable[[Any, Any], Any]:
     return rest.application
 
 
+if int(os.getenv("DEBUG", 0)) != 0:
+    try:
+        import debugpy
+    except ModuleNotFoundError:
+        raise RuntimeError("debugpy is not installed")
+
+    # TODO: These print statements don't show up in our docker output. Why is that?
+    logging.info("debugpy listening on port 5678")
+    debugpy.listen(("0.0.0.0", 5678))
+
+    if int(os.getenv("WAIT_FOR_CLIENT", 0)) != 0:
+        logging.info("Waiting for debugger attach")
+        debugpy.wait_for_client()
+
 app = create_app()