Portainer Templates logo

Portainer Templates

Docmost Docmost

Stack

DocumentationProductivity

Open source collaborative wiki and documentation software, an alternative to Confluence and Notion. Source: https://github.com/docmost/docmost

Source details

Repo: docmost/docmost
Stars: 21.4k
Forks: 2k
Language: TypeScript
License: AGPL-3.0
Latest: v0.95.0 · 1 month ago
Updated: 6 hours ago
Website: docmost.com/

Configuration

Type
Compose
Platform
linux
Env vars
APP_URL=http://localhost:3000APP_SECRET=
Source
Repo

Source

Notes

Generate APP_SECRET with 'openssl rand -hex 32' (must be at least 32 chars). Set APP_URL to the address you access Docmost from.

Services

docmost

Configuration

Image
docmost/docmost:latest
Ports
3000:3000
Volumes
/app/data/storage : docmost-data
Env vars
APP_URL=${APP_URL:-http://localhost:3000}APP_SECRET=${APP_SECRET}DATABASE_URL=postgresql://docmost:docmost@postgres:5432/docmost?sslmode=disableREDIS_URL=redis://redis:6379
Restart
unless-stopped

Image details

Pulls: 4.5M
User: docmost
Created: Jun 28, 2024
Updated: 1 day ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=docmostPOSTGRES_USER=docmostPOSTGRES_PASSWORD=docmost
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 37 minutes ago
Status: active

redis

Configuration

Image
redis:7-alpine
Command
redis-server,--appendonly,yes,--maxmemory-policy,noeviction
Volumes
/data : redis-data
Restart
unless-stopped

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Docmost

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Docmost, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  docmost:
    image: docmost/docmost:latest
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - APP_URL=${APP_URL:-http://localhost:3000}
      # APP_SECRET must be at least 32 chars — generate with: openssl rand -hex 32
      - APP_SECRET=${APP_SECRET}
      - DATABASE_URL=postgresql://docmost:docmost@postgres:5432/docmost?sslmode=disable
      - REDIS_URL=redis://redis:6379
    volumes:
      - docmost-data:/app/data/storage
    depends_on:
      - postgres
      - redis

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_DB=docmost
      - POSTGRES_USER=docmost
      - POSTGRES_PASSWORD=docmost
    volumes:
      - postgres-data:/var/lib/postgresql/data

  redis:
    image: redis:7-alpine
    restart: unless-stopped
    command: ["redis-server", "--appendonly", "yes", "--maxmemory-policy", "noeviction"]
    volumes:
      - redis-data:/data

volumes:
  docmost-data:
  postgres-data:
  redis-data:

Or deploy it directly from the source:

git clone https://github.com/lissy93/portainer-templates
cd portainer-templates
docker compose -f sources/stacks/docmost.yml up -d

More install options in our documentation, or see docmost/docmost for app-specific guidance.

Container Documentation

docmost Documentation

Open-source collaborative wiki and documentation software

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

Serve Docmost on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying docmost.example.com to http://docmost:3000

Add this to your Caddyfile

docmost.example.com {
	reverse_proxy http://docmost:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3000
  • Stop the other service, or pick a different host port. In 3000:3000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, docmost can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Image won't pull

Test the pull directly on the host: docker pull docmost/docmost:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Docmost is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • docmost runs docmost/docmost:latest, starts after postgres, redis
  • postgres runs postgres:17-alpine
  • redis runs redis:7-alpine

Ports

A port is the door the app answers on. A mapping like 3000:3000 means it's reachable on port 3000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:

  • 3000:3000, likely the web interface

Volumes

A volume is where Docmost keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /app/data/storage kept in the docmost-data volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages
  • /data kept in the redis-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Docmost takes 7 of them, all with defaults you can leave alone or tweak:

  • APP_URL, defaults to http://localhost:3000
  • APP_SECRET, pulled from your own environment
  • DATABASE_URL, defaults to postgresql://docmost:docmost@postgres:5432/docmost?sslmode=disable
  • REDIS_URL, defaults to redis://redis:6379
  • POSTGRES_DB, defaults to docmost
  • POSTGRES_USER, defaults to docmost
  • POSTGRES_PASSWORD, defaults to docmost

Restart policy

The restart policy here is unless-stopped, so Docker restarts Docmost after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like docmost) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Docmost is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Docmost up. Add the template list to Portainer once, then deploying Docmost is a click rather than a wall of config.