Skip to content

Commit a1cf4bf

Browse files
authored
Update readme.md
1 parent 86b54a1 commit a1cf4bf

File tree

1 file changed

+0
-42
lines changed

1 file changed

+0
-42
lines changed

.github/readme.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -91,48 +91,6 @@ Having a straight forward dashboard makes Statping-ng that much better. Quickly
9191

9292
<img style="margin:35px 0;width:100%;height:250px;" align="center" width="100%" height="250" src="https://statping-ng.github.io/assets/external/statupsc2.png" />
9393

94-
95-
96-
<h2 align="center" style="text-align:center">Quick Start</h2>
97-
<p>Here's a few quick start guides to get you going, fast.</p>
98-
99-
<h3>Docker</h3>
100-
<p>Use the <a href="https://hub.docker.com/r/adamboutcher/statping-ng">Statping Docker Image</a> to create a status page in seconds. Checkout the <a href="https://github.com/statping-ng/statping-ng/wiki/Docker">Docker Wiki</a> to view more details on how to get started using Docker.
101-
</p>
102-
103-
```bash
104-
docker run -it -p 8080:8080 adamboutcher/statping-ng
105-
```
106-
107-
<h3>Docker Compose</h3>
108-
<p>In the root (base) folder there is a standard docker-compose file that includes nginx, postgres, and Statping-ng.</p>
109-
110-
```bash
111-
docker-compose up -d
112-
```
113-
114-
<h3>Docker Compose with Automatic SSL</h3>
115-
<p>You can automatically start a Statping-ng server with automatic SSL encryption using this docker-compose file. First point your domain's DNS to the Statping-ng server, and then run this docker-compose command with DOMAIN and EMAIL. Email is for <a href="https://letsencrypt.org/">letsencrypt</a> services.</p>
116-
117-
```bash
118-
LETSENCRYPT_HOST=mydomain.com \
119-
120-
docker-compose -f docker-compose-ssl.yml up -d
121-
```
122-
123-
<p>Once your instance has started, it will take a moment to get your SSL certificate. Make sure you have a A or CNAME record on your domain that points to the IP/DNS of your server running Statping-ng.</p>
124-
125-
<h3>Prometheus Exporter</h3>
126-
<p>Statping-ng includes a <a href="https://github.com/statping-ng/statping-ng/wiki/Prometheus-Exporter">Prometheus Exporter</a> so you can have even more monitoring power with your services. The Prometheus exporter can be seen on <kbd>/metrics</kbd>, simply create another exporter in your prometheus config. Use your Statping-ng API Secret for the Authorization Bearer header, the <kbd>/metrics</kbd> URL is dedicated for Prometheus and requires the correct API Secret has <kbd>Authorization</kbd> header.</p>
127-
128-
```yaml
129-
scrape_configs:
130-
- job_name: 'statping'
131-
bearer_token: 'MY API SECRET HERE'
132-
static_configs:
133-
- targets: ['statping:8080']
134-
```
135-
13694
[build_url]: https://github.com/dockur/statping/
13795
[hub_url]: https://hub.docker.com/r/dockurr/statping/
13896
[tag_url]: https://hub.docker.com/r/dockurr/statping/tags

0 commit comments

Comments
 (0)