Prep readme for opensourcing
parent
fc2eb308a0
commit
30745b7c04
52
README.md
52
README.md
|
@ -1,32 +1,40 @@
|
|||
# chronograf
|
||||
# Chronograf
|
||||
|
||||
## An Open-Source UI for Monitoring and Alerting your Infrastructure
|
||||
Chronograf is an open-source web application written in go and react.js that is designed to simply and easily visualize your monitoring data and provide tools to create alerting and automation rules.
|
||||
|
||||
## Features
|
||||
* High level infrastructure view and search
|
||||
* Application specific monitoring for:
|
||||
* System stats
|
||||
* InfluxDB
|
||||
* Docker Containers
|
||||
* Kuberentes
|
||||
* Reids
|
||||
* NSQ
|
||||
* MySQL
|
||||
* Postgres
|
||||
* Kapacitor alert creation and tracking
|
||||
|
||||
## Installation
|
||||
|
||||
We recommend installing Chrongraf using one of the [pre-built packages](https://influxdata.com/downloads/#chronograf). Then start Chronograf using:
|
||||
|
||||
* `service chronograf start` if you have installed Chronograf using an official Debian or RPM package.
|
||||
* `systemctl start chronograf` if you have installed Chronograf using an official Debian or RPM package, and are running a distro with `systemd`. For example, Ubuntu 15 or later.
|
||||
* `$GOPATH/bin/chronograf` if you have built Chronograf from source.
|
||||
|
||||
## Builds
|
||||
|
||||
* Chronograf works with go 1.7.3, npm 3.10.7 and node v6.6.0. Additional version support of these projects will be implemented soon, but these are the only supported versions to date.
|
||||
* To build assets and the go server, run `make`.
|
||||
* To run server either `./chronograf --port 8888` or `make run`
|
||||
* If you add files to the javascript build and you don't want to rebuild everything, run `make bindata && make chronograf`
|
||||
|
||||
## Deployment (for now)
|
||||
Includes a Dockerfile that builds a container suitable for Heroku.
|
||||
## Getting Started
|
||||
See the [getting started](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md) guide for setup instructions for chronograf and the other components of the [TICK stack](https://www.influxdata.com/get-started/what-is-the-tick-stack/)
|
||||
|
||||
In order to push to heroku, make sure you've logged into Heroku normally with...
|
||||
## Contributing
|
||||
|
||||
`heroku login`
|
||||
Please see the [contributing guide](CONTRIBUTING.md) for details on contributing to Chronograf.
|
||||
|
||||
Add the acceptance server git remote...
|
||||
|
||||
`git remote add acceptance https://git.heroku.com/chronograf-acc.git`
|
||||
|
||||
When you run `heroku apps` you should see "chronograf-acc".
|
||||
|
||||
Then install the container plugin
|
||||
`heroku plugins:install heroku-container-registry`
|
||||
|
||||
Then log into the container registry with...
|
||||
|
||||
`heroku container:login`
|
||||
|
||||
Build and push the web container by running...
|
||||
|
||||
`heroku container:push web`
|
||||
|
||||
|
|
Loading…
Reference in New Issue