diff --git a/README.md b/README.md index 4efd32e..cf364eb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -[Feature Flag, Remote Config and A/B Testing platform, Bullet Train](https://bullet-train.io/) +[Feature Flag, Remote Config and A/B Testing platform, Flagsmith](https://flagsmith.com/) -# Bullet Train in Docker +[![Donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/Bullet-Train/donate) -You can use this repo to set up an entire [Bullet Train Feature Flag](https://bullet-train.io) environment locally. Just clone the repo and run docker-compose: +Bullet Train is now Flagsmith read about it [here](https://flagsmith.com/blog/rebrand). + +# Flagsmith in Docker + +You can use this repo to set up an entire [Flagsmith Feature Flag](https://www.flagsmith.com) environment locally. Just clone the repo and run docker-compose: ```bash -git clone https://github.com/BulletTrainHQ/bullet-train-docker.git -cd bullet-train-docker +git clone https://github.com/Flagsmith/flagsmith-docker.git +cd flagsmith-docker docker-compose up ``` @@ -33,9 +37,9 @@ The Web user interface. From here you can create accounts and manage your flags. The web user interface communicates via REST to the API that powers the application. The SDK clients also connect to this API. The API is written in Django and the Django REST Framework. -Once you have created an account and some flags, you can then start using the API with one of the [Bullet Train Client SDKs](https://github.com/BulletTrainHQ?q=client&type=&language=). You will need to override the API endpoint for each SDK to point to [http://localhost:8000/api/v1/](http://localhost:8000/api/v1/) +Once you have created an account and some flags, you can then start using the API with one of the [Flagsmith Client SDKs](https://github.com/Flagsmith?q=client&type=&language=). You will need to override the API endpoint for each SDK to point to [http://localhost:8000/api/v1/](http://localhost:8000/api/v1/) -You can access the Django Admin console to get CRUD access to some of the core tables within the API. You will need to create a super user account first. More information on how to create the super user account can be found here [https://github.com/BulletTrainHQ/bullet-train-api#locally](https://github.com/BulletTrainHQ/bullet-train-api#locally) +You can access the Django Admin console to get CRUD access to some of the core tables within the API. You will need to create a super user account first. More information on how to create the super user account can be found here [https://github.com/Flagsmith/flagsmith-api#locally](https://github.com/Flagsmith/flagsmith-api) ### Postgres Database @@ -45,7 +49,7 @@ The REST API stores all its data within a Postgres database. For more information, please visit: -- [Bullet Train Feature Flag Homepage](https://bullet-train.io) -- [Bullet Train Documentation](https://docs.bullet-train.io/) -- [Web Front End on GitHub](https://github.com/BulletTrainHQ/bullet-train-frontend) -- [REST API on GitHub](https://github.com/BulletTrainHQ/bullet-train-api) +- [Flagsmith Feature Flag Homepage](https://www.flagsmith.com) +- [Flagsmith Documentation](https://docs.flagsmith.com/) +- [Web Front End on GitHub](https://github.com/Flagsmith/flagsmith-frontend) +- [REST API on GitHub](https://github.com/Flagsmith/flagsmith-api) diff --git a/docker-compose.yml b/docker-compose.yml index a7836c3..ed7a7fc 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -4,35 +4,27 @@ services: image: postgres:10.6-alpine environment: POSTGRES_PASSWORD: password - POSTGRES_DB: bullettrain - container_name: bullettrain_postgres - redis: - image: redis:alpine - ports: - - "6379:6379" - container_name: bullettrain_redis + POSTGRES_DB: flagsmith + container_name: flagsmith_postgres api: - image: bullettrain/api:latest + image: flagsmith/flagsmith-api:latest environment: DJANGO_ALLOWED_HOSTS: localhost - DATABASE_URL: postgresql://postgres:password@db:5432/bullettrain + DATABASE_URL: postgresql://postgres:password@db:5432/flagsmith DJANGO_DB_HOST: db - DJANGO_DB_NAME: bullettrain + DJANGO_DB_NAME: flagsmith DJANGO_DB_USER: postgres DJANGO_DB_PASSWORD: password DJANGO_DB_PORT: 5432 - REDIS_URL: redis://redis:6379/ ports: - "8000:8000" depends_on: - db - - redis links: - db:db - - redis:redis - container_name: bullettrain_api + container_name: flagsmith_api frontend: - image: bullettrain/frontend:latest + image: flagsmith/flagsmith-frontend:latest environment: API_URL: http://localhost:8000/api/v1/ ASSET_URL: http://localhost:8080/ @@ -40,4 +32,4 @@ services: - "8080:8080" links: - api:api - container_name: bullettrain_frontend + container_name: flagsmith_frontend