Portainer Templates logo

Portainer Templates

Flagsmith Flagsmith

Stack

DevelopmentTools

Feature flags and remote config for your apps: switch features on per environment, roll out to a percentage or a segment of users, and change values without a deploy, with SDKs for most languages. Source: https://github.com/Flagsmith/flagsmith

Source details

Repo: Flagsmith/flagsmith
Stars: 7k
Forks: 595
Language: Python
License: BSD-3-Clause
Latest: v2.288.2 · 6 days ago
Updated: 2 hours ago
Website: www.flagsmith.com/

Configuration

Type
Compose
Platform
linux
Env vars
FLAGSMITH_SECRET=''FLAGSMITH_DB_PASSWORD=''FLAGSMITH_SECURE_COOKIES=falseFLAGSMITH_PORT=8600
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in the secret key and database password before you deploy, since the stack won't start without them (openssl rand -hex 32 makes a good one of each), and keep both the same when you redeploy. The first start takes a minute or two while it builds the database. Then open it on port 8600 straight away and click Get Started, as whoever gets there first makes the admin account and the first organisation. The free self-hosted edition allows one project per organisation, so for another project click the logo at the top left, then Create Organisation. There's no email set up, so email invites and password resets won't send. Bring teammates in with the invite link under Users and Permissions instead. Anyone who can reach it can sign up too, so once your people are in, add FLAGSMITH_PREVENT_SIGNUP set to true to the stack's environment variables and redeploy (that closes the invite link as well). Point your apps' SDKs at http://<address>:8600/api/v1/. Everything lives in Postgres, in the postgres-data volume. Two things phone home. On every start the server sends Flagsmith a count of your organisations, projects, flags and users (add FLAGSMITH_TELEMETRY set to false to stop it). And the dashboard loads its own feature flags from Flagsmith's cloud, sending your user id, email and organisation name along with them. To keep that in-house, make an organisation just for this with one project in it, copy the client-side key from that project's SDK Keys page, then add FLAGSMITH_UI_FLAGS_KEY set to that key and FLAGSMITH_UI_FLAGS_URL set to /api/v1/, and redeploy. Docs: docs.flagsmith.com

Services

flagsmith

Configuration

Image
flagsmith/flagsmith:latest
Ports
${FLAGSMITH_PORT:-8600}:8000
Env vars
DATABASE_URL=postgresql://flagsmith:${FLAGSMITH_DB_PASSWORD:?Set a database password}@postgres:5432/flagsmithDJANGO_SECRET_KEY=${FLAGSMITH_SECRET:?Set a secret key}DJANGO_ALLOWED_HOSTS=*USE_POSTGRES_FOR_ANALYTICS=trueUSE_SECURE_COOKIES=${FLAGSMITH_SECURE_COOKIES:-false}COOKIE_SAME_SITE=LaxPREVENT_SIGNUP=${FLAGSMITH_PREVENT_SIGNUP:-false}ENABLE_TELEMETRY=${FLAGSMITH_TELEMETRY:-true}FLAGSMITH_ON_FLAGSMITH_API_URL=${FLAGSMITH_UI_FLAGS_URL:-https://edge.api.flagsmith.com/api/v1/}FLAGSMITH_ON_FLAGSMITH_API_KEY=${FLAGSMITH_UI_FLAGS_KEY:-MXSepNNQEacBBzxAU7RagJ}
Restart
unless-stopped

Image details

Pulls: 7.4M
User: dabeeeenster
Created: Oct 05, 2021
Updated: 6 days ago
Status: active

postgres

Configuration

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

Image details

Pulls: 12.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 3 days ago
Status: active

Standalone Install

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

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 Flagsmith, 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:
  flagsmith:
    image: flagsmith/flagsmith:latest
    restart: unless-stopped
    ports:
      - "${FLAGSMITH_PORT:-8600}:8000"
    environment:
      DATABASE_URL: postgresql://flagsmith:${FLAGSMITH_DB_PASSWORD:?Set a database password}@postgres:5432/flagsmith
      DJANGO_SECRET_KEY: ${FLAGSMITH_SECRET:?Set a secret key}
      DJANGO_ALLOWED_HOSTS: "*"
      USE_POSTGRES_FOR_ANALYTICS: "true"
      USE_SECURE_COOKIES: ${FLAGSMITH_SECURE_COOKIES:-false}
      COOKIE_SAME_SITE: Lax
      PREVENT_SIGNUP: ${FLAGSMITH_PREVENT_SIGNUP:-false}
      ENABLE_TELEMETRY: ${FLAGSMITH_TELEMETRY:-true}
      FLAGSMITH_ON_FLAGSMITH_API_URL: ${FLAGSMITH_UI_FLAGS_URL:-https://edge.api.flagsmith.com/api/v1/}
      FLAGSMITH_ON_FLAGSMITH_API_KEY: ${FLAGSMITH_UI_FLAGS_KEY:-MXSepNNQEacBBzxAU7RagJ}
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: flagsmith
      POSTGRES_USER: flagsmith
      POSTGRES_PASSWORD: ${FLAGSMITH_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U flagsmith -d flagsmith"]
      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/flagsmith/compose.yml up -d

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

Container Documentation

flagsmith Documentation

Flagsmith is an open source, fully featured, Feature Flag and Remote Config service.

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

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

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

Volumes

A volume is where Flagsmith 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. Flagsmith takes 13 of them, and 2 need a value before it'll start properly:

  • DATABASE_URL, defaults to postgresql://flagsmith:@postgres:5432/flagsmith
  • DJANGO_SECRET_KEY, needs a value
  • DJANGO_ALLOWED_HOSTS, defaults to *
  • USE_POSTGRES_FOR_ANALYTICS, defaults to true
  • USE_SECURE_COOKIES, defaults to false
  • COOKIE_SAME_SITE, defaults to Lax
  • PREVENT_SIGNUP, defaults to false
  • ENABLE_TELEMETRY, defaults to true
  • FLAGSMITH_ON_FLAGSMITH_API_URL, defaults to https://edge.api.flagsmith.com/api/v1/
  • FLAGSMITH_ON_FLAGSMITH_API_KEY, defaults to MXSepNNQEacBBzxAU7RagJ
  • POSTGRES_DB, defaults to flagsmith
  • POSTGRES_USER, defaults to flagsmith
  • POSTGRES_PASSWORD, needs a value

Restart policy

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

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