mirror of
https://github.com/ItsDrike/network-monitor.git
synced 2024-12-26 05:54:34 +00:00
updated install/config section
This commit is contained in:
parent
80aad11342
commit
8d0a6f42a6
18
README.md
18
README.md
|
@ -4,11 +4,27 @@ Here's a quick start to stand-up a Docker [Prometheus](http://prometheus.io/) st
|
|||
##Pre-requisites
|
||||
Before we get started installing the Prometheus stack. Ensure you install the latest version of docker and [docker-compose](https://docs.docker.com/compose/install/) on your Docker host machine. This has also been tested with Docker for Mac and it works well.
|
||||
|
||||
##Installation & Configuration
|
||||
##Installation
|
||||
Clone the project to your Docker host.
|
||||
|
||||
If you would like to change which targets should be monitored or make configuration changes edit the [/prom/prometheus.yml](https://github.com/vegasbrianc/prometheus/blob/version-2/prometheus/prometheus.yml) file. The targets section is where you define what should be monitored by Prometheus. The names defined in this file are actually sourced from the service name in the docker-compose file. If you wish to change names of the services you can add the "container_name" parameter in the `docker-compose.yml` file.
|
||||
|
||||
## Configuration
|
||||
In order to pull GitHub stats consistently it is recommended you create a personal access token inside of GitHub. This token will allow you to query the GitHub API more frequently than a public user. [Create GitHub Token](https://github.com/settings/tokens). Copy the GitHub Token you created and paste into the bottom of [docker-compose.yml](https://github.com/vegasbrianc/github-monitoring/blob/master/docker-compose.yml) file under the metrics service section.
|
||||
|
||||
metrics:
|
||||
tty: true
|
||||
stdin_open: true
|
||||
expose:
|
||||
- 9171
|
||||
image: infinityworks/github-exporter:latest
|
||||
environment:
|
||||
- REPOS=freeCodeCamp/freeCodeCamp,docker/docker
|
||||
- GITHUB_TOKEN=<GitHub API Token see README>
|
||||
networks:
|
||||
- back-tier
|
||||
|
||||
|
||||
## Insert Enviornment settings screenshot for repo names
|
||||
## Insert GitHub API steps + Screenshot
|
||||
|
||||
|
|
Loading…
Reference in a new issue