Dockerfile

# syntax=docker/dockerfile:1
# The above line is needed for now to allow HEALTHCHECK --start-interval to be parsed
# https://github.com/docker/cli/issues/4486#issuecomment-1671620453

# Build and install Joplin CLI into a first image
# Set build arguments to specify particular versions of node and Joplin
ARG NODE_VERSION=lts
ARG JOPLIN_VERSION=latest
FROM node:${NODE_VERSION}-bookworm-slim as base

FROM base as builder
ARG JOPLIN_VERSION

# Install Joplin as user "node"
USER node
ENV NODE_ENV=production
ENV NPM_CONFIG_PREFIX=/home/node/.joplin-bin
RUN npm -g install "joplin@${JOPLIN_VERSION?}"

# Start again from a clean base image devoid of all the build packages
FROM base as joplin

# Copy built joplin into new image and add it to the PATH
COPY --from=builder --chown=node:node /home/node/.joplin-bin /home/node/.joplin-bin
ENV PATH=$PATH:/home/node/.joplin-bin/bin

# Joplin config directory can be mounted for persistence of config and database
RUN mkdir -p /home/node/.config/joplin && chown node:node /home/node/.config/joplin
VOLUME /home/node/.config/joplin

# Install s6-overlay to enable multiple services in same docker container
# https://github.com/just-containers/s6-overlay
FROM joplin as s6

# Remove any third-party apt sources to avoid issues with expiring keys
RUN rm -f /etc/apt/sources.list.d/*.list

# For apt caching as per https://docs.docker.com/engine/reference/builder/#example-cache-apt-packages
RUN rm -f /etc/apt/apt.conf.d/docker-clean; echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' > /etc/apt/apt.conf.d/keep-cache

# Install curl
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
    --mount=type=cache,target=/var/lib/apt,sharing=locked \
    apt-get update && apt-get --no-install-recommends install -y \
        curl \
        ca-certificates

# Add s6-overlay to run joplin server with proper process 1 / init supervision
# https://github.com/just-containers/s6-overlay
# https://www.troubleshooters.com/linux/execline.htm
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
    --mount=type=cache,target=/var/lib/apt,sharing=locked \
    apt-get update && apt-get --no-install-recommends install -y \
        xz-utils

# Check https://github.com/just-containers/s6-overlay/releases/ to find s6-overlay versions
ARG S6_OVERLAY_VERSION=3.1.5.0
RUN curl -sLO https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-noarch.tar.xz \
 && tar -C / -Jxpf s6-overlay-noarch.tar.xz \
 && rm s6-overlay-noarch.tar.xz
RUN curl -sLO https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-x86_64.tar.xz \
 && tar -C / -Jxpf s6-overlay-x86_64.tar.xz \
 && rm s6-overlay-x86_64.tar.xz

ENTRYPOINT ["/init"]

FROM s6 as release
LABEL org.opencontainers.image.authors="jeff@cusk.io"

# Install some utilities for the release image
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
    --mount=type=cache,target=/var/lib/apt,sharing=locked \
    apt-get update && apt-get --no-install-recommends install -y \
        socat \
        jq \
        vim-tiny

# Set s6-overlay options (see https://github.com/just-containers/s6-overlay/tree/v3.1.5.0#customizing-s6-overlay-behaviour)
# Make environment variables visible to s6 scripts
ENV S6_KEEP_ENV=1
# Increase the timeout (in milliseconds) waiting for s6 services to run/start (0 = infinity)
ENV S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0

# Copy s6-rc files
COPY s6-rc.d /etc/s6-overlay/s6-rc.d

# This variable is used to enable/disable the joplin-log service (see ./s6-rc.d/joplin-log/run)
ENV JOPLIN_LOG_ENABLED="false"

# Create volume for default Joplin sync target via "local" filesystem path
VOLUME [ "/sync" ]
RUN mkdir -p /sync && chown -R node:node /sync

# Run as user "node"
WORKDIR /home/node
USER node

# Set default Joplin JSON config, imported by joplin-config s6 script (see ./s6-rc.d/joplin-config/up)
ENV JOPLIN_CONFIG_DEFAULTS_JSON=/home/node/joplin-config-defaults.json
COPY <<EOF ./joplin-config-defaults.json
{
    "api.token": "mytoken",
    "editor": "vi",
    "sync.interval": 0,
    "sync.maxConcurrentConnections": 5,
    "sync.resourceDownloadMode": "manual",
    "sync.wipeOutFailSafe": true
}
EOF

# Set optional Joplin JSON config to empty dictionary
ENV JOPLIN_CONFIG_JSON=/run/secrets/joplin-config.json
COPY <<EOF /run/secrets/joplin-config.json
{}
EOF

# Set required Joplin JSON config overrides
ENV JOPLIN_CONFIG_REQUIRED_JSON=/home/node/joplin-config-required.json
COPY <<EOF ./joplin-config-required.json
{
    "api.port": 41184,
    "sync.interval": 0
}
EOF

# Fix tty issues in vim with "set nocompatible"
COPY <<EOF ./.vimrc
set nocompatible
EOF

# Run joplin server as daemon
CMD ["joplin", "server", "start"]

# Expose socat external port being forwarded to Joplin clipper server
EXPOSE 80/tcp

# Test health of Joplin Clipper server with periodic GET /ping
HEALTHCHECK --interval=30s --retries=1 --timeout=5s --start-interval=5s --start-period=30s \
     CMD curl -s http://localhost/ping | jq -R -e '. == "JoplinClipperServer"'