Running as Docker Container

WARNING

Docker is in an early phase and may contain bugs or a suboptimal solution

• creating the image
• running
  • running with docker
  • running with docker-compose

creating the image

copy this code into a file named Dockerfile

Dockerfile

FROM python:3.10-slim

ARG JARKLIN_SRC="https://github.com/jarklin/jarklin-server/releases/download/latest/jarklin.tgz"
ARG WEB_SRC="https://github.com/jarklin/jarklin-web/releases/download/latest/web-ui.tgz"
ARG FILES="/files/"
ARG PORT=5000

RUN apt-get update \
    && apt-get install -y --no-install-recommends ffmpeg wget

# /opt/jarklin/ will be the result
WORKDIR /opt/

# downloading newest versions
RUN wget "$JARKLIN_SRC" -O "jarklin.tgz"
RUN wget "$WEB_SRC" -O "web-ui.tgz"

# extract jarklin
RUN tar -xf "jarklin.tgz" -C . \
    && rm "jarklin.tgz"
# extract web-ui
RUN tar -xf "web-ui.tgz" -C "jarklin/web/web-ui/" \
    && rm "web-ui.tgz"
# install dependencies
RUN pip install -r "jarklin/requirements.txt" --disable-pip-version-check

# default port from flask
EXPOSE $PORT/tcp

# source files and config location
WORKDIR "$FILES"

ENTRYPOINT ["/opt/jarklin/jarklin"]
# default arguments, un-comment if per default the web server should be started
#CMD ["web", "run"]

Then you can create the image. (This may take a while)

docker build -t jarklin .

WARNING

in order to access the server you need to set host to 0.0.0.0 and the port to 5000

.jarklin.yaml

web:
  server:
    host: "0.0.0.0"
    port: 5000

running

running with docker

# starting the web server
docker run -d --rm --publish 5000:5000 --mount type=bind,source="$(pwd)",target="/files/" jarklin web run
# starting the cache generation
docker run -d --rm --publish 5000:5000 --mount type=bind,source="$(pwd)",target="/files/" jarklin cache run

• -d: detach, don't block the terminal (remove this option to verify it can start. but you need another terminal to stop it)
• --rm: removes container after stopping
• --publish: connects container port to host port
• --mount: mounts your host directory into the container
• jarklin: image name

running with docker-compose

version: "3.8"
services:
  web:
    image: jarklin
    command: web run
    container_name: jarklin web
    volumes:
      - ./:/files/:ro
    ports:
      - "5000:5000"
    restart: unless-stopped
  cache:
    image: jarklin
    command: cache run
    container_name: jarklin cache
    volumes:
      - ./:/files/
    restart: unless-stopped