Getting started

Before you begin

You need access to this distribution's source checkout and a working Docker build environment. Run the following from the repository root. The image is built locally; it is not an upstream registry image. The named volume keeps application data when the container is replaced.

docker build -f scripts/Dockerfile -t memos:local .
docker volume create memos-data
docker run -d --name memos \
  -p 127.0.0.1:5230:5230 \
  -v memos-data:/var/opt/memos \
  memos:local
curl --fail http://127.0.0.1:5230/healthz

Make the first connection

Open http://127.0.0.1:5230 in your browser. A fresh database reports that setup is needed; finish the first-account flow before exposing the service to a network. An existing database keeps its users. Write a test memo, reload the page, and confirm it is still there. This procedure is for a new local instance; the hosted workspace does not offer public registration.

Next steps

Keep the data volume, review Docker deployment, and set up a backup before moving valuable notes. Do not use demo mode for private data. For native development, the binary defaults to port 8081; the packaged container sets port 5230.