Fixed a series of installation doc issues

1. Fixed several spelling and grammar issues.
2. Fixed 404s for the Configuration page.
3. Fixed several Markdown formatting issues.
4. Tidy up of several pages.
This commit is contained in:
James Turnbull
2015-05-10 16:15:34 -04:00
parent 5aa495d0e4
commit 823294f055
8 changed files with 146 additions and 79 deletions

View File

@@ -19,12 +19,13 @@ Description | Download
$ sudo dpkg -i grafana_2.0.2_amd64.deb
## APT Repository
Add the following line to your `/etc/apt/sources.list`
Add the following line to your `/etc/apt/sources.list` file.
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 testing
repository if you want beta or release candidates.
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
@@ -32,13 +33,14 @@ Then add the [Package Cloud](https://packagecloud.io/grafana) key (signs repo me
$ curl https://packagecloud.io/gpg.key | sudo apt-key add -
Update apt and install Grafana
Update your Apt repositories and install Grafana
$ sudo apt-get update
$ sudo apt-get install grafana
On some older versions of Ubuntu and Debian you may need to install `apt-transport-https`,
needed to fetch packages over HTTPS.
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
@@ -49,46 +51,54 @@ needed to fetch packages over HTTPS.
- Default file (environment vars) to `/etc/default/grafana-server`
- Configuration file to `/etc/grafana/grafana.ini`
- 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 specifies sqlite3 db at `/var/lib/grafana/grafana.db`
- 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`
## Start the server (init.d service)
- Start grafana by `sudo service grafana-server start`
- 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
You can start Grafana by running:
To configure Grafana server to start at boot time:
$ 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
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
## Start the server (via systemd)
To start the service using systemd.
$ systemctl daemon-reload
$ systemctl start grafana-server
$ systemctl status grafana-server
Enable the systemd service (so grafana starts at boot)
Enable the systemd service so that Grafana starts at boot.
sudo systemctl enable grafana-server.service
## Environment file
The systemd service file and init.d script both use the file located at `/etc/default/grafana-server` for
environment variables used when starting the backend. Here you can override log directory, data directory and other
variables.
The systemd service file and init.d script both use the file located at
`/etc/default/grafana-server` for environment variables used when
starting the back-end. Here you can override log directory, data
directory and other variables.
### Logging
By default grafana will log to `/var/log/grafana`
By default Grafana will log to `/var/log/grafana`
### Database
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.
this database before upgrades. You can also use MySQL or Postgres as the Grafana database.
## Configuration
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](configuration) page for details
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](/installation/configuration) page for details
on all those options.
### Adding data sources
@@ -99,12 +109,17 @@ on all 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.
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.
To configure grafana add a config file named `custom.ini` to the `conf` folder and override any of the settings defined in
`conf/defaults.ini`. Start grafana by excecuting `./grafana web`. The grafana binary needs the working directory
to be the root install dir (where the binary is and the public folder is located).
To configure Grafana add a configuration file named `custom.ini` to the `conf`
folder and override any of the settings defined in `conf/defaults.ini`.
Start Grafana by executing `./grafana web`. The `grafana` binary needs
the working directory to be the root install directory (where the binary
and the `public` folder is located).