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` |
||
|---|---|---|
| .devcontainer | ||
| .docker | ||
| .github | ||
| .vscode | ||
| apps | ||
| ghost | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.example | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| compose.yml | ||
| LICENSE | ||
| nx.json | ||
| package.json | ||
| PRIVACY.md | ||
| README.md | ||
| SECURITY.md | ||
| yarn.lock | ||
Ghost.org •
Forum •
Docs •
Contributing •
Twitter
The easiest way to get a production instance deployed is with our official Ghost(Pro) managed service. It takes about 2 minutes to launch a new site with worldwide CDN, backups, security and maintenance all done for you.
For most people this ends up being the best value option because of how much time it saves — and 100% of revenue goes to the Ghost Foundation; funding the maintenance and further development of the project itself. So you’ll be supporting open source software and getting a great service!
Quickstart install
If you want to run your own instance of Ghost, in most cases the best way is to use our CLI tool
npm install ghost-cli -g
Then, if installing locally add the local flag to get up and running in under a minute - Local install docs
ghost install local
or on a server run the full install, including automatic SSL setup using LetsEncrypt - Production install docs
ghost install
Check out our official documentation for more information about our recommended hosting stack & properly upgrading Ghost, plus everything you need to develop your own Ghost themes or work with our API.
Contributors & advanced developers
For anyone wishing to contribute to Ghost or to hack/customize core files we recommend following our full development setup guides: Contributor guide • Developer setup
Ghost sponsors
A big thanks to our sponsors and partners who make Ghost possible. If you're interested in sponsoring Ghost and supporting the project, please check out our profile on GitHub sponsors ❤️
Getting help
Everyone can get help and support from a large community of developers over on the Ghost forum. Ghost(Pro) customers have access to 24/7 email support.
To stay up to date with all the latest news and product updates, make sure you subscribe to our changelog newsletter — or follow us on Twitter, if you prefer your updates bite-sized and facetious. 🎷🐢
Copyright & license
Copyright (c) 2013-2025 Ghost Foundation - Released under the MIT license. Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our trademark policy for info on acceptable usage.