Initial Setup
The application is built using Django which comes with a handy set of admin pages available at /admin/. To access these, you'll need to create a superuser. This user can also be used to access the admin pages or the application itself if you have the frontend application running as well. This user can be created using the instructions below, depending on your installation:
Local Installation
cd api
python manage.py createsuperuser
Cloud Environments (e.g. Heroku, ECS)
Once the app has been deployed, you can initialise your installation by accessing /api/v1/users/config/init/. This will show a page with a basic form to set up some initial data for the platform. Each of the parameters in the form are described below.
| Parameter name | Description |
|---|---|
| Username | A unique username to give the installation superuser |
| The email address to give the installation superuser | |
| Password | The password to give the installation superuser |
| Site name | A human-readable name for the site, e.g. 'Flagsmith' |
| Site domain1 | The domain that the frontend of the site will be running on, e.g. app.flagsmith.com. This will be used for e.g. password reset emails. |
Footnotes
-
It is important that this is correct as it is used in the password reset emails to construct the reset link. ↩