Portainer Templates logo

Portainer Templates

Kaneo Kaneo

Stack

Project ManagementProductivity

Project management for small teams: kanban boards, a backlog, Gantt charts, labels, time tracking and GitHub, GitLab or Gitea issue sync, in workspaces you invite people into. Source: https://github.com/usekaneo/kaneo

Source details

Repo: usekaneo/kaneo
Stars: 10k
Forks: 916
Language: TypeScript
License: MIT
Latest: v2.48.0 · 2 days ago
Updated: 7 hours ago
Website: kaneo.app/

Configuration

Type
Compose
Platform
linux
Env vars
KANEO_URL=''KANEO_SECRET=''KANEO_DB_PASSWORD=''KANEO_PORT=5173
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in the address, secret key and database password before you deploy, since the stack won't start without them (openssl rand -hex 32 makes a good secret and password), and keep the last two the same when you redeploy. The address has to be exactly what you'll type in the browser, like http://192.168.1.20:5173: the port you're using, and no slash at the end. Your browser reaches Kaneo through that address, so if it's wrong every page just says Something went wrong!. To fix it, change the address in the stack's environment variables and redeploy. Then open it straight away, as the first account made becomes the instance admin. After that anyone who can reach it can sign up, or carry on as a guest, and get a workspace of their own (they can't see yours), so once your people are in, add KANEO_DISABLE_REGISTRATION set to true to the stack's environment variables and redeploy. Invite people from the sidebar: with no email set up you get a link to send them, and it still works with sign-ups closed. Personal ntfy, Gotify and webhook notifications need a KANEO_NOTIFICATION_KEY (another openssl rand -hex 32) added the same way. File uploads in tasks and comments need S3-compatible storage, which this stack doesn't include. Everything else lives in Postgres, in the postgres-data volume. Docs: kaneo.app/docs

Services

kaneo

Configuration

Image
ghcr.io/usekaneo/kaneo:2
Ports
${KANEO_PORT:-5173}:5173
Env vars
KANEO_CLIENT_URL=${KANEO_URL:?Set the address you'll open it on}AUTH_SECRET=${KANEO_SECRET:?Set a secret key}POSTGRES_DB=kaneoPOSTGRES_USER=kaneoPOSTGRES_PASSWORD=${KANEO_DB_PASSWORD:?Set a database password}POSTGRES_HOST=postgresDISABLE_REGISTRATION=${KANEO_DISABLE_REGISTRATION:-false}NOTIFICATION_SECRET_ENCRYPTION_KEY=${KANEO_NOTIFICATION_KEY:-}
Restart
unless-stopped

Image details

User: usekaneo

postgres

Configuration

Image
postgres:16-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=kaneoPOSTGRES_USER=kaneoPOSTGRES_PASSWORD=${KANEO_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 12.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 22 hours ago
Status: active

Standalone Install

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

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 Kaneo, 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:
  kaneo:
    image: ghcr.io/usekaneo/kaneo:2
    restart: unless-stopped
    ports:
      - "${KANEO_PORT:-5173}:5173"
    environment:
      KANEO_CLIENT_URL: ${KANEO_URL:?Set the address you'll open it on}
      AUTH_SECRET: ${KANEO_SECRET:?Set a secret key}
      POSTGRES_DB: kaneo
      POSTGRES_USER: kaneo
      POSTGRES_PASSWORD: ${KANEO_DB_PASSWORD:?Set a database password}
      POSTGRES_HOST: postgres
      DISABLE_REGISTRATION: ${KANEO_DISABLE_REGISTRATION:-false}
      NOTIFICATION_SECRET_ENCRYPTION_KEY: ${KANEO_NOTIFICATION_KEY:-}
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:16-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: kaneo
      POSTGRES_USER: kaneo
      POSTGRES_PASSWORD: ${KANEO_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U kaneo -d kaneo"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  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/kaneo/compose.yml up -d

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

Container Documentation

postgres Documentation

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

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/usekaneo/kaneo:2

  • "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

Kaneo is a Compose stack, a set of containers (2 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 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • kaneo runs ghcr.io/usekaneo/kaneo:2, starts after postgres
  • postgres runs postgres:16-alpine

Volumes

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

  • /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. Kaneo takes 8 of them, and 3 need a value before it'll start properly:

  • KANEO_CLIENT_URL, needs a value
  • AUTH_SECRET, needs a value
  • POSTGRES_DB, defaults to kaneo
  • POSTGRES_USER, defaults to kaneo
  • POSTGRES_PASSWORD, needs a value
  • POSTGRES_HOST, defaults to postgres
  • DISABLE_REGISTRATION, defaults to false
  • NOTIFICATION_SECRET_ENCRYPTION_KEY, pulled from your own environment

Restart policy

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

Kaneo is open source, released under the MIT 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 Kaneo up. Add the template list to Portainer once, then deploying Kaneo is a click rather than a wall of config.