Merge pull request #137 from MaddyGuthridge/maddy-prisma

Improve docker file layouts

Author: MaddyGuthridge

.github/workflows/docker-publish.yml

@@ -37,7 +37,7 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           context: .
-          file: ./Dockerfile
+          file: ./docker/production.dockerfile
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

docker/dev.docker-compose.yml

@@ -0,0 +1,61 @@
+# Minifolio -- dev.docker-compose.yml
+# ===================================
+#
+# This file defines a docker-compose image suitable for development.
+#
+# Data paths
+# ----------
+# * The data directory will be set up inside `./data` on the host system
+# * The private_data directory will be set up inside `./private_data` on the
+#   host system.
+#
+# Running:
+# --------
+# From the root of the repository, run:
+#
+#     docker compose -f docker/dev.docker-compose.yml up
+#
+# Testing:
+# --------
+#
+# If you really want to, you might be able to use this to do development
+# without actually installing the things you need to work on Minifolio (node,
+# etc). You probably shouldn't though.
+#
+# Note: test suite is currently broken under docker due to inability to remove
+# data dir.
+#
+# Run test suite:
+#     docker compose -f docker/dev.docker-compose.yml exec minifolio npm t
+#
+# Run type-checking:
+#     docker compose -f docker/dev.docker-compose.yml exec minifolio npm run check
+#
+# Run linting:
+#     docker compose -f docker/dev.docker-compose.yml exec minifolio npm run lint
+#
+
+services:
+  minifolio:
+    build:
+      context: ".."
+      dockerfile: "docker/dev.dockerfile"
+      ssh:
+        - default
+
+    hostname: minifolio-dev
+    restart: always
+    ports:
+      - 127.0.0.1:5096:5096/tcp
+    volumes:
+      - "../data:/data:rw"
+      - "../private_data:/private_data:rw"
+
+    environment:
+      HOST: "0.0.0.0"
+      PORT: 5096
+      DATA_REPO_PATH: "/data"
+      PRIVATE_DATA_PATH: "/private_data"
+      # Request body has max size of 10 MB. Adjust as needed
+      # https://svelte.dev/docs/kit/adapter-node#Environment-variables-BODY_SIZE_LIMIT
+      BODY_SIZE_LIMIT: 10M

docker/dev.dockerfile

@@ -0,0 +1,43 @@
+# docker/dev.dockerfile
+# =====================
+#
+# Dockerfile for running the server in dev mode
+
+FROM node:22
+
+# Make volumes be owned by the node user
+RUN mkdir /data
+RUN chown node:node /data
+RUN mkdir /private_data
+RUN chown node:node /private_data
+
+# Install Git and SSH
+RUN apt install -y openssh-client git
+
+USER node
+
+WORKDIR /home/node/app
+
+# Dependencies
+COPY .npmrc .
+COPY package.json .
+COPY package-lock.json .
+RUN npm ci
+
+# Configuration
+COPY vite.config.ts .
+COPY svelte.config.js .
+COPY tsconfig.json .
+
+# Source code
+COPY src src
+COPY tests tests
+COPY static static
+
+RUN ls -al /home/node/app
+
+RUN ["npm", "run", "sync"]
+
+EXPOSE 5096
+
+ENTRYPOINT [ "npm", "run", "dev" ]

docker-compose.yml renamed to docker/production-source.docker-compose.yml

@@ -1,28 +1,36 @@
-# Minifolio
-# Example docker-compose.yml
+# Minifolio -- production-source.docker-compose.yml
+# ==========================================
+#
+# Example docker-compose.yml for production, but built from source.
+#
+# Data paths
+# ----------
 #
-# Usage:
 # * The data directory will be set up inside `./data` on the host system
 # * The private_data directory will be set up inside `./private_data` on the
 #   host system.
+#
+# Running:
+# --------
+#
+# From the root of the repository, run:
+#
+#     docker compose -f docker/production-source.docker-compose.yml up
+
 services:
   minifolio:
-    # To build from the local repo, rather than the latest published version:
-    # Comment out this line
-    image: maddyguthridge/minifolio
-    # And uncomment these lines
-    # build:
-    #   context: .
-    #   ssh:
-    #     - default
+    build:
+      context: .
+      ssh:
+        - default
 
     hostname: minifolio
     restart: always
     ports:
       - 127.0.0.1:3000:3000/tcp
     volumes:
-      - "./data:/data:rw"
-      - "./private_data:/private_data:rw"
+      - "../data:/data:rw"
+      - "../private_data:/private_data:rw"
 
     environment:
       DATA_REPO_PATH: "/data"

docker/production.docker-compose.yml

@@ -0,0 +1,42 @@
+# Minifolio -- production.docker-compose.yml
+# ==========================================
+#
+# Example docker-compose.yml for production
+#
+# Data paths
+# ----------
+#
+# * The data directory will be set up inside `./data` on the host system
+# * The private_data directory will be set up inside `./private_data` on the
+#   host system.
+#
+# Note that you may need to adjust these paths if you copy this file out from
+# this repo, since it is written so it works nicely when located inside of the
+# `docker/` directory.
+#
+# Running:
+# --------
+#
+# From the root of the repository, run:
+#
+#     docker compose -f docker/production.docker-compose.yml up
+
+services:
+  minifolio:
+    image: maddyguthridge/minifolio
+    hostname: minifolio
+    restart: always
+    ports:
+      - 127.0.0.1:5097:3000/tcp
+    volumes:
+      - "../data:/data:rw"
+      - "../private_data:/private_data:rw"
+
+    environment:
+      DATA_REPO_PATH: "/data"
+      PRIVATE_DATA_PATH: "/private_data"
+      HOST: 0.0.0.0
+      PORT: 3000
+      # Request body has max size of 10 MB. Adjust as needed
+      # https://svelte.dev/docs/kit/adapter-node#Environment-variables-BODY_SIZE_LIMIT
+      BODY_SIZE_LIMIT: 10M

Dockerfile renamed to docker/production.dockerfile

@@ -1,3 +1,8 @@
+# docker/staging.dockerfile
+# =====================
+#
+# Dockerfile for running the server in production mode.
+
 FROM node:22
 
 # Make volumes be owned by the node user