From ac4374b1e33d845f22a045925fa2bcdb6700404f Mon Sep 17 00:00:00 2001 From: TwiN Date: Fri, 3 Oct 2025 16:51:03 -0400 Subject: [PATCH] docs: Replace Docker Hub with GHCR as primary container registry --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0a1da3ec..57b48a41 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,14 @@ _Looking for a managed solution? Check out [Gatus.io](https://gatus.io)._
Quick start -```console -docker run -p 8080:8080 --name gatus twinproduction/gatus:stable -``` -You can also use GitHub Container Registry if you prefer: ```console docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable ``` + +You can also use Docker Hub if you prefer: +```console +docker run -p 8080:8080 --name gatus twinproduction/gatus:stable +``` For more details, see [Usage](#usage)
@@ -186,18 +187,15 @@ The main features of Gatus are: ## Usage -
- Quick start - ```console -docker run -p 8080:8080 --name gatus twinproduction/gatus +docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable ``` -You can also use GitHub Container Registry if you prefer: + +You can also use Docker Hub if you prefer: ```console -docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus +docker run -p 8080:8080 --name gatus twinproduction/gatus:stable ``` If you want to create your own configuration, see [Docker](#docker) for information on how to mount a configuration file. -
Here's a simple example: ```yaml @@ -2789,24 +2787,24 @@ Many examples can be found in the [.examples](.examples) folder, but this sectio ### Docker To run Gatus locally with Docker: ```console -docker run -p 8080:8080 --name gatus twinproduction/gatus +docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable ``` Other than using one of the examples provided in the [.examples](.examples) folder, you can also try it out locally by creating a configuration file, we'll call it `config.yaml` for this example, and running the following command: ```console -docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus +docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus ghcr.io/twin/gatus:stable ``` If you're on Windows, replace `"$(pwd)"` by the absolute path to your current directory, e.g.: ```console -docker run -p 8080:8080 --mount type=bind,source=C:/Users/Chris/Desktop/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus +docker run -p 8080:8080 --mount type=bind,source=C:/Users/Chris/Desktop/config.yaml,target=/config/config.yaml --name gatus ghcr.io/twin/gatus:stable ``` To build the image locally: ```console -docker build . -t twinproduction/gatus +docker build . -t ghcr.io/twin/gatus:stable ```