0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-17 23:44:39 -05:00
Independent technology for modern publishing, memberships, subscriptions and newsletters.
Find a file
Chris Raible 659863a848
Adjusted docker package.json scripts for common use-cases (#22135)
no issue

- This commit includes a number of changes to the package.json scripts
for running Ghost in docker locally for development.
- In keeping with the pattern of `yarn docker:*` commands running actual
`docker compose` commands, I renamed `yarn docker:setup` to `yarn
setup:docker` since this is a script that runs locally, rather than in
docker
- Modified the `yarn docker <command>` script to remove `yarn`, so you
can now use this to run any arbitrary command in a disposable container
- Added `yarn docker:build` as a shortcut to build the container
- Added `yarn docker:shell` as a shortcut for launching a bash shell in
a disposable container
- Added `yarn docker:restart` command to stop and restart all background
services in detached mode
- Removed `yarn compose` script for the devcontainer setup, to avoid
confusion
2025-02-06 13:34:02 -08:00
.devcontainer Added redis data volume to compose setup (#21906) 2024-12-17 13:14:21 -08:00
.docker Revert "Disabled nx daemon in docker container (#22066)" (#22067) 2025-01-29 01:50:03 +00:00
.github Added support for portal & other apps in containerized Ghost (#22121) 2025-02-05 18:18:58 -08:00
.vscode Changed VSCode settings.json to ignore git submodules (#21286) 2024-10-13 07:21:53 -07:00
apps Improved repost UI (#22129) 2025-02-06 20:35:47 +00:00
ghost Fixed some flaky portal browser tests (#22133) 2025-02-06 11:39:24 -08:00
.dockerignore Added Dev Container setup (#21279) 2024-10-24 11:15:08 -07:00
.editorconfig
.gitattributes
.gitignore Added Dev Container setup (#21279) 2024-10-24 11:15:08 -07:00
.gitmodules
compose.yml Removed unused environment variable from compose.yml (#22134) 2025-02-06 13:05:40 -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 Adjusted docker package.json scripts for common use-cases (#22135) 2025-02-06 13:34:02 -08:00
PRIVACY.md
README.md 2025 2025-01-06 11:40:59 +00:00
SECURITY.md
yarn.lock Removed unused sentry profiling integration (#22092) 2025-02-04 10:28:22 -08: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.