0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-03-11 02:12:21 -05:00
ghost/.github
Chris Raible 5547c0b6f0
Added .env.example file to simplify getting started with docker compose (#22247)
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`
2025-02-19 13:16:30 -08:00
..
actions/restore-cache Update actions/cache action to v4 2024-04-18 12:36:07 +02:00
hooks Improved pre-commit hook to automatically remove submodules (#21222) 2024-10-12 03:40:31 -07:00
ISSUE_TEMPLATE Switched our old style bug report template to a form 2021-11-12 10:30:08 +00:00
scripts Added .env.example file to simplify getting started with docker compose (#22247) 2025-02-19 13:16:30 -08:00
workflows Added support for Node 22 2025-02-19 10:00:50 +01:00
CODE_OF_CONDUCT.md Added contributor code of conduct 2023-10-18 12:10:05 +02:00
codecov.yml Updated workflow for code coverage 2023-07-06 09:24:45 +02:00
CONTRIBUTING.md Added translation gitmoji (#21226) 2024-10-04 16:28:31 +00:00
FUNDING.yml Update FUNDING.yml 2020-07-28 13:19:20 +07:00
PULL_REQUEST_TEMPLATE.md Removed GitHub Copilot for PRs templating value 2023-11-20 11:43:58 +01:00
SUPPORT.md Updated links to docs (#10941) 2019-07-22 18:17:50 +08:00