mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-03-04 02:01:58 -05:00
5547c0b6f0
no issue - To run Ghost itself in docker compose, you need to enable the `ghost` compose profile by setting `COMPOSE_PROFILES=ghost`. - This is done for you if you use the `yarn docker:*` commands, but if you run any other `docker compose ...` commands manually, the `ghost` profile won't be enabled by default. - The easiest way to set `COMPOSE_PROFILES` is with a `.env` file in the root of the repo. This `.env.example` file is a template than can be easily copied to `.env` by running `cp .env.example .env`, which will in turn enable the `ghost` profile. - It also includes commented out environment variables that are useful when running Ghost in Docker compose, such as stripe keys, app flags (for running e.g. portal), and `DEBUG` modes. This commit also includes some minor changes to the `dev.js` script: - Adds a list of `availableFlags`, including all the app flags that it will accept - Adds validation to log an error and exit if any invalid flags are passed. This will force us to keep this list up to date if/when we add more app flags - Adds a `show-flags` flag, which will print all the available flags, along with a description, then immediately exit. Ultimately this makes getting started with docker compose more straight forward: - Clone the repo - Run `cp .env.example .env` to enable the `ghost` profile - Run `docker compose up`
23 lines
805 B
Text
23 lines
805 B
Text
# Environment variables for Ghost development with docker compose
|
|
## Use this file by running `cp .env.example .env` and then editing the values as needed
|
|
|
|
# Docker Compose profiles to enable
|
|
## Run `docker compose config --profiles` to see all available profiles
|
|
## See https://docs.docker.com/compose/how-tos/profiles/ for more information
|
|
COMPOSE_PROFILES=ghost
|
|
|
|
# Debug level to pass to Ghost
|
|
# DEBUG=
|
|
|
|
# App flags to pass to the dev command
|
|
## Run `yarn dev --show-flags` to see all available app flags
|
|
|
|
# GHOST_DEV_APP_FLAGS=
|
|
|
|
# Stripe keys - used to forward Stripe webhooks to the Ghost instance in `dev.js` script
|
|
## Stripe Secret Key: sk_test_*******
|
|
# STRIPE_SECRET_KEY=
|
|
## Stripe Publishable Key: pk_test_*******
|
|
#STRIPE_PUBLISHABLE_KEY=
|
|
## Stripe Account ID: acct_1*******
|
|
#STRIPE_ACCOUNT_ID=
|