Portainer Templates logo

Portainer Templates

Bytebase Bytebase

Stack

DatabaseDevelopment

Database change management for teams. Plan, review and roll out schema changes to Postgres, MySQL and 20-odd other databases with a full history, or query them from a web SQL editor. Source: https://github.com/bytebase/bytebase

Source details

Repo: bytebase/bytebase
Stars: 14.6k
Forks: 995
Language: Go
Latest: 3.23.1 · 8 days ago
Updated: 52 minutes ago
Website: www.bytebase.com/

Configuration

Type
Compose
Platform
linux
Env vars
BYTEBASE_DB_PASSWORD=''BYTEBASE_PORT=8093
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Set the database password before you deploy (openssl rand -hex 32 makes a good one), since the stack won't start without it. Then open http://<your-host>:8093 (or whichever port you picked). That page creates the admin, and whoever reaches it first gets to, so do it straight away. Sign-ups stay open after that (new people join as members), so tick Disallow self-service signup under Settings --> General if anyone else can reach it, and set the External URL there to the address you actually use. Each time it starts, Bytebase sends the first account's email address, everyone's email domains and your SQL review rules to bytebase.com, unless you untick Participate in improvement program on that same page. When you add a database, use your host's IP rather than localhost, which is the Bytebase container itself. The free Community plan covers 20 users and 10 instances. Bytebase keeps everything in Postgres, in the postgres-data volume, and any sample instance you start in bytebase-data. Docs: docs.bytebase.com

Services

bytebase

Configuration

Image
bytebase/bytebase:latest
Ports
${BYTEBASE_PORT:-8093}:8080
Volumes
/var/opt/bytebase : bytebase-data
Env vars
PG_URL=postgresql://bytebase:${BYTEBASE_DB_PASSWORD:?Set a database password}@postgres:5432/bytebase
Restart
unless-stopped

Image details

Pulls: 5.0M
User: tianzhouchen
Created: Jun 24, 2021
Updated: 8 days ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=bytebasePOSTGRES_USER=bytebasePOSTGRES_PASSWORD=${BYTEBASE_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

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

Standalone Install

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

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 Bytebase, 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:
  bytebase:
    image: bytebase/bytebase:latest
    restart: unless-stopped
    ports:
      - "${BYTEBASE_PORT:-8093}:8080"
    environment:
      PG_URL: postgresql://bytebase:${BYTEBASE_DB_PASSWORD:?Set a database password}@postgres:5432/bytebase
    volumes:
      - bytebase-data:/var/opt/bytebase
    depends_on:
      postgres:
        condition: service_healthy

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

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

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

Container Documentation

bytebase Documentation

Database CI/CD for Developers and DBAs

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 bytebase/bytebase: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

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

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

Volumes

A volume is where Bytebase 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/opt/bytebase kept in the bytebase-data 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. Bytebase takes 4 of them, and one needs a value before it'll start properly:

  • PG_URL, defaults to postgresql://bytebase:@postgres:5432/bytebase
  • POSTGRES_DB, defaults to bytebase
  • POSTGRES_USER, defaults to bytebase
  • POSTGRES_PASSWORD, needs a value

Restart policy

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