mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-23 03:42:27 +03:00

Turn your audience into a business. Publishing, memberships, subscriptions and newsletters.

blogging cms ember ghost hacktoberfest headless-cms jamstack javascript journalism nodejs publishing web-application

Go to file

Chris Raible 8b26b52513 Added prometheus and grafana services to docker compose (#21213 ) ref https://linear.app/tryghost/issue/ENG-1591/add-prometheus-and-grafana-services-to-docker-compose This commit adds 2 new services to the docker compose file to enable monitoring metrics from Ghost locally in real-time: 1. Prometheus - a service that scrapes Ghost's new `/metrics` endpoint introduced in this [commit](`768336efad`). 2. Grafana - a service that consumes the metrics from prometheus and exposes them in a dashboard that you can view locally at `localhost:3000`. # Usage Both of these services are selectively enabled using docker compose [profiles](https://docs.docker.com/compose/how-tos/profiles/). This way, if you don't opt-in to using these monitoring tools, they won't start and consume resources on your host machine. To enable these services, enable the `monitoring` profile by either setting the `COMPOSE_PROFILES` environment variable to `monitoring`, or specifying the `--profile monitoring` CLI argument to any `docker compose ...` commands. I've found the easiest way to configure this in an 'always on' fashion is to create a `.env` file in the project's root directory and add `COMPOSE_PROFILES=monitoring` to it. As an added convenience, you can also set `COMPOSE_FILE=.github/scripts/docker-compose.yml`, which will allow you to run `docker compose ...` commands from the root directory without specifying the full path each time. # Intended for development only These services are meant for local development only, and are not configured for a production use-case. For example, the Grafana instance is configured to have _no authorization_ so you won't need a username/password to login at `localhost:3000`. Prometheus is also configured to scrape the metrics once every second, which is likely excessive for production use-cases, but may be useful for getting more granular metrics while e.g. load testing locally. # Dashboards The Grafana instance includes a default dashboard including most of the main default metrics provided by our prometheus client integration. The dashboard is defined in a JSON file at `.github/scripts/docker/grafana/dashboards/main-dashboard.json' and can be modified & committed to add new visualizations that will be available to anyone work on Ghost locally. You can also add other dashboards to the same directory for specific use-cases, which should be picked up and made available in the Grafana UI. [Read more](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/view-dashboard-json-model/) about Grafana's JSON schema for dashboards.		2024-10-03 14:43:07 -07:00
.github	Added prometheus and grafana services to docker compose (#21213 )	2024-10-03 14:43:07 -07:00
.vscode	Added backend launch task	2024-01-17 17:52:36 +07:00
apps	Bumped comments-ui (#21217 )	2024-10-03 21:40:00 +00:00
ghost	🌐 Updated Hindi translations (#21208 )	2024-10-03 21:01:39 +00: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	Updated Nx to v19	2024-09-25 10:16:08 +02:00
.gitmodules	✨ Added `Source` as the new default theme	2023-10-03 14:02:08 +02:00
LICENSE	© 2024	2024-07-04 17:01:59 -04:00
nx.json	Increased parallelisation of Nx processes	2024-09-25 14:36:55 +02:00
package.json	Updated tinybird tooling with usability improvements (#21185 )	2024-10-02 15:28:39 +01:00
PRIVACY.md	Removed outdated line from PRIVACY.md (#18789 )	2023-12-13 12:39:45 +01:00
README.md	© 2024	2024-07-04 17:01:59 -04:00
SECURITY.md	Updated ghost.org links	2021-01-19 13:28:36 +13:00
yarn.lock	Pin dependency parse-prometheus-text-format to 1.1.1 (#21211 )	2024-10-03 19:16:42 +00:00

README.md

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

DigitalOcean • Fastly

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-2024 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.

README.md Unescape Escape