Portainer Templates logo

Portainer Templates

NocoDB NocoDB

Stack

ProductivityDevelopmentNo Code

Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadsheet.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

nocodb

Configuration

Image
nocodb/nocodb:latest
Ports
8585:8080
Volumes
/usr/app/data : /portainer/Files/AppData/Config/nocodb/nc_data
Env vars
NC_DB=mysql2://root_db:3306?u=noco&p=password&d=root_db
Restart
always

Image details

Pulls: 21.2M
User: pranavxc
Created: Apr 16, 2021
Updated: 10 days ago
Status: active

root_db

Configuration

Image
mysql:5.7
Volumes
/var/lib/mysql : /portainer/Files/AppData/Config/nocodb/db_data
Env vars
MYSQL_DATABASE=root_dbMYSQL_PASSWORD=passwordMYSQL_ROOT_PASSWORD=passwordMYSQL_USER=noco
Restart
always

Image details

Pulls: 5.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 19 days ago
Status: active

Standalone Install

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

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 NocoDB, 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: 
  nocodb: 
    depends_on: 
      root_db: 
        condition: service_healthy
    environment: 
      NC_DB: "mysql2://root_db:3306?u=noco&p=password&d=root_db"
    image: "nocodb/nocodb:latest"
    ports: 
      - "8585:8080"
    restart: always
    volumes: 
      - /portainer/Files/AppData/Config/nocodb/nc_data:/usr/app/data
  root_db: 
    environment: 
      MYSQL_DATABASE: root_db
      MYSQL_PASSWORD: password
      MYSQL_ROOT_PASSWORD: password
      MYSQL_USER: noco
    healthcheck: 
      retries: 10
      test: 
        - CMD
        - mysqladmin
        - ping
        - "-h"
        - localhost
      timeout: 20s
    image: "mysql:5.7"
    restart: always
    volumes: 
      - /portainer/Files/AppData/Config/nocodb/db_data:/var/lib/mysql
#    below line shows how to change charset and collation
#    uncomment it if necessary
#    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/nocodb.yml up -d

More install options in our documentation.

Container Documentation

nocodb Documentation

root_db Documentation

MySQL is a widely used, open-source relational database management system (RDBMS).

Serve NocoDB 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 nocodb.example.com to http://nocodb:8080

Add this to your Caddyfile

nocodb.example.com {
	reverse_proxy http://nocodb:8080
}

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:8585 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8585
  • Stop the other service, or pick a different host port. In 8585:8080 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:8585. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, NocoDB can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8585

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/nocodb/nc_data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull nocodb/nocodb: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 always 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

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

  • nocodb runs nocodb/nocodb:latest, starts after root_db
  • root_db runs mysql:5.7

Ports

A port is the door the app answers on. A mapping like 8585:8080 means it's reachable on port 8585 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:8585 in a browser. It opens:

  • 8585:8080, likely the web interface

Volumes

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

  • /usr/app/data from /portainer/Files/AppData/Config/nocodb/nc_data on the host
  • /var/lib/mysql from /portainer/Files/AppData/Config/nocodb/db_data on the host

Environment variables

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

  • NC_DB, defaults to mysql2://root_db:3306?u=noco&p=password&d=root_db
  • MYSQL_DATABASE, defaults to root_db
  • MYSQL_PASSWORD, defaults to password
  • MYSQL_ROOT_PASSWORD, defaults to password
  • MYSQL_USER, defaults to noco

Restart policy

The restart policy here is always, so Docker brings NocoDB back up after a crash and again when the server reboots. Good for anything you want running around the clock. 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 nocodb) 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 NocoDB up. Add the template list to Portainer once, then deploying NocoDB is a click rather than a wall of config.