Self-host flatnotes with Levelrail

Verified

A database-less note-taking app that keeps notes as plain Markdown files.

  • AuthordullageVerified by Levelrail
  • LicenceMIT
  • Memory128 MiB
  • Archarm64
  • Services1

How to self-host flatnotes

  1. Pull the images

    One image is pulled on your server.

    Show images
    • dullage/flatnotes:v5.5.5
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on port 8080.

  3. Fill in the secrets

    2 secrets are generated and stored encrypted, 2 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

flatnotes requirements

Memory
About 128 MiB
Architectures
amd64 image published, arm64 tested
Ports
8080
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Verified. Verified on arm64 with image tag v5.5.5. Our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 8080 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then flatnotes. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the flatnotes docs page.

Deploy flatnotes your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy flatnotes from the CLI

levelrail-cli templates deploy flatnotes --name my-flatnotes

Deploy flatnotes with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/flatnotes/deploy

flatnotes configuration

flatnotes services

ServiceImagePortsVolumes
flatnotes dullage/flatnotes:v5.5.5 8080 flatnotes_data -> /data

flatnotes environment variables

VariableServiceValue
FLATNOTES_AUTH_TYPE flatnotes Preset by the template
FLATNOTES_PASSWORD flatnotes Generated at deploy
FLATNOTES_SECRET_KEY flatnotes Generated at deploy
FLATNOTES_USERNAME flatnotes Preset by the template

Ports and volumes

Ports
8080
Volumes
1 named mount: flatnotes_data -> /data

flatnotes FAQ

How much memory does flatnotes need?

The catalog lists about 128 MiB of memory for flatnotes.

Does flatnotes run on arm64?

For flatnotes, arm64 is tested; amd64 is image published.

What licence is flatnotes under?

flatnotes is licensed under MIT, which is permissive, with few conditions on reuse.

Does flatnotes need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does flatnotes use?

flatnotes listens on port 8080 inside the stack.

Where does flatnotes keep its data?

In a named volume: flatnotes_data mounted at /data.

Can I deploy flatnotes on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id flatnotes for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image dullage/flatnotes:v5.5.5 is what you deploy there.

levelrail-cli templates deploy flatnotes --name my-flatnotes