From 8f50e44b452f42f480a53a4a3a478fae21e296bc Mon Sep 17 00:00:00 2001 From: TwiN Date: Sun, 24 Oct 2021 15:20:39 -0400 Subject: [PATCH] #167: Rename examples/ to .examples/ --- .dockerignore | 2 +- .../config.yaml | 0 .../docker-compose.yml | 0 .../grafana/grafana.ini | 0 .../provisioning/dashboards/dashboard.yml | 0 .../grafana/provisioning/dashboards/main.json | 0 .../provisioning/datasources/prometheus.yml | 0 .../prometheus/prometheus.yml | 0 .../docker-compose-mattermost/config.yaml | 0 .../docker-compose.yml | 0 .../config.yaml | 0 .../docker-compose.yml | 0 .../docker-compose-sqlite-storage/config.yaml | 0 .../data/.gitkeep | 0 .../docker-compose.yml | 0 .../docker-compose/config.yaml | 0 .../docker-compose/docker-compose.yml | 0 {examples => .examples}/kubernetes/gatus.yaml | 0 {examples => .examples}/minimal/Dockerfile | 0 {examples => .examples}/minimal/config.yaml | 0 README.md | 20 +++++++++---------- 21 files changed, 11 insertions(+), 11 deletions(-) rename {examples => .examples}/docker-compose-grafana-prometheus/config.yaml (100%) rename {examples => .examples}/docker-compose-grafana-prometheus/docker-compose.yml (100%) rename {examples => .examples}/docker-compose-grafana-prometheus/grafana/grafana.ini (100%) rename {examples => .examples}/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/dashboard.yml (100%) rename {examples => .examples}/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/main.json (100%) rename {examples => .examples}/docker-compose-grafana-prometheus/grafana/provisioning/datasources/prometheus.yml (100%) rename {examples => .examples}/docker-compose-grafana-prometheus/prometheus/prometheus.yml (100%) rename {examples => .examples}/docker-compose-mattermost/config.yaml (100%) rename {examples => .examples}/docker-compose-mattermost/docker-compose.yml (100%) rename {examples => .examples}/docker-compose-postgres-storage/config.yaml (100%) rename {examples => .examples}/docker-compose-postgres-storage/docker-compose.yml (100%) rename {examples => .examples}/docker-compose-sqlite-storage/config.yaml (100%) rename {examples => .examples}/docker-compose-sqlite-storage/data/.gitkeep (100%) rename {examples => .examples}/docker-compose-sqlite-storage/docker-compose.yml (100%) rename {examples => .examples}/docker-compose/config.yaml (100%) rename {examples => .examples}/docker-compose/docker-compose.yml (100%) rename {examples => .examples}/kubernetes/gatus.yaml (100%) rename {examples => .examples}/minimal/Dockerfile (100%) rename {examples => .examples}/minimal/config.yaml (100%) diff --git a/.dockerignore b/.dockerignore index db44172e..96af659d 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,4 +1,4 @@ -examples +.examples Dockerfile .github .idea diff --git a/examples/docker-compose-grafana-prometheus/config.yaml b/.examples/docker-compose-grafana-prometheus/config.yaml similarity index 100% rename from examples/docker-compose-grafana-prometheus/config.yaml rename to .examples/docker-compose-grafana-prometheus/config.yaml diff --git a/examples/docker-compose-grafana-prometheus/docker-compose.yml b/.examples/docker-compose-grafana-prometheus/docker-compose.yml similarity index 100% rename from examples/docker-compose-grafana-prometheus/docker-compose.yml rename to .examples/docker-compose-grafana-prometheus/docker-compose.yml diff --git a/examples/docker-compose-grafana-prometheus/grafana/grafana.ini b/.examples/docker-compose-grafana-prometheus/grafana/grafana.ini similarity index 100% rename from examples/docker-compose-grafana-prometheus/grafana/grafana.ini rename to .examples/docker-compose-grafana-prometheus/grafana/grafana.ini diff --git a/examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/dashboard.yml b/.examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/dashboard.yml similarity index 100% rename from examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/dashboard.yml rename to .examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/dashboard.yml diff --git a/examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/main.json b/.examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/main.json similarity index 100% rename from examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/main.json rename to .examples/docker-compose-grafana-prometheus/grafana/provisioning/dashboards/main.json diff --git a/examples/docker-compose-grafana-prometheus/grafana/provisioning/datasources/prometheus.yml b/.examples/docker-compose-grafana-prometheus/grafana/provisioning/datasources/prometheus.yml similarity index 100% rename from examples/docker-compose-grafana-prometheus/grafana/provisioning/datasources/prometheus.yml rename to .examples/docker-compose-grafana-prometheus/grafana/provisioning/datasources/prometheus.yml diff --git a/examples/docker-compose-grafana-prometheus/prometheus/prometheus.yml b/.examples/docker-compose-grafana-prometheus/prometheus/prometheus.yml similarity index 100% rename from examples/docker-compose-grafana-prometheus/prometheus/prometheus.yml rename to .examples/docker-compose-grafana-prometheus/prometheus/prometheus.yml diff --git a/examples/docker-compose-mattermost/config.yaml b/.examples/docker-compose-mattermost/config.yaml similarity index 100% rename from examples/docker-compose-mattermost/config.yaml rename to .examples/docker-compose-mattermost/config.yaml diff --git a/examples/docker-compose-mattermost/docker-compose.yml b/.examples/docker-compose-mattermost/docker-compose.yml similarity index 100% rename from examples/docker-compose-mattermost/docker-compose.yml rename to .examples/docker-compose-mattermost/docker-compose.yml diff --git a/examples/docker-compose-postgres-storage/config.yaml b/.examples/docker-compose-postgres-storage/config.yaml similarity index 100% rename from examples/docker-compose-postgres-storage/config.yaml rename to .examples/docker-compose-postgres-storage/config.yaml diff --git a/examples/docker-compose-postgres-storage/docker-compose.yml b/.examples/docker-compose-postgres-storage/docker-compose.yml similarity index 100% rename from examples/docker-compose-postgres-storage/docker-compose.yml rename to .examples/docker-compose-postgres-storage/docker-compose.yml diff --git a/examples/docker-compose-sqlite-storage/config.yaml b/.examples/docker-compose-sqlite-storage/config.yaml similarity index 100% rename from examples/docker-compose-sqlite-storage/config.yaml rename to .examples/docker-compose-sqlite-storage/config.yaml diff --git a/examples/docker-compose-sqlite-storage/data/.gitkeep b/.examples/docker-compose-sqlite-storage/data/.gitkeep similarity index 100% rename from examples/docker-compose-sqlite-storage/data/.gitkeep rename to .examples/docker-compose-sqlite-storage/data/.gitkeep diff --git a/examples/docker-compose-sqlite-storage/docker-compose.yml b/.examples/docker-compose-sqlite-storage/docker-compose.yml similarity index 100% rename from examples/docker-compose-sqlite-storage/docker-compose.yml rename to .examples/docker-compose-sqlite-storage/docker-compose.yml diff --git a/examples/docker-compose/config.yaml b/.examples/docker-compose/config.yaml similarity index 100% rename from examples/docker-compose/config.yaml rename to .examples/docker-compose/config.yaml diff --git a/examples/docker-compose/docker-compose.yml b/.examples/docker-compose/docker-compose.yml similarity index 100% rename from examples/docker-compose/docker-compose.yml rename to .examples/docker-compose/docker-compose.yml diff --git a/examples/kubernetes/gatus.yaml b/.examples/kubernetes/gatus.yaml similarity index 100% rename from examples/kubernetes/gatus.yaml rename to .examples/kubernetes/gatus.yaml diff --git a/examples/minimal/Dockerfile b/.examples/minimal/Dockerfile similarity index 100% rename from examples/minimal/Dockerfile rename to .examples/minimal/Dockerfile diff --git a/examples/minimal/config.yaml b/.examples/minimal/config.yaml similarity index 100% rename from examples/minimal/config.yaml rename to .examples/minimal/config.yaml diff --git a/README.md b/README.md index a73fb3b6..d05c3a43 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ core applications: https://status.twin.sh/
Quick start -``` +```console docker run -p 8080:8080 --name gatus twinproduction/gatus ``` For more details, see [Usage](#usage) @@ -246,7 +246,7 @@ storage: type: sqlite file: data.db ``` -See [examples/docker-compose-sqlite-storage](examples/docker-compose-sqlite-storage) for an example. +See [examples/docker-compose-sqlite-storage](.examples/docker-compose-sqlite-storage) for an example. - If `storage.type` is `postgres`, `storage.file` must be the connection URL: ```yaml @@ -254,7 +254,7 @@ storage: type: postgres file: "postgres://user:password@127.0.0.1:5432/gatus?sslmode=disable" ``` -See [examples/docker-compose-postgres-storage](examples/docker-compose-postgres-storage) for an example. +See [examples/docker-compose-postgres-storage](.examples/docker-compose-postgres-storage) for an example. ### Client configuration @@ -798,29 +798,29 @@ maintenance: ## Deployment -Many examples can be found in the [examples](examples) folder, but this section will focus on the most popular ways of deploying Gatus. +Many examples can be found in the [.examples](.examples) folder, but this section will focus on the most popular ways of deploying Gatus. ### Docker To run Gatus locally with Docker: -``` +```console docker run -p 8080:8080 --name gatus twinproduction/gatus ``` -Other than using one of the examples provided in the `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 command: -``` +```console docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus ``` 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 ``` To build the image locally: -``` +```console docker build . -t twinproduction/gatus ``` @@ -845,7 +845,7 @@ Gatus can be deployed on Terraform by using the following module: [terraform-kub ## Running the tests -``` +```console go test ./... -mod vendor ```