saleor-dashboard/docs/configuration.md
Lukasz Ostrowski 7fcc71839a
Appstore improvements for non-cloud dashboard (#3258)
* Add empty screen message if no apps are installed

* Add .env.template with Appstore and Demo set by default

* Change how section is resolved

* Add message that Saleor apps can be installed only in Cloud

* Add apps.saleor.io url be default Appstore url in Dockerfile

* Show cloud only message for apps with manifest

* Extract messages

* Fix test

* Change message to tooltip

* Update readme
2023-03-03 08:51:35 +01:00

29 lines
1.4 KiB
Markdown

# Configuration
## Quick start
Run `cp .env.template .env` to create default configuration that will be connected to [Saleor Demo shop](https://demo.saleor.io/dashboard/)
## All environment variables
Create or edit `.env` file in a root directory or set environment variables with the following values:
- `API_URI` (required) - URI of Saleor GraphQL API instance.
If you are running Saleor locally with the default settings, set `API_URI` to: "http://localhost:8000/graphql/".
Make sure you have "/" at the end of `API_URI`.
- `APP_MOUNT_URI` - URI at which the Dashboard app will be mounted.
E.g., if you set `APP_MOUNT_URI` to "/dashboard/", your app will be mounted at "http://localhost:9000/dashboard/".
- `STATIC_URL` - URL where the static files are located.
E.g., if you use an S3 bucket, you should set it to the bucket's URL. By default, Saleor assumes you serve static files from the root of your site at "http://localhost:9000/".
- `APPS_MARKETPLACE_API_URI` - URI of Marketplace API to fetch list of Apps in JSON.
- `APPS_TUNNEL_URL_KEYWORDS` - Custom apps tunnel URL keywords.
- `FLAGS_SERVICE_ENABLED` - Boolean flag determines whether we use external feature flags provider.
If you set `FLAGS_SERVICE_ENABLED` to "true", we'll be using external feature flag provider as source or flags.
If you set `FLAGS_SERVICE_ENABLED` to "false" or not set, we'll use fallback flags from environment variables.
- `FLAGSMITH_ID` - Flagsmith environment id