01 - Install

Docker (Official)

Both the backend and frontend are distributed by as Docker images, making deployment consistent. Using the all-in-one image may be preferred as everything is bundled together.

Stuck? Watch the demo video.

Below are the image names:

ghcr.io/enchant97/note-mark-backend

ghcr.io/enchant97/note-mark-frontend

ghcr.io/enchant97/note-mark-aio

The following labels are available:

TIP Image labels follow Semantic Versioning

<major>

<major>.<minor>

<major>.<minor>.<patch>

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

# file: docker-compose.yml
version: "3"

volumes:
  data:

services:
  note-mark:
    image: ghcr.io/enchant97/note-mark-aio:0.13.0

    restart: unless-stopped
    volumes:
      - data:/data
    environment:
      # !!! REPLACE These !!!
      JWT_SECRET: "bXktc2VjcmV0"
      CORS_ORIGINS: "http://example.com:8000"
    ports:
      - 8000:8000

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 the Dockerfile’s perform.