The environment variables contain the instance specific variables for a single deployment. An example environment file is provided in .env.example in all repositories.

API

All the environment variables specified below must be present one way or another. Laravel provides a .env file which will be used if present - this is currently only used for local development environments, for both staging and production, environment variables are set via alternate ways (e.g .secrets management)

<aside> ℹ️ For further information on the environment variables, consult the config files located in the /config directory. It is here that the environment variables are referenced.

</aside>

Name	Type	Description	Value	Example
App
APP_NAME	string	The application name.	[USER DETERMINED]	Connected Places
APP_ENV	string	The environment the app is running in.	local, testing, staging or production	local
APP_KEY	string	The application encryption key https://connectedplaces.notion.site/10b8c1872bca4d6bb97791ab7435bf87.	[GENERATED]
APP_DEBUG	boolean	If the application is in debug mode.	true or false	true
APP_URL	string	The URL of the API application.	[USER DETERMINED]	http://0.0.0.0
BACKEND_URI	string	The URI of the Admin application.	[USER DETERMINED]	http://0.0.0.0:8080
Logging
LOG_CHANNEL	string	The channel used when writing messages to the log.	single ,errorlog, syslog or stack	stack
BUGSNAG_API_KEY	string	A https://www.bugsnag.com/ API access key for error monitoring.	[USER DETERMINED]
Database
DB_HOST	string	The host of the database connection.	[USER DETERMINED]	127.0.0.1
DB_PORT	integer	The port of the database connection.	[USER DETERMINED]	3306
DB_DATABASE	string	The name of the database connection.	[USER DETERMINED]	connected_places
DB_USERNAME	string	The username of the database connection.	[USER DETERMINED]	connected_places
DB_PASSWORD	string	The password of the database connection.	[USER DETERMINED]	secret
AWS Credentials
AWS_ACCESS_KEY_ID	string	The AWS key ID.	[USER DETERMINED]	secret
AWS_SECRET_ACCESS_KEY	string	The AWS access key.	[USER DETERMINED]	secret
AWS_DEFAULT_REGION	string	The default AWS region.	[USER DETERMINED]	eu-west-1
Filesystem
FILESYSTEM_CLOUD	string	The location of the filesystem to use.	local_cloud or s3	local_cloud
AWS_BUCKET	string	The AWS S3 bucket.	[USER DETERMINED]
Queue
QUEUE_DRIVER	string	The queue driver.	sync, redis or sqs	sync
SQS_PREFIX	string	The URI prefix for the queues.	[USER DETERMINED]	https://sqs.eu-west-1.amazonaws.com/your-account-id
SQS_QUEUE	string	The default queue name.	default	default
SQS_KEY	string	The AWS key ID for the IAM user with access to the queues.	[USER DETERMINED]
SQS_SECRET	string	The AWS access key for the IAM user with access to the queues.	[USER DETERMINED]	secret
SQS_REGION	string	The AWS region that the queues are in.	[USER DETERMINED]	eu-west-1
Redis
REDIS_CLUSTER	boolean	If the Redis service being used is in cluster mode.	true or false	true
REDIS_SCHEME	string	The scheme used to connect to the Redis server.	tcp or tls	tcp
REDIS_HOST	string	The host of the Redis connection.	[USER DETERMINED]	127.0.0.1
REDIS_PASSWORD	string	The password of the Redis connection.	[USER DETERMINED]	secret
REDIS_PORT	integer	The port of the Redis connection.	[USER DETERMINED]	7000
Geocoding
GEOCODE_DRIVER	string	The driver to use for geocoding addresses.	stub, nominatim or google	google
GOOGLE_API_KEY	string	The API key used for the Google Geocoding service.	[USER DETERMINED]	secret
Email
MAIL_DRIVER	string	The email driver to use.	mailgun, gov or log	mailgun
MAIL_FROM_ADDRESS	string	The email address which sent emails appear to be from.	[USER DETERMINED]	[email protected]
MAIL_FROM_NAME	string	The name which sent emails appear to be from.	[USER DETERMINED]	A Company
GLOBAL_ADMIN_EMAIL	string	The email address used to receive global platform notifications.	[USER DETERMINED]	[email protected]
Mailgun
MAILGUN_DOMAIN	string	The domain you are sending email from.	[USER DETERMINED]	example.com
MAILGUN_SECRET	string	The Mailgun secret.	[USER DETERMINED]	secret
MAILGUN_ENDPOINT	string	The URL of the Mailgun API endpoint.	[USER DETERMINED]	https://api.eu.mailgun.net
SMS
SMS_DRIVER	string	The SMS driver to use.	twilio, gov or log	twilio
TWILIO_SID	string	The Twilio SID.	[USER DETERMINED]	secret
TWILIO_TOKEN	string	The Twilio access token.	[USER DETERMINED]	secret
GOV_NOTIFY_API_KEY	string	The API key used for the GOV.UK Notify service.	[USER DETERMINED]
ElasticSearch
SCOUT_ELASTIC_HOST	string	The URI for the Elasticsearch service (including protocol and port).	[USER DETERMINED]	localhost:9200
SCOUT_ELASTIC_DOCUMENT_REFRESH	string	Controls when updated documents appear in the search results.	true, false, wait_for or null	true
Misc
SESSION_LIFETIME	integer	The lifetime of a user's session.	120
OTP_ENABLED	boolean	If the SMS one time password login should be enabled for all users.	true or false	false
CQC_LOCATION	boolean	Flag to enable/disable CQC feature within the Admin app.	true or false	false
SERVICE_TAGS	boolean	Flag to enable/disable the service tags feature within the Admin app.	true or false	false
PASSPORT_PRIVATE_KEY	string	The oAuth private key that you generated during the https://connectedplaces.notion.site/10b8c1872bca4d6bb97791ab7435bf87	[GENERATED]
PASSPORT_PUBLIC_KEY	string	The oAuth public key that you generated during the https://connectedplaces.notion.site/10b8c1872bca4d6bb97791ab7435bf87	[GENERATED]

Admin

Name	Type	Description	Value	Example
VUE_APP_NAME	string	The application name displayed in the admin app.	[USER DETERMINED]	Connected Places
VUE_APP_ENV	string	The environment the app is running in.	local, testing, staging or production	local
VUE_APP_URI	string	The URL to access the admin app.	[USER DETERMINED]	http://0.0.0.0:8080
VUE_APP_API_URI	string	The URL to access the API.	[USER DETERMINED]	http://0.0.0.0/
VUE_APP_FRONTEND_URI	string	The URL to access the public frontend app.	[USER DETERMINED]	http://0.0.0.0:3000/
VUE_APP_API_CLIENT_ID	integer	The ID for https://connectedplaces.notion.site/10b8c1872bca4d6bb97791ab7435bf87 the app will use	[USER DETERMINED]	1
VUE_APP_GOOGLE_API_KEY	string	A Google access key allowing use of the https://developers.google.com/maps/documentation/geocoding/overview.	[USER DETERMINED]
VUE_APP_SESSION_TIMEOUT	integer	The number of minutes an authenticated session will last for.	[USER DETERMINED]	20
VUE_APP_BUGSNAG_API_KEY	string	A https://www.bugsnag.com/ access key for error monitoring.	[USER DETERMINED]
VUE_APP_CONTACT_EMAIL	string	The contact email that will be displayed on the app.	[USER DETERMINED]	[email protected]
VUE_APP_CQC_LOCATION_ACTIVE	boolean	Flag to enable/disable CQC feature within the Admin app.	true or false	true
VUE_APP_SERVICE_TAGS	boolean	Flag to enable/disable the service tags feature within the Admin app.	true or false	true

Metadata

Author: @Mike