Skip to content

N
nexpie-grafana-theme
Commit 7da3ee72 by James Turnbull
Options

More docs fixes 

1. Set paragraph size to 80 chars for better readability.
2. More formatting fixes.
3. More spelling and grammar fixes.
parent 823294f0
Showing with 112 additions and 68 deletions
docs/sources/installation/debian.md
...@@ -29,7 +29,8 @@ candidates. ...@@ -29,7 +29,8 @@ 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 (signs repo metadata). 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 -
...@@ -47,10 +48,10 @@ HTTPS. ...@@ -47,10 +48,10 @@ HTTPS.
## Package details ## Package details
- Installs binary to `/usr/sbin/grafana-server` - Installs binary to `/usr/sbin/grafana-server`
- Init.d script to `/etc/init.d/grafana-server` - Installs Init.d script to `/etc/init.d/grafana-server`
- Default file (environment vars) to `/etc/default/grafana-server` - Creates default file (environment vars) to `/etc/default/grafana-server`
- Configuration file to `/etc/grafana/grafana.ini` - Installs configuration file to `/etc/grafana/grafana.ini`
- Systemd service (if systemd is available) name `grafana-server.service` - Installs systemd service (if systemd is available) name `grafana-server.service`
- The default configuration sets the log file at `/var/log/grafana/grafana.log` - The default configuration sets the log file at `/var/log/grafana/grafana.log`
- The default configuration specifies an sqlite3 db at `/var/lib/grafana/grafana.db` - The default configuration specifies an sqlite3 db at `/var/lib/grafana/grafana.db`
...@@ -93,13 +94,15 @@ By default Grafana will log to `/var/log/grafana` ...@@ -93,13 +94,15 @@ By default Grafana will log to `/var/log/grafana`
### Database ### Database
The default configuration specifies a sqlite3 database located at `/var/lib/grafana/grafana.db`. Please backup The default configuration specifies a sqlite3 database located at
this database before upgrades. You can also use MySQL or Postgres as the Grafana database. `/var/lib/grafana/grafana.db`. Please backup this database before
upgrades. You can also use MySQL or Postgres as the Grafana database.
## Configuration ## Configuration
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](/installation/configuration) page for details The configuration file is located at `/etc/grafana/grafana.ini`. Go the
on all those options. [Configuration](/installation/configuration) page for details on all
those options.
### Adding data sources ### Adding data sources
...@@ -115,8 +118,9 @@ after the version you downloaded. This folder contains all files ...@@ -115,8 +118,9 @@ after the version you downloaded. This folder contains all files
required to run Grafana. There are no init scripts or install scripts required to run Grafana. There are no init scripts or install scripts
in this package. in this package.
To configure Grafana add a configuration file named `custom.ini` to the `conf` To configure Grafana add a configuration file named `custom.ini` to the
folder and override any of the settings defined in `conf/defaults.ini`. `conf` folder and override any of the settings defined in
`conf/defaults.ini`.
Start Grafana by executing `./grafana web`. The `grafana` binary needs Start Grafana by executing `./grafana web`. The `grafana` binary needs
the working directory to be the root install directory (where the binary the working directory to be the root install directory (where the binary
......
docs/sources/installation/docker.md
...@@ -8,27 +8,31 @@ page_keywords: grafana, installation, docker, container, guide ...@@ -8,27 +8,31 @@ page_keywords: grafana, installation, docker, container, guide
## Install from offical docker image ## Install from offical docker image
Grafana has an offical docker container. Grafana has an official Docker container.
$ docker run -i -p 3000:3000 grafana/grafana $ docker run -i -p 3000:3000 grafana/grafana
All grafana configuration settings can be defined using ENVIRONMENT variables, this is especially useful when using the All Grafana configuration settings can be defined using environment
above container. variables, this is especially useful when using the above container.
## Docker volumes & ENV config ## Docker volumes & ENV config
The docker container exposes two volumes, the sqlite3 database in the folder `/var/lib/grafana` and The Docker container exposes two volumes, the sqlite3 database in the
configuration files is in `/etc/grafana/` folder. You can map these volumes to host folders when you start the container: folder `/var/lib/grafana` and configuration files is in `/etc/grafana/`
folder. You can map these volumes to host folders when you start the
container:
$ docker run -d -p 3000:3000 \ $ docker run -d -p 3000:3000 \
-v /var/lib/grafana:/var/lib/grafana \ -v /var/lib/grafana:/var/lib/grafana \
-e "GF_SECURITY_ADMIN_PASSWORD=secret \ -e "GF_SECURITY_ADMIN_PASSWORD=secret \
grafana/grafana:develop grafana/grafana:develop
In the above example I map the data folder and set a config option via an `ENV` variable. In the above example I map the data folder and sets a configuration option via
an `ENV` instruction.
## Configuration ## Configuration
The backend web server has a number of configuration options. Go the [Configuration](/installation/configuration) page for details The back-end web server has a number of configuration options. Go the
on all those options. [Configuration](/installation/configuration) page for details on all
those options.
docs/sources/installation/index.md
...@@ -6,9 +6,12 @@ page_keywords: grafana, installation, documentation ...@@ -6,9 +6,12 @@ page_keywords: grafana, installation, documentation
# Installation # Installation
Grafana is easily installed via a Debian/Ubuntu package (.deb), via Redhat/Centos package (.rpm) or manually via Grafana is easily installed via a Debian/Ubuntu package (.deb), 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 Redhat/Centos package (.rpm) or manually via a tarball that contains all
to build one your self, read the [build from source](../project/building_from_source) instructions for more information. 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
from source](../project/building_from_source) instructions for more
information.
- [Installing on Debian / Ubuntu](debian.md) - [Installing on Debian / Ubuntu](debian.md)
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](rpm.md) - [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](rpm.md)
......
docs/sources/installation/mac.md
...@@ -6,7 +6,8 @@ page_keywords: grafana, installation, mac, osx, guide ...@@ -6,7 +6,8 @@ page_keywords: grafana, installation, mac, osx, guide
# Installing on Mac # Installing on Mac
There are currently no binary build for Mac. But read the [build from source](../project/building_from_source) There is currently no binary build for Mac. But read the [build from
page for instructions on how to build it yourself. source](../project/building_from_source) page for instructions on how to
build it yourself.
docs/sources/installation/migrating_to2.md
...@@ -31,8 +31,10 @@ can be configured to communicate with your data source using a back-end ...@@ -31,8 +31,10 @@ can be configured to communicate with your data source using a back-end
mode which can eliminate many CORS-related issues, as well as provide mode which can eliminate many CORS-related issues, as well as provide
more secure authentication to your data sources. more secure authentication to your data sources.
> *Note* When you add your data sources please name them exactly as you named them in `config.js` in Grafana 1.x. That name is referenced by panels > *Note* When you add your data sources please name them exactly as you
> , annotation and template queries. That way when you import your old dashboard they will work without any changes. > named them in `config.js` in Grafana 1.x. That name is referenced by
> panels, annotation and template queries. That way when you import
> your old dashboard they will work without any changes.
## Importing your existing dashboards ## Importing your existing dashboards
......
docs/sources/installation/performance.md
...@@ -8,9 +8,15 @@ page_keywords: grafana, performance, documentation ...@@ -8,9 +8,15 @@ page_keywords: grafana, performance, documentation
## Graphite ## Graphite
Graphite 0.9.13 adds a much needed feature to the json rendering API that is very important for Grafana. If you are experiance slow Graphite 0.9.13 adds a much needed feature to the JSON rendering API
load & rendering times for large time ranges then it is most likely caused by running Graphite 0.9.12 or lower. The latest version that is very important for Grafana. If you are experiencing slow load &
of Graphite adds a maxDataPoints parameter to the json render API, without this feature Graphite can return hundreds of thousands of data points per graph, which rendering times for large time ranges then it is most likely caused by
can hang your browser. Be sure to upgrade to [0.9.13](http://graphite.readthedocs.org/en/latest/releases/0_9_13.html). 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
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
...@@ -6,8 +6,9 @@ page_keywords: grafana, provisioning, documentation ...@@ -6,8 +6,9 @@ page_keywords: grafana, provisioning, documentation
# Provisioning # Provisioning
Here are links for how to install Grafana (and some include Graphite or InfluxDB as well) via a provisioning Here are links for how to install Grafana (and some include Graphite or
system. These are not maintained by any core Grafana team member and might be out of date. InfluxDB as well) via a provisioning system. These are not maintained by
any core Grafana team member and might be out of date.
## Puppet ## Puppet
......
docs/sources/installation/rpm.md
...@@ -12,17 +12,18 @@ Description | Download ...@@ -12,17 +12,18 @@ Description | Download
------------ | ------------- ------------ | -------------
.RPM for Fedora / RHEL / CentOS Linux | [grafana-2.0.2-1.x86_64.rpm](https://grafanarel.s3.amazonaws.com/builds/grafana-2.0.2-1.x86_64.rpm) .RPM for Fedora / RHEL / CentOS Linux | [grafana-2.0.2-1.x86_64.rpm](https://grafanarel.s3.amazonaws.com/builds/grafana-2.0.2-1.x86_64.rpm)
## Install ## Install from package file
You can install using yum
You can install Grafana using Yum directly.
$ sudo yum install https://grafanarel.s3.amazonaws.com/builds/grafana-2.0.2-1.x86_64.rpm $ sudo yum install https://grafanarel.s3.amazonaws.com/builds/grafana-2.0.2-1.x86_64.rpm
Or manually using `rpm` Or install manually using `rpm`.
$ sudo yum install initscripts fontconfig $ sudo yum install initscripts fontconfig
$ sudo rpm -Uvh grafana-2.0.1-1.x86_64.rpm $ sudo rpm -Uvh grafana-2.0.1-1.x86_64.rpm
## YUM Repository ## Install via YUM Repository
Add the following to a new file at `/etc/yum.repos.d/grafana.repo` Add the following to a new file at `/etc/yum.repos.d/grafana.repo`
...@@ -36,33 +37,43 @@ Add the following to a new file at `/etc/yum.repos.d/grafana.repo` ...@@ -36,33 +37,43 @@ Add the following to a new file at `/etc/yum.repos.d/grafana.repo`
sslverify=1 sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt sslcacert=/etc/pki/tls/certs/ca-bundle.crt
There is also testing repository if you want beta or release candidates. There is also a testing repository if you want beta or release
candidates.
baseurl=https://packagecloud.io/grafana/testing/el/6/$basearch baseurl=https://packagecloud.io/grafana/testing/el/6/$basearch
Install Grafana Then install Grafana via the `yum` command.
$ sudo yum install grafana $ sudo yum install grafana
### RPM GPG Key ### RPM GPG Key
The rpms are signed, you can verify the signature with this [public GPG key](https://grafanarel.s3.amazonaws.com/RPM-GPG-KEY-grafana).
The RPMs are signed, you can verify the signature with this [public GPG
key](https://grafanarel.s3.amazonaws.com/RPM-GPG-KEY-grafana).
## Package details ## Package details
- Installs binary to `/usr/sbin/grafana-server` - Installs binary to `/usr/sbin/grafana-server`
- Init.d script to `/etc/init.d/grafana-server` - Copies init.d script to `/etc/init.d/grafana-server`
- Default file (environment vars) to `/etc/sysconfig/grafana-server` - Installs default file (environment vars) to `/etc/sysconfig/grafana-server`
- Configuration file to `/etc/grafana/grafana.ini` - Copies configuration file to `/etc/grafana/grafana.ini`
- Systemd service (if systemd is available) name `grafana-server.service` - Installs systemd service (if systemd is available) name `grafana-server.service`
- The default configuration specifies log file at `/var/log/grafana/grafana.log` - The default configuration uses a log file at `/var/log/grafana/grafana.log`
- The default configuration specifies sqlite3 db at `/var/lib/grafana/grafana.db` - The default configuration specifies an sqlite3 database at `/var/lib/grafana/grafana.db`
## Start the server (init.d service) ## Start the server (init.d service)
- Start grafana by `sudo service grafana-server start` You can start Grafana by running:
- This will start the grafana-server process as the `grafana` user (created during package install)
- Default http port is `3000`, and default user is admin/admin $ sudo service grafana-server start
- To configure grafana server to start at boot time: `sudo /sbin/chkconfig --add grafana-server`
This will start the `grafana-server` process as the `grafana` user,
which is created during package installation. The default HTTP port is
`3000`, and default user and group is `admin`.
To configure the Grafana server to start at boot time:
$ sudo /sbin/chkconfig --add grafana-server
## Start the server (via systemd) ## Start the server (via systemd)
...@@ -70,29 +81,32 @@ The rpms are signed, you can verify the signature with this [public GPG key](htt ...@@ -70,29 +81,32 @@ The rpms are signed, you can verify the signature with this [public GPG key](htt
$ systemctl start grafana-server $ systemctl start grafana-server
$ systemctl status grafana-server $ systemctl status grafana-server
### Enable the systemd service (so grafana starts at boot) ### Enable the systemd service to start at boot
sudo systemctl enable grafana-server.service sudo systemctl enable grafana-server.service
## Environment file ## Environment file
The systemd service file and init.d script both use the file located at `/etc/sysconfig/grafana-server` for The systemd service file and init.d script both use the file located at
environment variables used when starting the backend. Here you can override log directory, data directory and other `/etc/sysconfig/grafana-server` for environment variables used when
variables. starting the back-end. Here you can override log directory, data
directory and other variables.
### Logging ### Logging
By default grafana will log to `/var/log/grafana` By default Grafana will log to `/var/log/grafana`
### Database ### Database
The default configuration specifies a sqlite3 database located at `/var/lib/grafana/grafana.db`. Please backup The default configuration specifies a sqlite3 database located at
this database before upgrades. You can also use mysql or postgres as the Grafana database. `/var/lib/grafana/grafana.db`. Please backup this database before
upgrades. You can also use MySQL or Postgres as the Grafana database.
## Configuration ## Configuration
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](/installation/configuration) page for details The configuration file is located at `/etc/grafana/grafana.ini`. Go the
on all those options. [Configuration](/installation/configuration) page for details on all
those options.
### Adding data sources ### Adding data sources
......
docs/sources/installation/windows.md
...@@ -13,21 +13,30 @@ Description | Download ...@@ -13,21 +13,30 @@ Description | Download
Zip package for Windows | [grafana.2.0.2.windows-x64.zip](https://grafanarel.s3.amazonaws.com/winbuilds/dist/grafana-2.0.2.windows-x64.zip) Zip package for Windows | [grafana.2.0.2.windows-x64.zip](https://grafanarel.s3.amazonaws.com/winbuilds/dist/grafana-2.0.2.windows-x64.zip)
## Configure ## Configure
The zip file contains a folder with the current Grafana version. Extract this folder to anywhere you want Grafana to run from.
Go into the `conf` directory and copy `sample.ini` to `custom.ini`. You should edit `custom.ini`, never `defaults.ini`.
The default Grafana port is `3000`, this port requires extra permissions on windows. Edit `custom.ini` and uncomment the `http_port` The zip file contains a folder with the current Grafana version. Extract
configuration option and change it to something like `8080` or similar. That port should not require extra Windows privileges. this folder to anywhere you want Grafana to run from. Go into the
`conf` directory and copy `sample.ini` to `custom.ini`. You should edit
`custom.ini`, never `defaults.ini`.
Start Grafana by executing `grafana-server.exe`, preferably from the command line. If you want to run Grafana as The default Grafana port is `3000`, this port requires extra permissions
windows service, download [NSSM](https://nssm.cc/). It is very easy add Grafana as a Windows service using that tool. on windows. Edit `custom.ini` and uncomment the `http_port`
configuration option and change it to something like `8080` or similar.
That port should not require extra Windows privileges.
Start Grafana by executing `grafana-server.exe`, preferably from the
command line. If you want to run Grafana as windows service, download
[NSSM](https://nssm.cc/). It is very easy add Grafana as a Windows
service using that tool.
Read more about the [configuration options](/installation/configuration). Read more about the [configuration options](/installation/configuration).
## Building on Windows ## Building on Windows
The Grafana backend includes Sqlite3 which requires GCC to compile. So in order to compile Grafana on Windows you need The Grafana backend includes Sqlite3 which requires GCC to compile. So
to install GCC. We recommend [TDM-GCC](http://tdm-gcc.tdragon.net/download). in order to compile Grafana on Windows you need to install GCC. We
recommend [TDM-GCC](http://tdm-gcc.tdragon.net/download).
Copy `conf/sample.ini` to a file named `conf/custom.ini` and change the web server port to something like 8080. The default Copy `conf/sample.ini` to a file named `conf/custom.ini` and change the
Grafana port, 3000, requires special privileges on Windows. web server port to something like 8080. The default Grafana port, 3000,
requires special privileges on Windows.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment