flagsmith Documentation

Flagsmith is an open source feature flagging and remote config service. Self-host or use our hosted version at

RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy flagsmith on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run)
docker run -d --name flagsmith -p 8000:8000 --restart always postgres:15.5-alpine
Configured Services & Ports
βš™οΈ postgres
image: postgres:15.5-alpine
βš™οΈ api
image: build locally
πŸ”Œ Ports: 8000:8000
βš™οΈ datadog
image: gcr.io/datadoghq/agent:7
docker-compose.yml
yaml (docker-compose.yml)
# An example docker-compose file for integrating the Flagsmith API with DataDog via statsd.
# Further documentation can be found here: https://docs.flagsmith.com/deployment/locally-api#statsd-integration

version: '3'
services:
  postgres:
    image: postgres:15.5-alpine
    environment:
      POSTGRES_PASSWORD: password
      POSTGRES_DB: flagsmith
    container_name: flagsmith_postgres
  api:
    build:
      dockerfile: Dockerfile
      context: ../../api
    environment:
      DATABASE_URL: postgres://postgres:password@postgres:5432/flagsmith
      DJANGO_SETTINGS_MODULE: app.settings.local
      STATSD_HOST: datadog
    ports:
      - 8000:8000
    depends_on:
      - postgres
    links:
      - postgres
      - datadog
  datadog:
    image: gcr.io/datadoghq/agent:7
    environment:
      - DD_API_KEY=
      - DD_SITE=datadoghq.eu
      - DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /proc/:/host/proc/:ro
      - /sys/fs/cgroup:/host/sys/fs/cgroup:ro
      - /var/lib/docker/containers:/var/lib/docker/containers:ro

1. Project Overview & Quickstart (Flagsmith/flagsmith)







[Flagsmith](https://flagsmith.com/) is an Open-Source Feature Flagging Tool to Ship Faster & Control Releases

Change the way your team releases software. Roll out, segment, and optimiseβ€”with granular control. Stay secure with on-premise and private cloud hosting.

  • Feature flags: Release features behind the safety of a feature flag
  • Make changes remotely: Easily toggle individual features on and off, and make changes without deploying new code
  • A/B testing: Use segments to run A/B and multivariate tests on new features
  • Segments: Release features to beta testers, collect feedback, and iterate
  • Organisation management: Stay organised with orgs, projects, and roles for team members
  • SDKs & frameworks: Choose from 15+ popular languages like Typescript, .NET, Java, and more. Integrate with any framework, including React, Next.js, and more
  • Integrations: Use your favourite tools with Flagsmith

Flagsmith makes it easy to create and manage feature flags across web, mobile, and server side applications. Just wrap
a section of code with a flag, and then use Flagsmith to toggle that feature on or off for different environments, users
or user segments.

Get up and running in less than a minute:

bash
curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml
docker-compose -f docker-compose.yml up

The application will bootstrap an admin user, organisation, and project for you. You'll find a link to set your password
in your Compose logs:

txt
Superuser "[email protected]" created successfully.
Please go to the following page and choose a password: http://localhost:8000/password-reset/confirm/.../...

Flagsmith Open Source

We love contributions from the community and are always looking to improve! Here are our contribution guidelines.

Flagsmith hosted SaaS

You can try our hosted version for free at https://flagsmith.com

Community Resources

Open Source Philosophy

The majority of our platform is open source under the BSD-3-Clause license. A small number of repositories are under the MIT license.

We built Flagsmith as the open source feature flag tool we needed but couldn't find on GitHub. Our core functionality stays open, always. Read our open letter to developers.

Open Source vs Paid

With our core functionality being open, you can use our open-source feature flag and remote config management platform no matter what. Enterprise-level governance and management features are available with a valid Flagsmith Enterprise license.

To learn more, contact us or see our version comparison.

Contributors

Thank you to the open source community for your contributions and for building this with us!

Made with contrib.rocks.

2. Official Technical Reference & Guides (Flagsmith/flagsmith-docs)

File: README.md

:warning: Our docs repo has been archived!

We've moved our docs over to our monorepo.


File: docs/index.md


id: intro slug: / title: Welcome to the Flagsmith Docs sidebar_position: 1 sidebar_label: Overview

Flagsmith lets you manage features across web, mobile and server side applications.

Flagsmith is Open Source. Host yourself or let us take care of the hosting.

Getting Started

If you're new to Flagsmith or Feature Flags in general we would recommend:

Digging Deeper

Check out our SDKs

Client Side SDKs

Server Side SDKs

Check out our Server Side SDK architecture first!

Open Source vs SaaS vs Enterprise

Learn more about the different ways you can run Flagsmith.