01 - Install

Docker (Official)

Note Mark is installed by using the all-in-one image, making deployment easier and more consistent.

Stuck? Watch the demo video.

Pre-Built Image

Below is the image name:

ghcr.io/enchant97/note-mark-aio

The following labels are available:

TIP Image labels follow Semantic Versioning

<major>

<major>.<minor>

<major>.<minor>.<patch>

IMPORTANT: The latest label is deprecated and does not get updated

Build Your Own

This may take some time depending on your internet and processor speed (about 15 mins on RPI 4).

git clone --depth 1 --branch v0.17.1 https://github.com/enchant97/note-mark.git note-mark-0.17.1 && \
cd note-mark-0.17.1 && \
docker build -t note-mark:0.17.1 -f docker/Dockerfile .

Basic Config

Here is an example to deploy though Docker Compose, using the all-in-one image.

# file: docker-compose.yml
volumes:
  data:

services:
  note-mark:
    image: ghcr.io/enchant97/note-mark-aio:0.17.1
    restart: unless-stopped
    volumes:
      - data:/data
    environment:
      JWT_SECRET: "!!! REPLACE ME !!!"
      CORS_ORIGINS: "http://example.com"
    ports:
      - 80:8080

For further configuration, click here.

TIP A reverse proxy is recommended so a FQDN can be used and tls can be setup to secure the traffic

TIP Take a look at the example deployments

Bare

Not officially supported, but you should be able to follow the steps that Docker build performs, find the Dockerfile in: docker/Dockerfile.