IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-01-10 08:03:58 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update configuration.md for #3349 (#21069)

Browse Source 
* Update configuration.md

Updated logs section and clarified some of the file location and commenting information.

* Update docs/sources/installation/configuration.md

Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
This commit is contained in:
Diana Payton 2019-12-12 11:19:41 -08:00 committed by GitHub
parent 06bf7e8ef1
commit c27262c50c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/sources/installation/configuration.md
View File

@ -12,26 +12,39 @@ weight = 1
# Configuration # Configuration
The Grafana back-end has a number of configuration options that can be Grafana has a number of configuration options that you can specify in a `.ini` configuration file or specified using environment variables.
specified in a `.ini` configuration file or specified using environment variables.
> **Note.** Grafana needs to be restarted for any configuration changes to take effect. > **Note.** You must restart Grafana for any configuration changes to take effect.
## Comments in .ini Files
Semicolons (the `;` char) are the standard way to comment out lines in a `.ini` file.
A common problem is forgetting to uncomment a line in the `custom.ini` (or `grafana.ini`) file which causes the configuration option to be ignored.
## Config file locations ## Config file locations
Do not change `defaults.ini`! Grafana defaults are stored in this file. Depending on your OS, make all configuration changes in either `custom.ini` or `grafana.ini`.
- Default configuration from `$WORKING_DIR/conf/defaults.ini` - Default configuration from `$WORKING_DIR/conf/defaults.ini`
- Custom configuration from `$WORKING_DIR/conf/custom.ini` - Custom configuration from `$WORKING_DIR/conf/custom.ini`
- The custom configuration file path can be overridden using the `--config` parameter - The custom configuration file path can be overridden using the `--config` parameter
**Note:** If you have installed Grafana using the `deb` or `rpm` packages, then your configuration file is located at `/etc/grafana/grafana.ini` and a separate `custom.ini` is not used. This path is specified in the Grafana init.d script using `--config` file parameter. **Linux**
**macOS:** By default, the configuration file is located at `/usr/local/etc/grafana/grafana.ini`. If you installed Grafana using the `deb` or `rpm` packages, then your configuration file is located at `/etc/grafana/grafana.ini` and a separate `custom.ini` is not used. This path is specified in the Grafana init.d script using `--config` file parameter.
**Windows**
`sample.ini` is in the same directory as `defaults.ini` and contains all the settings commented out. Copy `sample.ini` and name it `custom.ini`.
**macOS**
By default, the configuration file is located at `/usr/local/etc/grafana/grafana.ini`.
## Comments in .ini Files
Semicolons (the `;` char) are the standard way to comment out lines in a `.ini` file. If you want to change a setting, you must delete the semicolon (`;`) in front of the setting before it will work.
**Example**
```
# The http port to use
;http_port = 3000
```
A common problem is forgetting to uncomment a line in the `custom.ini` (or `grafana.ini`) file which causes the configuration option to be ignored.
## Using environment variables ## Using environment variables
@ -87,7 +100,13 @@ How long temporary images in `data` directory should be kept. Defaults to: `24h`
### logs ### logs
Path to where Grafana will store logs. This path is usually specified via command line in the init.d script or the systemd service file. It can be overridden in the configuration file or in the default environment variable file. Path to where Grafana will store logs. This path is usually specified via command line in the init.d script or the systemd service file. You can override it in the configuration file or in the default environment variable file. However, please note that by overriding this the default log path will be used temporarily until Grafana has fully initialized/started.
Override log path using the command line argument `cfg:default.paths.log`:
```bash
./grafana-server --config /custom/config.ini --homepath /custom/homepath cfg:default.paths.logs=/custom/path
```
**macOS:** By default, the log file should be located at `/usr/local/var/log/grafana/grafana.log`. **macOS:** By default, the log file should be located at `/usr/local/var/log/grafana/grafana.log`.
@ -759,4 +778,3 @@ Set to true if you host Grafana behind HTTPS only. Defaults to `false`.
### session_life_time ### session_life_time
How long sessions lasts in seconds. Defaults to `86400` (24 hours). How long sessions lasts in seconds. Defaults to `86400` (24 hours).