public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/mattttt/grafana

Browse Source 
Conflicts:
	docs/sources/installation/debian.md
	docs/sources/installation/ldap.md
This commit is contained in:
Torkel Ödegaard
2015-08-12 16:30:48 +02:00
parent e6d09b3266 8c05f9cf3e
commit 5aee981590
30 changed files with 603 additions and 210 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/installation/configuration.md
+18 -17
View File
@@ -18,7 +18,7 @@ specified in a `.ini` configuration file or specified using environment variable
> **Note.** If you have installed Grafana using the `deb` or `rpm`
> packages, then your configuration file is located at
> `/etc/grafana/grafana.ini`. This path is specified in the Grafana
> init.d script using `-config` file parameter.
> init.d script using `--config` file parameter.
## Using environment variables
@@ -37,12 +37,12 @@ should be upper case, `.` should be replaced by `_`. For example, given these co
client_secret = 0ldS3cretKey
Then you can override that using:
Then you can override them using:
export GF_SECURITY_ADMIN_USER=true
export GF_AUTH_GOOGLE_CLIENT_SECRET=newS3cretKey
<hr>
<hr />
## [paths]
@@ -63,7 +63,7 @@ file.
### http_addr
The IP address to bind to, if empty will bind to all interfaces
The IP address to bind to. If empty will bind to all interfaces
### http_port
@@ -116,9 +116,9 @@ Path to the certificate file (if `protocol` is set to `https`).
Path to the certificate key file (if `protocol` is set to `https`).
<hr>
<hr />
<hr>
<hr />
## [database]
@@ -158,7 +158,7 @@ The database user's password (not applicable for `sqlite3`).
For `postgres` only, either `disable`, `require` or `verify-full`.
<hr>
<hr />
## [security]
@@ -184,7 +184,7 @@ Used for signing keep me logged in / remember me cookies.
Set to `true` to disable the use of Gravatar for user profile images.
Default is `false`.
<hr>
<hr />
## [users]
@@ -384,29 +384,30 @@ The name of the Grafana session cookie.
### cookie_secure
Set to true if you host Grafana behind HTTPs only. Defaults to `false`.
Set to true if you host Grafana behind HTTPS only. Defaults to `false`.
### session_life_time
How long sessions lasts in seconds. Defaults to `86400` (24 hours).
<hr>
<hr />
## [analytics]
### reporting_enabled
When enabled Grafana will send anonymous usage statistics to `stats.grafana.org`.
No IP addresses are being tracked, only simple counters to track running instances,
versions, dashboard & error counts. It is very helpful to us, please leave this
enabled. Counters are sent every 24 hours. Default value is `true`.
When enabled Grafana will send anonymous usage statistics to
`stats.grafana.org`. No IP addresses are being tracked, only simple counters to
track running instances, versions, dashboard & error counts. It is very helpful
to us, so please leave this enabled. Counters are sent every 24 hours. Default
value is `true`.
### google_analytics_ua_id
If you want to track Grafana usage via Google analytics specify *your* Universal Analytics ID
here. By default this feature is disabled.
If you want to track Grafana usage via Google analytics specify *your* Universal
Analytics ID here. By default this feature is disabled.
<hr>
<hr />
## [dashboards.json]
docs/sources/installation/debian.md
+20 -20
View File
@@ -19,31 +19,32 @@ Description | Download
$ sudo dpkg -i grafana_2.1.1_amd64.deb
## APT Repository
Add the following line to your `/etc/apt/sources.list` file.
deb https://packagecloud.io/grafana/stable/debian/ wheezy main
`deb https://packagecloud.io/grafana/stable/debian/ wheezy main`
Use the above line even if you are on Ubuntu or another Debian version.
There is also a testing repository if you want beta or release
candidates.
deb https://packagecloud.io/grafana/testing/debian/ wheezy main
`deb https://packagecloud.io/grafana/testing/debian/ wheezy main`
Then add the [Package Cloud](https://packagecloud.io/grafana) key. This
allows you to install signed packages.
$ curl https://packagecloud.io/gpg.key | sudo apt-key add -
`$ curl https://packagecloud.io/gpg.key | sudo apt-key add -`
Update your Apt repositories and install Grafana
$ sudo apt-get update
$ sudo apt-get install grafana
`$ sudo apt-get update`
`$ sudo apt-get install grafana`
On some older versions of Ubuntu and Debian you may need to install the
`apt-transport-https` package which is needed to fetch packages over
HTTPS.
$ sudo apt-get install -y apt-transport-https
`$ sudo apt-get install -y apt-transport-https`
## Package details
@@ -57,9 +58,9 @@ HTTPS.
## Start the server (init.d service)
You can start Grafana by running:
Start Grafana by running:
$ sudo service grafana-server start
`$ sudo service grafana-server start`
This will start the `grafana-server` process as the `grafana` user,
which was created during the package installation. The default HTTP port
@@ -67,19 +68,19 @@ is `3000` and default user and group is `admin`.
To configure the Grafana server to start at boot time:
$ sudo update-rc.d grafana-server defaults 95 10
`$ sudo update-rc.d grafana-server defaults 95 10`
## Start the server (via systemd)
To start the service using systemd.
To start the service using systemd:
$ systemctl daemon-reload
$ systemctl start grafana-server
$ systemctl status grafana-server
`$ systemctl daemon-reload`
`$ systemctl start grafana-server`
`$ systemctl status grafana-server`
Enable the systemd service so that Grafana starts at boot.
sudo systemctl enable grafana-server.service
`sudo systemctl enable grafana-server.service`
## Environment file
@@ -96,7 +97,7 @@ By default Grafana will log to `/var/log/grafana`
The default configuration specifies a sqlite3 database located at
`/var/lib/grafana/grafana.db`. Please backup this database before
upgrades. You can also use MySQL or Postgres as the Grafana database.
upgrades. You can also use MySQL or Postgres as the Grafana database, as detailed on [the configuration page](configuration.md#database).
## Configuration
@@ -112,11 +113,10 @@ those options.
## Installing from binary tar file
Start by [downloading](http://grafana.org/download/builds) the latest
`.tar.gz` file and extract it. This will extract into a folder named
after the version you downloaded. This folder contains all files
required to run Grafana. There are no init scripts or install scripts
in this package.
Download [the latest `.tar.gz` file](http://grafana.org/download/builds) and
extract it. This will extract into a folder named after the version you
downloaded. This folder contains all files required to run Grafana. There are
no init scripts or install scripts in this package.
To configure Grafana add a configuration file named `custom.ini` to the
`conf` folder and override any of the settings defined in
docs/sources/installation/index.md
+1 -1
View File
@@ -9,7 +9,7 @@ page_keywords: grafana, installation, documentation
Grafana is easily installed via a Debian/Ubuntu package (.deb), via
Redhat/Centos package (.rpm) or manually via a tarball that contains all
required files and binaries. If you can't find a package or binary for
your platform you might be able to build one your self, read the [build
your platform, you might be able to build one yourself. Read the [build
from source](../project/building_from_source) instructions for more
information.
docs/sources/installation/ldap.md
+11 -3
View File
@@ -7,8 +7,8 @@ page_keywords: grafana, ldap, configuration, documentation, integration
# LDAP Integration
Grafana 2.1 ships with a strong LDAP integration feature. The LDAP integration in Grafana allows your
Grafana users to login with their LDAP credentials.
You can also specify mappings between LDAP group memberships and Grafana Organization user roles.
Grafana users to login with their LDAP credentials. You can also specify mappings between LDAP
group memberships and Grafana Organization user roles.
## Configuration
You turn on LDAP in the [main config file](../configuration/#authldap) as well as specify the path to the LDAP
@@ -77,7 +77,7 @@ bind_password = "grafana"
### Single Bind Example
If you can provide a single bind expression that matches all possible users you can skip the second bind and bind against the user DN directly.
If you can provide a single bind expression that matches all possible users, you can skip the second bind and bind against the user DN directly.
This allows you to not specify a bind_password in the configuration file.
```
@@ -87,9 +87,17 @@ bind_dn = "cn=%s,o=users,dc=grafana,dc=org"
In this case you skip providing a `bind_password` and instead provide a `bind_dn` value with a `%s` somewhere. This will be replaced with the username entered in on the Grafana login page.
The search filter and search bases settings are still needed to perform the LDAP search to retreive the other LDAP information (like LDAP groups and email).
## LDAP to Grafana Org Role Sync
## Group Mappings
In `[[servers.group_mappings]]` you can map an LDAP group to a Grafana organization and role. These will be synced every time the user logs in, with LDAP being the authoratative source.
So, if you change a user's role in the Grafana Org. Users page, this change will be reset the next time the user logs in. If you change the LDAP groups of a user, the change will take effect the next time the user logs in.
### Priority between Multiple Mappings
The first group mapping that an LDAP user is matched to will be used for the sync. If you have LDAP users that fit multiple mappings, the topmost mapping in the TOML config will be used.
## Ldap to Grafana Org Role Sync
In the `[[servers.group_mappings]]` you can map a LDAP group to a grafana organization and role. These will be synced every time the user logs in. So
if you change a users role in the Grafana Org. Users page, this change will be reset the next time the user logs in. Similarly if you
can LDAP groups for a user in LDAP the change will take effect the next time the user logs in to Grafana.
docs/sources/installation/mac.md
+1 -1
View File
@@ -6,7 +6,7 @@ page_keywords: grafana, installation, mac, osx, guide
# Installing on Mac
There is currently no binary build for Mac. But read the [build from
There is currently no binary build for Mac, but Grafana will happily build on Mac. Read the [build from
source](/project/building_from_source) page for instructions on how to
build it yourself.
docs/sources/installation/performance.md
+1 -1
View File
@@ -14,7 +14,7 @@ rendering times for large time ranges then it is most likely caused by
running Graphite 0.9.12 or lower.
The latest version of Graphite adds a `maxDataPoints` parameter to the
JSON render API, without this feature Graphite can return hundreds of
JSON render API. Without this feature Graphite can return hundreds of
thousands of data points per graph, which can hang your browser. Be sure
to upgrade to
[0.9.13](http://graphite.readthedocs.org/en/latest/releases/0_9_13.html).
docs/sources/installation/provisioning.md
+23 -8
View File
@@ -10,25 +10,40 @@ Here are links for how to install Grafana (and some include Graphite or
InfluxDB as well) via a provisioning system. These are not maintained by
any core Grafana team member and might be out of date.
## Puppet
Some of the linked cookbooks/manifests/etc. will install and configure Grafana 2.x, while some will only install the older Grafana 1.x versions. They've been broken apart below for your convenience.
* [forge.puppetlabs.com/bfraser/grafana](https://forge.puppetlabs.com/bfraser/grafana)
## Compatible with Grafana 2.x
## Ansible
### Puppet
* [forge.puppetlabs.com/bfraser/grafana](https://forge.puppetlabs.com/bfraser/grafana) **Note:** The current version works with Grafana 2.x. To install older versions of Grafana use the 1.x series of releases.
### Ansible
* [github.com/picotrading/ansible-grafana](https://github.com/picotrading/ansible-grafana)
### Docker
* [github.com/grafana/grafana-docker](https://github.com/grafana/grafana-docker)
### Chef
* [github.com/JonathanTron/chef-grafana](https://github.com/JonathanTron/chef-grafana) **Note:** The current version works with Grafana 2.x. To install older versions of Grafana use the 1.x series of releases.
* [github.com/Nordstrom/grafana2-cookbook](https://github.com/Nordstrom/grafana2-cookbook)
## Compatible with Grafana 1.x only
### Ansible
* [github.com/bobrik/ansible-grafana](https://github.com/bobrik/ansible-grafana)
* [github.com/bitmazk/ansible-digitalocean-influxdb-grafana](https://github.com/bitmazk/ansible-digitalocean-influxdb-grafana)
* [github.com/picotrading/ansible-grafana](https://github.com/picotrading/ansible-grafana)
## Docker
### Docker
* [github.com/kamon-io/docker-grafana-graphite](https://github.com/kamon-io/docker-grafana-graphite)
* [github.com/kamon-io/docker-grafana-influxdb](https://github.com/kamon-io/docker-grafana-influxdb)
* [github.com/tutumcloud/tutum-docker-grafana](https://github.com/tutumcloud/tutum-docker-grafana)
* [github.com/mingfang/docker-grafana](https://github.com/mingfang/docker-grafana)
## Chef
### Chef
* [github.com/JonathanTron/chef-grafana](https://github.com/JonathanTron/chef-grafana)
* [github.com/dzautner/grafana-cookbook](https://github.com/dzautner/grafana-cookbook)
docs/sources/installation/rpm.md
+1 -1
View File
@@ -100,7 +100,7 @@ By default Grafana will log to `/var/log/grafana`
The default configuration specifies a sqlite3 database located at
`/var/lib/grafana/grafana.db`. Please backup this database before
upgrades. You can also use MySQL or Postgres as the Grafana database.
upgrades. You can also use MySQL or Postgres as the Grafana database, as detailed on [the configuration page](configuration.md#database).
## Configuration
docs/sources/installation/troubleshooting.md
+2 -2
View File
@@ -18,8 +18,8 @@ an error like this:
![](/img/v1/graph_timestore_error.png)
For some type of errors the `View details` link will show you error
details. But for many types of HTTP connection errors there is very
For some types of errors, the `View details` link will show you error
details. For many types of HTTP connection errors, however, there is very
little information. The best way to troubleshoot these issues is use
the [Chrome developer tools](https://developer.chrome.com/devtools/index).
By pressing `F12` you can bring up the chrome dev tools.