From 8ae50c0fc5341c9d75960beb6152365a487f170f Mon Sep 17 00:00:00 2001 From: Ben Rometsch Date: Tue, 21 Dec 2021 11:07:59 +0000 Subject: [PATCH] Resurrected repo! --- README.md | 39 +++++++++++++++++++++++++++- docker-compose.yml | 65 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 docker-compose.yml diff --git a/README.md b/README.md index 004b63e..2bc6a92 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ -This repo has been moved to https://github.com/Flagsmith/flagsmith +[![Feature Flag, Remote Config and A/B Testing platform, Flagsmith](static-files/hero.png)](https://www.flagsmith.com/) + +[Flagsmith](https://www.flagsmith.com/) is an open source, fully featured, Feature Flag and Remote Config service. Use +our hosted API, deploy to your own private cloud, or run on-premise. + +# Flagsmith + +Flagsmith makes it easy to create and manage features 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 1 minute with: + +```bash +git clone git@github.com:flagsmith/flagsmith.git +docker-compose -f flagsmith/docker/docker-compose.yml up +``` + +![Flagsmith Screenshot](static-files/screenshot.png) + +## Features + +- **Feature flags**. Release features with confidence through phased rollouts. +- **Remote config**. Easily toggle individual features on and off, and make changes without deploying new code. +- **A/B and Multivariate Testing**. Use segments to run A/B and multivariate tests on new features. With segments, you + can also introduce beta programs to get early user feedback. +- **Organization Management**. Organizations, projects, and roles for team members help keep your deployment organized. +- **Integrations**. Easily enhance Flagsmith with your favourite tools. + +## Getting Started + +For full documentation visit [https://docs.flagsmith.com/deployment/docker](https://docs.flagsmith.com/deployment/docker). + +## Resources + +* [Website](https://www.flagsmith.com/) +* [Documentation](https://docs.flagsmith.com/) +* If you have any questions about our projects you can email [support@flagsmith.com](mailto:support@flagsmith.com) diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..a0b3e12 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,65 @@ +# See https://docs.flagsmith.com/deployment/docker for more information on running Flagsmith in Docker +# This will docker-compose file will run the entire Flagsmith Platform in Docker +# Uncomment and configure InfluxDB lines below (not neccesary but adds some functionality that requires InfluxDB) + +version: '3' +services: + postgres: + image: postgres:11.12-alpine + environment: + POSTGRES_PASSWORD: password + POSTGRES_DB: flagsmith + container_name: flagsmith_postgres + + flagsmith: + image: flagsmith/flagsmith:latest + environment: + # All environments variables are available here: + # API: https://docs.flagsmith.com/deployment/locally-api#environment-variables + # UI: https://docs.flagsmith.com/deployment/locally-frontend#environment-variables + + + DJANGO_ALLOWED_HOSTS: '*' # Change this in production + DATABASE_URL: postgresql://postgres:password@postgres:5432/flagsmith + DISABLE_INFLUXDB_FEATURES: 'true' # set to 'false' to enable InfluxDB + + ENV: prod # set to "prod" in production. + + # For more info on configuring InfluxDB - https://docs.flagsmith.com/deployment/overview#influxdb + # INFLUXDB_URL: http://influxdb:8086 + # INFLUXDB_BUCKET: flagsmith_api + # INFLUXDB_ORG: # Add your influx org id here + # INFLUXDB_TOKEN: # Add your influx token here + + # For more info on configuring E-Mails - https://docs.flagsmith.com/deployment/locally-api#environment-variables + # + # Example SMTP: + # EMAIL_BACKEND: django.core.mail.backends.smtp.EmailBackend + # EMAIL_HOST: mail.example.com + # SENDER_EMAIL: flagsmith@example.com + # EMAIL_HOST_USER: flagsmith@example.com + # EMAIL_HOST_PASSWORD: smtp_account_password + # EMAIL_PORT: 587 # optional + # EMAIL_USE_TLS: True # optional + + # ENABLE_ADMIN_ACCESS_USER_PASS: True # set to True to enable access to the /admin/ Django backend via your username and password + # ALLOW_REGISTRATION_WITHOUT_INVITE: True + + + + ports: + - '8000:8000' + depends_on: + - postgres + # - influxdb + links: + - postgres + # - influxdb:influxdb + + # InfluxDB requires additional setup - please see https://docs.flagsmith.com/deployment-overview/#influxdb + # Note that InfluxDB is optional, but enabling it will provide additional functionality to the Flagsmith platform + # influxdb: + # image: quay.io/influxdb/influxdb:v2.0.3 + # container_name: flagsmith_influxdb + # ports: + # - "8086:8086" \ No newline at end of file