mirrors/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2026-02-04 15:14:43 +00:00
Code Activity

docs: Replace Docker Hub with GHCR as primary container registry

Browse Source
This commit is contained in:
TwiN
2025-10-03 16:51:03 -04:00
parent 129fb82f71
commit ac4374b1e3
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -20,13 +20,14 @@ _Looking for a managed solution? Check out [Gatus.io](https://gatus.io)._
<details> <details>
<summary><b>Quick start</b></summary> <summary><b>Quick start</b></summary>
```console
docker run -p 8080:8080 --name gatus twinproduction/gatus:stable
```
You can also use GitHub Container Registry if you prefer:
```console ```console
docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable 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) For more details, see [Usage](#usage)
</details> </details>
@@ -186,18 +187,15 @@ The main features of Gatus are:
## Usage ## Usage
<details>
<summary><b>Quick start</b></summary>
```console ```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 ```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. If you want to create your own configuration, see [Docker](#docker) for information on how to mount a configuration file.
</details>
Here's a simple example: Here's a simple example:
```yaml ```yaml
@@ -2789,24 +2787,24 @@ Many examples can be found in the [.examples](.examples) folder, but this sectio
### Docker ### Docker
To run Gatus locally with Docker: To run Gatus locally with Docker:
```console ```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 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 creating a configuration file, we'll call it `config.yaml` for this example, and running the following
command: command:
```console ```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.: If you're on Windows, replace `"$(pwd)"` by the absolute path to your current directory, e.g.:
```console ```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: To build the image locally:
```console ```console
docker build . -t twinproduction/gatus docker build . -t ghcr.io/twin/gatus:stable
``` ```