Portainer Templates logo

Portainer Templates

Penpot (http) {shmolf} Penpot (http) {shmolf}

Stack

Graphic Design

Penpot is the first Open Source design and prototyping platform meant for cross-domain teams.

Configuration

Type
Compose
Platform
linux
Env vars
PUID=1000PGID=1000PENPOT_FLAGS_FE=enable-registration disable-secure-session-cookies enable-insecure-register enable-login-with-passwordPENPOT_FLAGS_BE=enable-registration disable-secure-session-cookies enable-insecure-register disable-email-verificationPUBLIC_URI=http://192.168.1.1:8624TELEMETRY_ENABLED=truePORT=8624
Source

Template by shmolf·Source

Notes

Application documentation 🗗. See documentation 🗗 for more details regarding the flags.

Services

penpot-frontend

Configuration

Image
penpotapp/frontend:latest
Ports
${PORT}:80
Volumes
/opt/data/assets : penpot_assets
Env vars
PENPOT_FLAGS=${PENPOT_FLAGS_FE}
Restart
always

Image details

Pulls: 3.8M
User: penpotapp
Created: Dec 01, 2020
Updated: 24 days ago
Status: active

penpot-backend

Configuration

Image
penpotapp/backend:latest
Volumes
/opt/data/assets : penpot_assets
Env vars
PENPOT_FLAGS=${PENPOT_FLAGS_BE}PENPOT_PUBLIC_URI=${PUBLIC_URI}PENPOT_DATABASE_URI=postgresql://penpot-postgres/penpotPENPOT_DATABASE_USERNAME=penpotPENPOT_DATABASE_PASSWORD=penpotPENPOT_REDIS_URI=redis://penpot-redis/0PENPOT_ASSETS_STORAGE_BACKEND=assets-fsPENPOT_STORAGE_ASSETS_FS_DIRECTORY=/opt/data/assetsPENPOT_TELEMETRY_ENABLED=${TELEMETRY_ENABLED}
Restart
always

Image details

Pulls: 5.1M
User: penpotapp
Created: Dec 01, 2020
Updated: 24 days ago
Status: active

penpot-exporter

Configuration

Image
penpotapp/exporter:latest
Env vars
PENPOT_PUBLIC_URI=http://penpot-frontendPENPOT_REDIS_URI=redis://penpot-redis/0
Restart
always

Image details

Pulls: 4.5M
User: penpotapp
Created: Dec 02, 2020
Updated: 24 days ago
Status: active

penpot-postgres

Configuration

Image
postgres:15
Volumes
/var/lib/postgresql/data : penpot_postgres_v15
Env vars
POSTGRES_INITDB_ARGS=--data-checksumsPOSTGRES_DB=penpotPOSTGRES_USER=penpotPOSTGRES_PASSWORD=penpot
Restart
always

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

penpot-redis

Configuration

Image
redis:7
Restart
always

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Penpot (http) {shmolf}

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 Penpot (http) {shmolf}, 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:

---
version: "3.5"

networks:
  penpot:

volumes:
  penpot_postgres_v15:
  penpot_assets:
  # penpot_traefik:
  # penpot_minio:

services:
  ## Traefik service declaration example. Consider using it if you are going to expose
  ## penpot to the internet or different host than `localhost`.

  # traefik:
  #   image: traefik:v2.9
  #   networks:
  #     - penpot
  #   command:
  #     - "--api.insecure=true"
  #     - "--entryPoints.web.address=:80"
  #     - "--providers.docker=true"
  #     - "--providers.docker.exposedbydefault=false"
  #     - "--entryPoints.websecure.address=:443"
  #     - "--certificatesresolvers.letsencrypt.acme.tlschallenge=true"
  #     - "--certificatesresolvers.letsencrypt.acme.email=<EMAIL_ADDRESS>"
  #     - "--certificatesresolvers.letsencrypt.acme.storage=/traefik/acme.json"
  #   volumes:
  #     - "penpot_traefik:/traefik"
  #     - "/var/run/docker.sock:/var/run/docker.sock"
  #   ports:
  #     - "80:80"
  #     - "443:443"

  penpot-frontend:
    image: "penpotapp/frontend:latest"
    restart: always
    ports:
      - ${PORT}:80

    volumes:
      - penpot_assets:/opt/data/assets

    depends_on:
      - penpot-backend
      - penpot-exporter

    networks:
      - penpot

    # labels:
      # - "traefik.enable=true"

      ## HTTP: example of labels for the case if you are going to expose penpot to the
      ## internet using only HTTP (without HTTPS) with traefik

      # - "traefik.http.routers.penpot-http.entrypoints=web"
      # - "traefik.http.routers.penpot-http.rule=Host(`<DOMAIN_NAME>`)"
      # - "traefik.http.services.penpot-http.loadbalancer.server.port=80"

      ## HTTPS: example of labels for the case if you are going to expose penpot to the
      ## internet using with HTTPS using traefik

      # - "traefik.http.middlewares.http-redirect.redirectscheme.scheme=https"
      # - "traefik.http.middlewares.http-redirect.redirectscheme.permanent=true"
      # - "traefik.http.routers.penpot-http.entrypoints=web"
      # - "traefik.http.routers.penpot-http.rule=Host(`<DOMAIN_NAME>`)"
      # - "traefik.http.routers.penpot-http.middlewares=http-redirect"
      # - "traefik.http.routers.penpot-https.entrypoints=websecure"
      # - "traefik.http.routers.penpot-https.rule=Host(`<DOMAIN_NAME>`)"
      # - "traefik.http.services.penpot-https.loadbalancer.server.port=80"
      # - "traefik.http.routers.penpot-https.tls=true"
      # - "traefik.http.routers.penpot-https.tls.certresolver=letsencrypt"

    ## Configuration envronment variables for frontend the container. In this case this
    ## container only needs the `PENPOT_FLAGS`. This environment variable is shared with
    ## other services but not all flags are relevant to all services.

    environment:
      ## Relevant flags for frontend:
      ## - demo-users
      ## - login-with-github
      ## - login-with-gitlab
      ## - login-with-google
      ## - login-with-ldap
      ## - login-with-oidc
      ## - login-with-password
      ## - registration
      ## - webhooks
      ##
      ## You can read more about all available flags on:
      ## https://help.penpot.app/technical-guide/configuration/#advanced-configuration

      - PENPOT_FLAGS=${PENPOT_FLAGS_FE}

  penpot-backend:
    image: "penpotapp/backend:latest"
    restart: always

    volumes:
      - penpot_assets:/opt/data/assets

    depends_on:
      - penpot-postgres
      - penpot-redis

    networks:
      - penpot

    ## Configuration envronment variables for backend the
    ## container.

    environment:

      ## Relevant flags for backend:
      ## - demo-users
      ## - email-verification
      ## - log-emails
      ## - log-invitation-tokens
      ## - login-with-github
      ## - login-with-gitlab
      ## - login-with-google
      ## - login-with-ldap
      ## - login-with-oidc
      ## - login-with-password
      ## - registration
      ## - secure-session-cookies
      ## - smtp
      ## - smtp-debug
      ## - telemetry
      ## - webhooks
      ## - prepl-server
      ##
      ## You can read more about all available flags and other
      ## environment variables for the backend here:
      ## https://help.penpot.app/technical-guide/configuration/#advanced-configuration

      - PENPOT_FLAGS=${PENPOT_FLAGS_BE}


      ## Penpot SECRET KEY. It serves as a master key from which other keys for subsystems
      ## (eg http sessions, or invitations) are derived.
      ##
      ## If you leve it commented, all created sessions and invitations will
      ## become invalid on container restart.
      ##
      ## If you going to uncomment this, we recommend use here a trully randomly generated
      ## 512 bits base64 encoded string.  You can generate one with:
      ##
      ## python3 -c "import secrets; print(secrets.token_urlsafe(64))"

      # - PENPOT_SECRET_KEY=my-insecure-key

      ## The PREPL host. Mainly used for external programatic access to penpot backend
      ## (example: admin). By default it listen on `localhost` but if you are going to use
      ## the `admin`, you will need to uncomment this and set the host to `0.0.0.0`.

      # - PENPOT_PREPL_HOST=0.0.0.0

      ## Public URI. If you are going to expose this instance to the internet and use it
      ## under different domain than 'localhost', you will need to adjust it to the final
      ## domain.
      ##
      ## Consider using traefik and set the 'disable-secure-session-cookies' if you are
      ## not going to serve penpot under HTTPS.

      - PENPOT_PUBLIC_URI=${PUBLIC_URI}

      ## Database connection parameters. Don't touch them unless you are using custom
      ## postgresql connection parameters.

      - PENPOT_DATABASE_URI=postgresql://penpot-postgres/penpot
      - PENPOT_DATABASE_USERNAME=penpot
      - PENPOT_DATABASE_PASSWORD=penpot

      ## Redis is used for the websockets notifications. Don't touch unless the redis
      ## container has different parameters or different name.

      - PENPOT_REDIS_URI=redis://penpot-redis/0

      ## Default configuration for assets storage: using filesystem based with all files
      ## stored in a docker volume.

      - PENPOT_ASSETS_STORAGE_BACKEND=assets-fs
      - PENPOT_STORAGE_ASSETS_FS_DIRECTORY=/opt/data/assets

      ## Also can be configured to to use a S3 compatible storage
      ## service like MiniIO. Look below for minio service setup.

      # - AWS_ACCESS_KEY_ID=<KEY_ID>
      # - AWS_SECRET_ACCESS_KEY=<ACCESS_KEY>
      # - PENPOT_ASSETS_STORAGE_BACKEND=assets-s3
      # - PENPOT_STORAGE_ASSETS_S3_ENDPOINT=http://penpot-minio:9000
      # - PENPOT_STORAGE_ASSETS_S3_BUCKET=<BUKET_NAME>

      ## Telemetry. When enabled, a periodical process will send anonymous data about this
      ## instance. Telemetry data will enable us to learn on how the application is used,
      ## based on real scenarios. If you want to help us, please leave it enabled. You can
      ## audit what data we send with the code available on github

      - PENPOT_TELEMETRY_ENABLED=${TELEMETRY_ENABLED}

      ## Example SMTP/Email configuration. By default, emails are sent to the mailcatch
      ## service, but for production usage is recommended to setup a real SMTP
      ## provider. Emails are used to confirm user registrations & invitations. Look below
      ## how mailcatch service is configured.

      # - PENPOT_SMTP_DEFAULT_FROM=no-reply@example.com
      # - PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com
      # - PENPOT_SMTP_HOST=penpot-mailcatch
      # - PENPOT_SMTP_PORT=1025
      # - PENPOT_SMTP_USERNAME=
      # - PENPOT_SMTP_PASSWORD=
      # - PENPOT_SMTP_TLS=false
      # - PENPOT_SMTP_SSL=false

  penpot-exporter:
    image: "penpotapp/exporter:latest"
    restart: always
    networks:
      - penpot

    environment:
      # Don't touch it; this uses internal docker network to
      # communicate with the frontend.
      - PENPOT_PUBLIC_URI=http://penpot-frontend

      ## Redis is used for the websockets notifications.
      - PENPOT_REDIS_URI=redis://penpot-redis/0

  penpot-postgres:
    image: "postgres:15"
    restart: always
    stop_signal: SIGINT

    volumes:
      - penpot_postgres_v15:/var/lib/postgresql/data

    networks:
      - penpot

    environment:
      - POSTGRES_INITDB_ARGS=--data-checksums
      - POSTGRES_DB=penpot
      - POSTGRES_USER=penpot
      - POSTGRES_PASSWORD=penpot

  penpot-redis:
    image: redis:7
    restart: always
    networks:
      - penpot

  ## A mailcatch service, used as temporal SMTP server. You can access via HTTP to the
  ## port 1080 for read all emails the penpot platform has sent. Should be only used as a
  ## temporal solution meanwhile you don't have a real SMTP provider configured.

  # penpot-mailcatch:
  #   image: sj26/mailcatcher:latest
  #   restart: always
  #   expose:
  #     - '1025'
  #   ports:
  #     - "1080:1080"
  #   networks:
  #     - penpot

  ## Example configuration of MiniIO (S3 compatible object storage service); If you don't
  ## have preference, then just use filesystem, this is here just for the completeness.

  # minio:
  #   image: "minio/minio:latest"
  #   command: minio server /mnt/data --console-address ":9001"
  #   restart: always
  #
  #   volumes:
  #     - "penpot_minio:/mnt/data"
  #
  #   environment:
  #     - MINIO_ROOT_USER=minioadmin
  #     - MINIO_ROOT_PASSWORD=minioadmin
  #
  #   ports:
  #     - 9000:9000
  #     - 9001:9001

Or deploy it directly from the source:

git clone https://github.com/shmolf/portainer-templates
cd portainer-templates
docker compose -f stacks/penpot/docker-compose-http.yml up -d

More install options in our documentation.

Container Documentation

penpot-frontend Documentation

Penpot frontend

penpot-backend Documentation

Penpot backend

penpot-exporter Documentation

Penpot exporter

penpot-postgres Documentation

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

penpot-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 penpotapp/frontend: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

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

  • penpot-frontend runs penpotapp/frontend:latest, starts after penpot-backend, penpot-exporter
  • penpot-backend runs penpotapp/backend:latest, starts after penpot-postgres, penpot-redis
  • penpot-exporter runs penpotapp/exporter:latest
  • penpot-postgres runs postgres:15
  • penpot-redis runs redis:7

Volumes

A volume is where Penpot (http) {shmolf} 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:

  • /opt/data/assets kept in the penpot_assets volume Docker manages
  • /var/lib/postgresql/data kept in the penpot_postgres_v15 volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Penpot (http) {shmolf} takes 13 of them, all with defaults you can leave alone or tweak:

  • PENPOT_FLAGS, pulled from your own environment
  • PENPOT_PUBLIC_URI, defaults to http://penpot-frontend
  • PENPOT_DATABASE_URI, defaults to postgresql://penpot-postgres/penpot
  • PENPOT_DATABASE_USERNAME, defaults to penpot
  • PENPOT_DATABASE_PASSWORD, defaults to penpot
  • PENPOT_REDIS_URI, defaults to redis://penpot-redis/0
  • PENPOT_ASSETS_STORAGE_BACKEND, defaults to assets-fs
  • PENPOT_STORAGE_ASSETS_FS_DIRECTORY, defaults to /opt/data/assets
  • PENPOT_TELEMETRY_ENABLED, pulled from your own environment
  • POSTGRES_INITDB_ARGS, defaults to --data-checksums
  • POSTGRES_DB, defaults to penpot
  • POSTGRES_USER, defaults to penpot
  • POSTGRES_PASSWORD, defaults to penpot

Restart policy

The restart policy here is always, so Docker brings Penpot (http) {shmolf} 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 penpot-frontend) 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 Penpot (http) {shmolf} up. Add the template list to Portainer once, then deploying Penpot (http) {shmolf} is a click rather than a wall of config.