Portainer Templates logo

Portainer Templates

NocoBase NocoBase

Stack

DatabaseProductivity

No-code platform for building internal tools and business apps: define your own data tables and relations, then build pages, forms, kanbans and calendars on top, with roles, permissions and workflows. Source: https://github.com/nocobase/nocobase

Source details

Repo: nocobase/nocobase
Stars: 24.6k
Forks: 3k
Language: TypeScript
Latest: v2.2.27 · 2 days ago
Updated: 3 minutes ago
Website: www.nocobase.com/

Configuration

Type
Compose
Platform
linux
Env vars
NOCOBASE_ADMIN_PASSWORD=''NOCOBASE_DB_PASSWORD=''NOCOBASE_PORT=13000
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Set both passwords before you deploy, since the stack won't start without them. The first start installs everything and takes a minute or two (the log shows a few APP_COMMANDING errors while it does, which is normal). Then open http://<your-host>:13000 (or whichever port you picked) and sign in as [email protected] with your admin password. Changing that password on the form later does nothing, so use Change password in the user menu at the top right instead. Anyone who can reach it can sign up, and new accounts see nothing until you give their role some permissions. To stop sign-ups, untick Allow to sign up under Settings --> Authentication --> basic --> Configure. Uploads and its generated keys live in the nocobase-storage volume, everything else in postgres-data. Docs: docs.nocobase.com

Services

nocobase

Configuration

Image
nocobase/nocobase:latest
Ports
${NOCOBASE_PORT:-13000}:80
Volumes
/app/nocobase/storage : nocobase-storage
Env vars
DB_DIALECT=postgresDB_HOST=postgresDB_PORT=5432DB_DATABASE=nocobaseDB_USER=nocobaseDB_PASSWORD=${NOCOBASE_DB_PASSWORD:?Set a database password}INIT_ROOT_PASSWORD=${NOCOBASE_ADMIN_PASSWORD:?Set a password for the admin account}
Restart
unless-stopped

Image details

Pulls: 1.2M
User: chenos
Created: Oct 07, 2021
Updated: 2 days ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Command
postgres -c wal_level=logical
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=nocobasePOSTGRES_USER=nocobasePOSTGRES_PASSWORD=${NOCOBASE_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 11.9B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 day ago
Status: active

Standalone Install

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

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 NocoBase, 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:
  nocobase:
    image: nocobase/nocobase:latest
    restart: unless-stopped
    init: true
    ports:
      - "${NOCOBASE_PORT:-13000}:80"
    environment:
      DB_DIALECT: postgres
      DB_HOST: postgres
      DB_PORT: "5432"
      DB_DATABASE: nocobase
      DB_USER: nocobase
      DB_PASSWORD: ${NOCOBASE_DB_PASSWORD:?Set a database password}
      INIT_ROOT_PASSWORD: ${NOCOBASE_ADMIN_PASSWORD:?Set a password for the admin account}
    volumes:
      - nocobase-storage:/app/nocobase/storage
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    command: postgres -c wal_level=logical
    environment:
      POSTGRES_DB: nocobase
      POSTGRES_USER: nocobase
      POSTGRES_PASSWORD: ${NOCOBASE_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U nocobase -d nocobase"]
      interval: 10s
      timeout: 5s
      retries: 5

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

More install options in our documentation, or see nocobase/nocobase 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 nocobase/nocobase: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

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

  • nocobase runs nocobase/nocobase:latest, starts after postgres
  • postgres runs postgres:17-alpine

Volumes

A volume is where NocoBase 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/nocobase/storage kept in the nocobase-storage 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. NocoBase takes 10 of them, and 3 need a value before it'll start properly:

  • DB_DIALECT, defaults to postgres
  • DB_HOST, defaults to postgres
  • DB_PORT, defaults to 5432
  • DB_DATABASE, defaults to nocobase
  • DB_USER, defaults to nocobase
  • DB_PASSWORD, needs a value
  • INIT_ROOT_PASSWORD, needs a value
  • POSTGRES_DB, defaults to nocobase
  • POSTGRES_USER, defaults to nocobase
  • POSTGRES_PASSWORD, needs a value

Restart policy

The restart policy here is unless-stopped, so Docker restarts NocoBase 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 nocobase) 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 NocoBase up. Add the template list to Portainer once, then deploying NocoBase is a click rather than a wall of config.