Turn your audience into a business. Publishing, memberships, subscriptions and newsletters.
Go to file
Chris Raible c1f9740665
Added opt-in ghost service to docker compose (#21938)
ref
https://linear.app/ghost/issue/ENG-1957/add-ghost-service-to-base-docker-compose-setup

- Currently our `compose.yml` file only runs Ghost's supporting
services, and it's expected that you'll run Ghost locally on your host
machine. This commit adds a `ghost` service to our `compose.yml` file,
so you can optionally run Ghost itself in a container using docker
compose.
- The `ghost` service is opt-in using [docker compose
profiles](https://docs.docker.com/compose/how-tos/profiles/), to
maintain the current behavior of only running supporting services as the
default.
- This commit also fixes an issue in the Dockerfile: the `WORKDIR` arg,
which is used to optionally specify an alternative working directory, is
not propagated from one build stage to the next, so it has to be
manually added as an `ARG` in each stage. This was necessary to use the
same Dockerfile for devcontainers (which require the WORKDIR to be
`/workspaces/ghost`) and docker compose, where we use `/home/ghost` in
alignment with the production image.
2025-01-07 14:16:43 -08:00
.devcontainer Added redis data volume to compose setup (#21906) 2024-12-17 13:14:21 -08:00
.docker Added opt-in ghost service to docker compose (#21938) 2025-01-07 14:16:43 -08:00
.github Enabled stalebot on PRs after 1 year 2024-12-19 15:59:24 +00:00
.vscode Changed VSCode settings.json to ignore git submodules (#21286) 2024-10-13 07:21:53 -07:00
apps Disable "Create" button after first click in "Create newsletter" modal 2025-01-07 16:56:13 +00:00
ghost Removed Admin UI for enabling URL cache 2025-01-07 11:11:42 +01:00
.dockerignore Added Dev Container setup (#21279) 2024-10-24 11:15:08 -07:00
.editorconfig Removed Makefile settings from .editorconfig 2019-07-31 17:21:16 +08:00
.gitattributes Enforced unix line endings (#9871) 2018-10-23 10:59:09 +02:00
.gitignore Added Dev Container setup (#21279) 2024-10-24 11:15:08 -07:00
.gitmodules Added Source as the new default theme 2023-10-03 14:02:08 +02:00
compose.yml Added opt-in ghost service to docker compose (#21938) 2025-01-07 14:16:43 -08:00
LICENSE 2025 2025-01-06 11:40:59 +00:00
nx.json Added build:ts dependency to yarn test:unit (#21328) 2024-10-16 12:15:14 -07:00
package.json Rewrote clean.sh script in javascript (#21909) 2024-12-17 18:00:38 -08:00
PRIVACY.md Removed outdated line from PRIVACY.md (#18789) 2023-12-13 12:39:45 +01:00
README.md 2025 2025-01-06 11:40:59 +00:00
SECURITY.md Updated ghost.org links 2021-01-19 13:28:36 +13:00
yarn.lock Pin dependencies 2025-01-07 12:11:37 +01:00

 

Ghost Ghost

 

Ghost.orgForumDocsContributingTwitter

Downloads Latest release Build status Contributors

 

Fiercely independent, professional publishing. Ghost is the most popular open source, headless Node.js CMS which already works with all the tools you know and love.

 

Ghost(Pro) Ghost(Pro)

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 youll 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 guideDeveloper 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 ❤️

DigitalOceanFastly

 

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.