grafana/README.md

[Grafana](https://grafana.com) [![Circle CI](https://circleci.com/gh/grafana/grafana.svg?style=svg)](https://circleci.com/gh/grafana/grafana) [![Go Report Card](https://goreportcard.com/badge/github.com/grafana/grafana)](https://goreportcard.com/report/github.com/grafana/grafana)
================
[Website](https://grafana.com) |
[Twitter](https://twitter.com/grafana) |
[Community & Forum](https://community.grafana.com)

Grafana is an open source, feature rich metrics dashboard and graph editor for
Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.

![](http://docs.grafana.org/assets/img/features/dashboard_ex1.png)

## Installation
Head to [docs.grafana.org](http://docs.grafana.org/installation/) and [download](https://grafana.com/get)
the latest release.

If you have any problems please read the [troubleshooting guide](http://docs.grafana.org/installation/troubleshooting/).

## Documentation & Support
Be sure to read the [getting started guide](http://docs.grafana.org/guides/gettingstarted/) and the other feature guides.

## Run from master
If you want to build a package yourself, or contribute. Here is a guide for how to do that. You can always find
the latest master builds [here](https://grafana.com/grafana/download)

### Dependencies

- Go 1.9
- NodeJS LTS

### Building the backend
```bash
go get github.com/grafana/grafana
cd ~/go/src/github.com/grafana/grafana
go run build.go setup
go run build.go build
```

### Building frontend assets

To build less to css for the frontend you will need a recent version of **node (v6+)**,
npm (v2.5.0) and grunt (v0.4.5). Run the following:

```bash
npm install -g yarn
yarn install --pure-lockfile
npm run build
```

To rebuild frontend assets (typesript, sass etc) as you change them start
the watcher via.

```bash
npm run watch
```

Run tests
```bash
npm run test
```

Run tests in watch mode
```bash
npm run watch-test
```

### Recompile backend on source change
To rebuild on source change.
```bash
go get github.com/Unknwon/bra
bra run
```

Open grafana in your browser (default: `http://localhost:3000`) and login with admin user (default: `user/pass = admin/admin`).

### Dev config

Create a custom.ini in the conf directory to override default configuration options.
You only need to add the options you want to override. Config files are applied in the order of:

1. grafana.ini
1. custom.ini

## Contribute
If you have any idea for an improvement or found a bug do not hesitate to open an issue.
And if you have time clone this repo and submit a pull request and help me make Grafana
the kickass metrics & devops dashboard we all dream about!

## License
Grafana is distributed under Apache 2.0 License.
Work in progress Grafana 2.0 (with included Grafana backend)
Update README.md 2017-09-01 13:16:42 +08:00			`[Grafana](https://grafana.com) [![Circle CI](https://circleci.com/gh/grafana/grafana.svg?style=svg)](https://circleci.com/gh/grafana/grafana) [![Go Report Card](https://goreportcard.com/badge/github.com/grafana/grafana)](https://goreportcard.com/report/github.com/grafana/grafana)`
updated readme.md 2014-07-15 02:53:20 +08:00			`================`
Update README.md 2017-03-14 04:32:28 +08:00			`[Website](https://grafana.com) \|`
http -> https for external links 2015-03-25 19:17:22 +08:00			`[Twitter](https://twitter.com/grafana) \|`
Update README.md 2017-03-14 06:05:47 +08:00			`[Community & Forum](https://community.grafana.com)`
Initial import 2013-01-26 12:10:28 +08:00
readme cleanup 2015-03-25 19:03:20 +08:00			`Grafana is an open source, feature rich metrics dashboard and graph editor for`
updated readme 2015-11-12 20:50:57 +08:00			`Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.`
updated readme.md 2014-07-15 02:53:20 +08:00
Update README.md 2017-03-14 04:32:28 +08:00			`![](http://docs.grafana.org/assets/img/features/dashboard_ex1.png)`
Updated readme 2015-03-29 19:39:51 +08:00
updated readme.md again 2014-08-12 15:24:58 +08:00			`## Installation`
reduce readme to be about the code 2017-09-07 21:26:08 +08:00			`Head to [docs.grafana.org](http://docs.grafana.org/installation/) and [download](https://grafana.com/get)`
Updated readme, and other small changes for 1.7.0-rc1 release 2014-08-05 18:27:03 +08:00			`the latest release.`
updated readme 2014-01-20 00:16:57 +08:00
Updated readme 2015-03-29 19:30:03 +08:00			`If you have any problems please read the [troubleshooting guide](http://docs.grafana.org/installation/troubleshooting/).`
Fixes #302, year dates in changelog was 2013, now corrected to 2014, thx LordFPL for spotting this 2014-04-09 18:36:35 +08:00
updated readme.md again 2014-08-12 15:24:58 +08:00			`## Documentation & Support`
Updated readme 2015-03-29 19:30:03 +08:00			`Be sure to read the [getting started guide](http://docs.grafana.org/guides/gettingstarted/) and the other feature guides.`
updated readme.md 2014-01-20 17:57:59 +08:00
updated readme.md again 2014-08-12 15:24:58 +08:00			`## Run from master`
Fix typo 2015-09-09 04:16:51 +08:00			`If you want to build a package yourself, or contribute. Here is a guide for how to do that. You can always find`
Update README.md 2017-03-14 04:32:28 +08:00			`the latest master builds [here](https://grafana.com/grafana/download)`
Updated readme 2015-03-29 19:30:03 +08:00
			`### Dependencies`

change go version to 1.9 2017-09-18 21:18:02 +08:00			`- Go 1.9`
docs: updated go and node version requirements for building, fixes #8097 2017-04-12 12:38:37 +08:00			`- NodeJS LTS`
Updated readme 2015-03-29 19:30:03 +08:00
			`### Building the backend`
docs(readme): declare code as bash 2016-02-10 19:08:04 +08:00			```bash
reduce readme to be about the code 2017-09-07 21:26:08 +08:00			`go get github.com/grafana/grafana`
			`cd ~/go/src/github.com/grafana/grafana`
tech(build): update build docs 2016-09-15 19:09:33 +08:00			`go run build.go setup`
Update README.md 2015-12-03 19:03:06 +08:00			`go run build.go build`
Updated readme 2015-03-29 19:30:03 +08:00			```

			`### Building frontend assets`

docs: update nodejs version requirement in readme 2017-02-03 23:15:37 +08:00			`To build less to css for the frontend you will need a recent version of node (v6+),`
Updated readme 2015-03-29 19:30:03 +08:00			`npm (v2.5.0) and grunt (v0.4.5). Run the following:`

docs(readme): declare code as bash 2016-02-10 19:08:04 +08:00			```bash
tech(build): replace npm with yarn (#7108) * tech(build): replace npm with yarn * tech(build): change node version for CI 2017-01-06 14:28:43 +08:00			`npm install -g yarn`
tech(build): yarn install should use --pure-lockfile 2017-01-12 22:36:44 +08:00			`yarn install --pure-lockfile`
add basic Makefile, remove need for global grunt-cli 2016-04-26 00:44:26 +08:00			`npm run build`
Updated readme 2015-03-29 19:30:03 +08:00			```

Webpack (#9391) * webpack poc, this is not going to work for plugins, dam * tech: webpack and systemjs for plugins starting to work * tech: webpack and systemjs combo starting to work * tech: webpack + karma tests progress * tech: webpack + karma progress * tech: working on tests * tech: webpack * tech: webpack + karma, all tests pass * tech: webpack + karma, all tests pass * tech: webpack all tests pass * webpack: getting closer * tech: webpack progress * webpack: further build refinements * webpack: ng annotate fixes * webpack: optimized build fix * tech: minor fix for elasticsearch * tech: webpack + ace editor * tech: restored lodash move mixin compatability * tech: added enzyme react test and upgraded to react v16 * tech: package version fix * tech: added testdata to built in bundle * webpack: sass progress * tech: prod & dev build is working for the sass * tech: clean up unused grunt stuff and moved to scripts folder * tech: added vendor and manifest chunks, updated readme and docs * tech: webpack finishing touches 2017-10-02 02:02:25 +08:00			`To rebuild frontend assets (typesript, sass etc) as you change them start`
			`the watcher via.`
Add more documentation on how to contribute Add more documentation on how to fork the project, and how to build on changes using grunt 2016-05-03 02:36:06 +08:00
			```bash
Webpack (#9391) * webpack poc, this is not going to work for plugins, dam * tech: webpack and systemjs for plugins starting to work * tech: webpack and systemjs combo starting to work * tech: webpack + karma tests progress * tech: webpack + karma progress * tech: working on tests * tech: webpack * tech: webpack + karma, all tests pass * tech: webpack + karma, all tests pass * tech: webpack all tests pass * webpack: getting closer * tech: webpack progress * webpack: further build refinements * webpack: ng annotate fixes * webpack: optimized build fix * tech: minor fix for elasticsearch * tech: webpack + ace editor * tech: restored lodash move mixin compatability * tech: added enzyme react test and upgraded to react v16 * tech: package version fix * tech: added testdata to built in bundle * webpack: sass progress * tech: prod & dev build is working for the sass * tech: clean up unused grunt stuff and moved to scripts folder * tech: added vendor and manifest chunks, updated readme and docs * tech: webpack finishing touches 2017-10-02 02:02:25 +08:00			`npm run watch`
			```

			`Run tests`
			```bash
			`npm run test`
			```

			`Run tests in watch mode`
			```bash
shore: minor cleanup 2017-10-02 02:35:01 +08:00			`npm run watch-test`
Add more documentation on how to contribute Add more documentation on how to fork the project, and how to build on changes using grunt 2016-05-03 02:36:06 +08:00			```

Updated readme 2015-03-29 19:30:03 +08:00			`### Recompile backend on source change`
tech(build): update build docs 2016-09-15 19:09:33 +08:00			`To rebuild on source change.`
docs(readme): declare code as bash 2016-02-10 19:08:04 +08:00			```bash
Updated readme 2015-03-29 19:30:03 +08:00			`go get github.com/Unknwon/bra`
			`bra run`
			```

fix cla link; formatting and grammar fixes 2016-10-21 04:08:12 +08:00			Open grafana in your browser (default: `http://localhost:3000`) and login with admin user (default: `user/pass = admin/admin`).
Updated readme 2015-03-29 19:30:03 +08:00
			`### Dev config`

			`Create a custom.ini in the conf directory to override default configuration options.`
			`You only need to add the options you want to override. Config files are applied in the order of:`

			`1. grafana.ini`
docs(readme): remove dev.ini reference (#8419) remove dev.ini reference as it seems not working anymore. 2017-05-21 16:07:21 +08:00			`1. custom.ini`
Updated readme 2015-03-29 19:30:03 +08:00
Fix the first CLA link. 2015-04-30 04:35:03 +08:00			`## Contribute`
updated readme.md with a run from master section 2014-08-12 15:23:25 +08:00			`If you have any idea for an improvement or found a bug do not hesitate to open an issue.`
			`And if you have time clone this repo and submit a pull request and help me make Grafana`
			`the kickass metrics & devops dashboard we all dream about!`
updated readme.md 2014-01-20 17:57:59 +08:00
updated readme.md again 2014-08-12 15:24:58 +08:00			`## License`
Fixed installation instructions for config.js Because you cannot edit the file which does not even exist. 2014-03-31 22:22:55 +08:00			`Grafana is distributed under Apache 2.0 License.`
Merge branch 'master' of /home/torkel/dev/go/src/github.com/torkelo/backend Conflicts: .gitignore LICENSE.md README.md 2015-02-05 17:10:39 +08:00			`Work in progress Grafana 2.0 (with included Grafana backend)`