Install

Net-Doc is distributed as a docker container.

Docker Compose

The tag latest will always pull the latest release, main will pull the latest commit to the main branch. Ideally you should use the major version tag e.g. 2 to avoid automatically installing any breaking changes. 2 would include any 2.x.y release.

x-shared:
  net-doc-service: &net-doc-service
    environment: &net-doc-environment
      - PASSWORD_KEY=YOUR KEY
      - PASSWORD_SALT=YOUR SALT
      - PASSWORD_IV=YOUR IV
      - DATABASE_URL=file:./data/net-doc.db
      - REDIS_URL=net-doc-redis:6379
    volumes: &net-doc-volumes
      - ./db:/app/prisma/data
      - ./uploads:/app/public/uploads
      - ./backups:/app/public/backups
    image: longridgehighschool/net-doc:2
    restart: always
    depends_on:
      - net-doc-redis

services:
  net-doc-remix:
    <<: *net-doc-service
    command: ['net-doc-remix']

  net-doc-worker:
    <<: *net-doc-service
    command: ['net-doc-worker']
    depends_on:
      - net-doc-remix

  net-doc-nginx:
    <<: *net-doc-service
    command: ['net-doc-nginx']
    depends_on:
      - net-doc-remix
    ports:
      - '8080:80'

  net-doc-redis:
    image: redis:7
    restart: always
    volumes:
      - ./data/redis:/data

Environment Variables

Variable	Value
`PASSWORD_KEY`	Your unique Password Key. Used to encrypt the passwords stored in the database.
`PASSWORD_SLAT`	Your unique Password Salt. Used to salt the value for encryption of passwords in the database.
`PASSWORD_IV`	The initiation vector for your password encryption. Needs to be a 16 Character HEX Value.
`DATABASE_URL`	The file path to your database. Should be `file:./data/something.db` so that the data is stored on the host

Volumes

Container Path	Purpose
`/app/prisma/data`	Contains the sqlite database
`/app/public/uploads`	Attachments are uploaded here.
`/app/public/backups`	Contains the generated backup files

Launching

With the docker-compose.yml in a folder with the paths updated you can then pull the images.

docker compose pull

Once the images are pulled you can launch net-doc by running:

docker compose up -d

This will create a new docker container running the Net-Doc image, and the redis image.

Every time Net-Doc starts up it runs all the prisma migrations to intially create the database and keep it in sync. The same process also runs the seed command which will update any data in the database to match the new schema.