Skip to content

Commit eaf1dbf

Browse files
Add docs
1 parent ee925ef commit eaf1dbf

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# ping
2-
Container to ping a host, internal ones mostly, utilizing node-ping and reporting to Newrelic.
2+
Container to ping a host, internal ones mostly, utilizing node-ping and reporting to Newrelic through [Events API](https://docs.newrelic.com/docs/data-apis/ingest-apis/introduction-event-api/#submit-event).
33

4-
Get the latest [package version](https://github.com/RabeaWahab/ping/pkgs/container/ping)
4+
Get the latest [package version](https://github.com/CityFurniture/ping/pkgs/container/ping)
55
```
6-
docker pull ghcr.io/rabeawahab/ping:main
6+
docker pull ghcr.io/CityFurniture/ping:main
77
```
88

9-
Run container, passing PING_HOST as a string, defaults to google.com, and PING_INTERVAL in milliseconds, defaults to 5000.
10-
```
11-
docker run ghcr.io/rabeawahab/ping:main -e PING_HOST=google.com -e PING_INTERVAL=2000 -e NEWRELIC_LICENSE_KEY={YOUR_LICENSE_KEY_FROM_NR}
9+
Run container, passing PING_HOST as a string, defaults to example.com, and PING_INTERVAL in milliseconds, defaults to 5000.
10+
11+
You will need to pieces of info from NR:
12+
- Account ID
13+
- API Key
14+
15+
#####One-liner
16+
17+
```go
18+
docker run -e "NEW_RELIC_ACCOUNT_ID={NEW_RELIC_ACCOUNT_ID}" -e "NEW_RELIC_API_KEY={NEW_RELIC_API_KEY}" -e "PING_HOST=example.com" -e "PING_INTERVAL=2000" ghcr.io/CityFurniture/ping:main
1219
```

0 commit comments

Comments
 (0)