0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-03-11 02:12:21 -05:00
Independent technology for modern publishing, memberships, subscriptions and newsletters.
Find a file
Chris Raible cee2b99e37
Improved stripe listen command in dev.js script (#22245)
no issue

Problem:
- Running `yarn dev` with `--stripe` runs the `stripe listen ...`
command in a subprocess to forward webhook events to your local instance
of Ghost in development.
- Currently, you have to run `stripe login` manually before this will
work. If you fail to do so, the `yarn dev` script simply hangs
indefinitely without any logging to indicate why.
- Running `stripe login` manually is also a non-starter in Docker since
you'd have to do this for each new container instance, which isn't
practical.

Solution:
- Luckily the `stripe listen ...` command accepts an `--api-key`
argument, which expects your stripe secret key. This change updates the
`dev.js` script to read your stripe API key from the `STRIPE_SECRET_KEY`
environment variable if it's present. As long as `STRIPE_SECRET_KEY`
exists, you won't need to run `stripe login` anymore.
- It also adds a timeout of 5 seconds to the initial `stripe listen`
command and will exit the process if this step fails, indicating with a
clear log message that you need to either set the `STRIPE_SECRET_KEY`
variable or run `stripe login`
- I also added a bunch of debug statements to the dev script which were
useful in debugging this, and may prove useful for similar issues in the
future, so I'll leave them in there.
2025-02-19 11:04:30 -08:00
.devcontainer Added redis data volume to compose setup (#21906) 2024-12-17 13:14:21 -08:00
.docker Configured ssh agent forwarding for docker compose (#22232) 2025-02-19 09:38:05 -08:00
.github Improved stripe listen command in dev.js script (#22245) 2025-02-19 11:04:30 -08:00
.vscode Changed VSCode settings.json to ignore git submodules (#21286) 2024-10-13 07:21:53 -07:00
apps ActivityPub UI restructure (#22209) 2025-02-19 09:29:15 +01:00
ghost Fixed collection of URL service init time metrics 2025-02-19 18:44:58 +01:00
.dockerignore Improved docker development setup (#22177) 2025-02-18 23:47:39 +00:00
.editorconfig
.gitattributes
.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 Configured ssh agent forwarding for docker compose (#22232) 2025-02-19 09:38:05 -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 Update dependency nx to v19.8.14 2025-02-19 08:32:47 +01: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
yarn.lock Update dependency nx to v19.8.14 2025-02-19 08:32:47 +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.