Portainer Templates logo

Portainer Templates

AFFiNE AFFiNE

Stack

DocumentsProductivityWiki

Workspace that mixes docs, whiteboards and databases, so a page can flip between writing and an endless canvas. Edits sync to this server as you type. Source: https://github.com/toeverything/AFFiNE

Source details

Repo: toeverything/AFFiNE
Stars: 73.6k
Forks: 5k
Language: TypeScript
Latest: v0.27.4 · 1 month ago
Updated: 4 days ago
Website: affine.pro/

Configuration

Type
Compose
Platform
linux
Env vars
AFFINE_PORT=3010
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Open http://<your-host>:3010 (or whichever port you picked). The first start takes a minute while it sets up the database, then it asks you to create the admin account, and whoever gets there first does, so do it straight away. The workspace it opens is only saved in your browser, so make a new one from the workspace menu (it goes on this server by default) and keep your docs there. In the admin panel at /admin, set the External URL under Settings --> Server to the address people actually use, or invite links point at localhost. New accounts can't invite anyone or make share links for their first 24 hours, which you can change under Settings --> Auth. Sign-ups need email (Settings --> Notification), so until then add people yourself under Accounts. Docs live in Postgres, in the postgres-data volume, uploads in affine-storage, and the server's own key in affine-config. Docs: docs.affine.pro

Services

affine

Configuration

Image
ghcr.io/toeverything/affine:stable
Command
sh,-c,node ./scripts/self-host-predeploy.js && exec node ./dist/main.js
Ports
${AFFINE_PORT:-3010}:3010
Volumes
/root/.affine/storage : affine-storage/root/.affine/config : affine-config
Env vars
DATABASE_URL=postgresql://affine@postgres:5432/affineREDIS_SERVER_HOST=redisDEPLOYMENT_TYPE=selfhosted
Restart
unless-stopped

Image details

User: toeverything

postgres

Configuration

Image
pgvector/pgvector:pg16
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=affinePOSTGRES_USER=affinePOSTGRES_HOST_AUTH_METHOD=trustPOSTGRES_INITDB_ARGS=--data-checksums
Restart
unless-stopped

Image details

Pulls: 246.3M
User: pgvector
Created: Jan 29, 2024
Updated: 14 days ago
Status: active

redis

Configuration

Image
redis:8-alpine
Restart
unless-stopped

Image details

Pulls: 11.5B
User: stackbrew
Created: Jun 05, 2014
Updated: 8 days ago
Status: active

Standalone Install

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

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 AFFiNE, 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:
  affine:
    image: ghcr.io/toeverything/affine:stable
    restart: unless-stopped
    command: ["sh", "-c", "node ./scripts/self-host-predeploy.js && exec node ./dist/main.js"]
    ports:
      - "${AFFINE_PORT:-3010}:3010"
    environment:
      DATABASE_URL: postgresql://affine@postgres:5432/affine
      REDIS_SERVER_HOST: redis
      DEPLOYMENT_TYPE: selfhosted
    volumes:
      - affine-storage:/root/.affine/storage
      - affine-config:/root/.affine/config
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy

  postgres:
    image: pgvector/pgvector:pg16
    restart: unless-stopped
    environment:
      POSTGRES_DB: affine
      POSTGRES_USER: affine
      POSTGRES_HOST_AUTH_METHOD: trust
      POSTGRES_INITDB_ARGS: --data-checksums
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U affine -d affine"]
      interval: 10s
      timeout: 5s
      retries: 5

  redis:
    image: redis:8-alpine
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  affine-storage:
  affine-config:
  postgres-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/affine/compose.yml up -d

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

Container Documentation

postgres Documentation

Open-source vector similarity search for Postgres

redis Documentation

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

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.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/toeverything/affine:stable

  • "manifest unknown" means the tag no longer exists.
  • "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

AFFiNE 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:

  • affine runs ghcr.io/toeverything/affine:stable, starts after postgres, redis
  • postgres runs pgvector/pgvector:pg16
  • redis runs redis:8-alpine

Volumes

A volume is where AFFiNE 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:

  • /root/.affine/storage kept in the affine-storage volume Docker manages
  • /root/.affine/config kept in the affine-config volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages

Environment variables

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

  • DATABASE_URL, defaults to postgresql://affine@postgres:5432/affine
  • REDIS_SERVER_HOST, defaults to redis
  • DEPLOYMENT_TYPE, defaults to selfhosted
  • POSTGRES_DB, defaults to affine
  • POSTGRES_USER, defaults to affine
  • POSTGRES_HOST_AUTH_METHOD, defaults to trust
  • POSTGRES_INITDB_ARGS, defaults to --data-checksums

Restart policy

The restart policy here is unless-stopped, so Docker restarts AFFiNE 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 affine) 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.

Portainer app templates

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