dnote/SELF_HOSTING.md

Self-Hosting Dnote Server

Please see the doc for more.

Docker Installation

1. Install Docker.
2. Install Docker Compose plugin.
3. Download the compose.yml file by running:

curl https://raw.githubusercontent.com/dnote/dnote/master/host/docker/compose.yml > compose.yml

4. Run the following to download the images and run the containers

docker compose pull
docker compose up -d

Visit http://localhost:3001 in your browser to see Dnote running.

Supported platform

Currently, the official Docker image for Dnote supports Linux running AMD64 CPU architecture.

If you run ARM64, please install Dnote server by downloading a binary distribution (see below).

Manual Installation

Download from releases, extract, and run:

tar -xzf dnote-server-$version-$os.tar.gz
mv ./dnote-server /usr/local/bin
dnote-server start --webUrl=https://your.server

You're up and running. Database: ~/.local/share/dnote/server.db (customize with --dbPath). Run dnote-server start --help for options.

Set apiEndpoint: https://your.server/api in ~/.config/dnote/dnoterc to connect your CLI to the server.