mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Updating manual installation instructions (#98834)
* Docs: adding additional installation steps to Grafana on openSUSE docs * Docs: Adding systemd service info for grafana manual install * Finalizing first edit with tested steps * spacing adjustment and adding steps to RHEL/Fedora * Adding a note based on Marins feedback * A slight adjustment based on feedback from Marin and adding steps to Debian installation * adjusting some wording * adjusting naming conventions for Debian instructions * changing "open-source" to "open source" * vale and review edits * deleting erroneous character in shortcode * updating some shortcodes --------- Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
parent
6d374a3d7f
commit
b6ea06f259
@ -18,9 +18,9 @@ This topic explains how to install Grafana dependencies, install Grafana on Linu
|
||||
|
||||
There are multiple ways to install Grafana: using the Grafana Labs APT repository, by downloading a `.deb` package, or by downloading a binary `.tar.gz` file. Choose only one of the methods below that best suits your needs.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
If you install via the `.deb` package or `.tar.gz` file, then you must manually update Grafana for each new version.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
The following video demonstrates how to install Grafana on Debian and Ubuntu as outlined in this document:
|
||||
|
||||
@ -37,9 +37,9 @@ If you install from the APT repository, Grafana automatically updates when you r
|
||||
| Grafana OSS | grafana | `https://apt.grafana.com stable main` |
|
||||
| Grafana OSS (Beta) | grafana | `https://apt.grafana.com beta main` |
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Grafana Enterprise is the recommended and default edition. It is available for free and includes all the features of the OSS edition. You can also upgrade to the [full Enterprise feature set](/products/enterprise/?utm_source=grafana-install-page), which has support for [Enterprise plugins](/grafana/plugins/?enterprise=1&utcm_source=grafana-install-page).
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
Complete the following steps to install Grafana from the APT repository:
|
||||
|
||||
@ -89,11 +89,11 @@ Complete the following steps to install Grafana from the APT repository:
|
||||
sudo apt-get install grafana-enterprise
|
||||
```
|
||||
|
||||
## Install Grafana using a deb package or as a standalone binary
|
||||
## Install Grafana using a deb package
|
||||
|
||||
If you choose not to install Grafana using APT, you can download and install Grafana using the deb package or as a standalone binary.
|
||||
If you install Grafana manually using the deb package, then you must manually update Grafana for each new version.
|
||||
|
||||
Complete the following steps to install Grafana using DEB or the standalone binaries:
|
||||
Complete the following steps to install Grafana using a deb package:
|
||||
|
||||
1. Navigate to the [Grafana download page](/grafana/download).
|
||||
1. Select the Grafana version you want to install.
|
||||
@ -105,6 +105,80 @@ Complete the following steps to install Grafana using DEB or the standalone bina
|
||||
1. Depending on which system you are running, click the **Linux** or **ARM** tab on the [download page](/grafana/download).
|
||||
1. Copy and paste the code from the [download page](/grafana/download) into your command line and run.
|
||||
|
||||
## Install Grafana as a standalone binary
|
||||
|
||||
Complete the following steps to install Grafana using the standalone binaries:
|
||||
|
||||
1. Navigate to the [Grafana download page](/grafana/download).
|
||||
1. Select the Grafana version you want to install.
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only tagged releases. If you want to install a nightly build, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
- **Enterprise:** This is the recommended version. It is functionally identical to the open source version but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source:** This version is functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
1. Depending on which system you are running, click the **Linux** or **ARM** tab on the [download page](/grafana/download).
|
||||
1. Copy and paste the code from the [download page](/grafana/download) page into your command line and run.
|
||||
1. Create a user account for Grafana on your system:
|
||||
|
||||
```shell
|
||||
sudo useradd -r -s /bin/false grafana
|
||||
```
|
||||
|
||||
1. Move the unpacked binary to `/usr/local/grafana`:
|
||||
|
||||
```shell
|
||||
sudo mv <DOWNLOAD PATH> /usr/local/grafana
|
||||
```
|
||||
|
||||
1. Change the owner of `/usr/local/grafana` to Grafana users:
|
||||
|
||||
```shell
|
||||
sudo chown -R grafana:users /usr/local/grafana
|
||||
```
|
||||
|
||||
1. Create a Grafana server systemd unit file:
|
||||
|
||||
```shell
|
||||
sudo touch /etc/systemd/system/grafana-server.service
|
||||
```
|
||||
|
||||
1. Add the following to the unit file in a text editor of your choice:
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Grafana Server
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=grafana
|
||||
Group=users
|
||||
ExecStart=/usr/local/grafana/bin/grafana server --config=/usr/local/grafana/conf/grafana.ini --homepath=/usr/local/grafana
|
||||
Restart=on-failure
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
1. Use the binary to manually start the Grafana server:
|
||||
|
||||
```shell
|
||||
/usr/local/grafana/bin/grafana-server --homepath /usr/local/grafana
|
||||
```
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Manually invoking the binary in this step automatically creates the `/usr/local/grafana/data` directory, which needs to be created and configured before the installation can be considered complete.
|
||||
{{< /admonition >}}
|
||||
|
||||
1. Press `CTRL+C` to stop the Grafana server.
|
||||
1. Change the owner of `/usr/local/grafana` to Grafana users again to apply the ownership to the newly created `/usr/local/grafana/data` directory:
|
||||
|
||||
```shell
|
||||
sudo chown -R grafana:users /usr/local/grafana
|
||||
```
|
||||
|
||||
1. [Configure the Grafana server to start at boot time using systemd](https://grafana.com/docs/grafana/latest/setup-grafana/start-restart-grafana/#configure-the-grafana-server-to-start-at-boot-using-systemd).
|
||||
|
||||
## Uninstall on Debian or Ubuntu
|
||||
|
||||
Complete any of the following steps to uninstall Grafana.
|
||||
|
@ -32,15 +32,15 @@ If you install from the RPM repository, then Grafana is automatically updated ev
|
||||
| Grafana OSS | grafana | `https://rpm.grafana.com` |
|
||||
| Grafana OSS (Beta) | grafana | `https://rpm-beta.grafana.com` |
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Grafana Enterprise is the recommended and default edition. It is available for free and includes all the features of the OSS edition. You can also upgrade to the [full Enterprise feature set](/products/enterprise/?utm_source=grafana-install-page), which has support for [Enterprise plugins](/grafana/plugins/?enterprise=1&utcm_source=grafana-install-page).
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
To install Grafana from the RPM repository, complete the following steps:
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
If you wish to install beta versions of Grafana, substitute the repository URL for the beta URL listed above.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
1. Import the GPG key:
|
||||
|
||||
@ -96,6 +96,8 @@ If you install Grafana manually using YUM or RPM, then you must manually update
|
||||
|
||||
## Install Grafana as a standalone binary
|
||||
|
||||
If you install Grafana manually using the standalone binaries, then you must manually update Grafana for each new version.
|
||||
|
||||
Complete the following steps to install Grafana using the standalone binaries:
|
||||
|
||||
1. Navigate to the [Grafana download page](/grafana/download).
|
||||
@ -103,10 +105,70 @@ Complete the following steps to install Grafana using the standalone binaries:
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only tagged releases. If you want to install a nightly build, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
- **Enterprise:** This is the recommended version. It is functionally identical to the open-source version but includes features you can unlock with a license if you so choose.
|
||||
- **Enterprise:** This is the recommended version. It is functionally identical to the open source version but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source:** This version is functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
1. Depending on which system you are running, click the **Linux** or **ARM** tab on the [download page](/grafana/download).
|
||||
1. Copy and paste the code from the [download page](/grafana/download) page into your command line and run.
|
||||
1. Create a user account for Grafana on your system:
|
||||
|
||||
```shell
|
||||
sudo useradd -r -s /bin/false grafana
|
||||
```
|
||||
|
||||
1. Move the unpacked binary to `/usr/local/grafana`:
|
||||
|
||||
```shell
|
||||
sudo mv <DOWNLOAD PATH> /usr/local/grafana
|
||||
```
|
||||
|
||||
1. Change the owner of `/usr/local/grafana` to Grafana users:
|
||||
|
||||
```shell
|
||||
sudo chown -R grafana:users /usr/local/grafana
|
||||
```
|
||||
|
||||
1. Create a Grafana server systemd unit file:
|
||||
|
||||
```shell
|
||||
sudo touch /etc/systemd/system/grafana-server.service
|
||||
```
|
||||
|
||||
1. Add the following to the unit file in a text editor of your choice:
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Grafana Server
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=grafana
|
||||
Group=users
|
||||
ExecStart=/usr/local/grafana/bin/grafana server --config=/usr/local/grafana/conf/grafana.ini --homepath=/usr/local/grafana
|
||||
Restart=on-failure
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
1. Use the binary to manually start the Grafana server:
|
||||
|
||||
```shell
|
||||
/usr/local/grafana/bin/grafana-server --homepath /usr/local/grafana
|
||||
```
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Manually invoking the binary in this step automatically creates the `/usr/local/grafana/data` directory, which needs to be created and configured before the installation can be considered complete.
|
||||
{{< /admonition >}}
|
||||
|
||||
1. Press `CTRL+C` to stop the Grafana server.
|
||||
1. Change the owner of `/usr/local/grafana` to Grafana users again to apply the ownership to the newly created `/usr/local/grafana/data` directory:
|
||||
|
||||
```shell
|
||||
sudo chown -R grafana:users /usr/local/grafana
|
||||
```
|
||||
|
||||
1. [Configure the Grafana server to start at boot time using systemd]({{< relref "../../start-restart-grafana#configure-the-grafana-server-to-start-at-boot-using-systemd" >}}).
|
||||
|
||||
## Uninstall on RHEL or Fedora
|
||||
|
||||
|
@ -30,9 +30,9 @@ If you install from the RPM repository, then Grafana is automatically updated ev
|
||||
| Grafana Enterprise | grafana-enterprise | `https://rpm.grafana.com` |
|
||||
| Grafana OSS | grafana | `https://rpm.grafana.com` |
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Grafana Enterprise is the recommended and default edition. It is available for free and includes all the features of the OSS edition. You can also upgrade to the [full Enterprise feature set](/products/enterprise/?utm_source=grafana-install-page), which has support for [Enterprise plugins](/grafana/plugins/?enterprise=1&utcm_source=grafana-install-page).
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
To install Grafana using the RPM repository, complete the following steps:
|
||||
|
||||
@ -84,6 +84,8 @@ If you install Grafana manually using RPM, then you must manually update Grafana
|
||||
|
||||
## Install Grafana as a standalone binary
|
||||
|
||||
If you install Grafana manually using the standalone binaries, then you must manually update Grafana for each new version.
|
||||
|
||||
Complete the following steps to install Grafana using the standalone binaries:
|
||||
|
||||
1. Navigate to the [Grafana download page](/grafana/download).
|
||||
@ -91,10 +93,70 @@ Complete the following steps to install Grafana using the standalone binaries:
|
||||
- The most recent Grafana version is selected by default.
|
||||
- The **Version** field displays only tagged releases. If you want to install a nightly build, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
- **Enterprise:** This is the recommended version. It is functionally identical to the open-source version but includes features you can unlock with a license if you so choose.
|
||||
- **Enterprise:** This is the recommended version. It is functionally identical to the open source version but includes features you can unlock with a license if you so choose.
|
||||
- **Open Source:** This version is functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
1. Depending on which system you are running, click the **Linux** or **ARM** tab on the [download page](/grafana/download).
|
||||
1. Copy and paste the code from the [download page](/grafana/download) into your command line and run.
|
||||
1. Create a user account for Grafana on your system:
|
||||
|
||||
```shell
|
||||
sudo useradd -r -s /bin/false grafana
|
||||
```
|
||||
|
||||
1. Move the unpacked binary to `/usr/local/grafana`:
|
||||
|
||||
```shell
|
||||
sudo mv <DOWNLOAD PATH> /usr/local/grafana
|
||||
```
|
||||
|
||||
1. Change the owner of `/usr/local/grafana` to Grafana users:
|
||||
|
||||
```shell
|
||||
sudo chown -R grafana:users /usr/local/grafana
|
||||
```
|
||||
|
||||
1. Create a Grafana server systemd unit file:
|
||||
|
||||
```shell
|
||||
sudo touch /etc/systemd/system/grafana-server.service
|
||||
```
|
||||
|
||||
1. Add the following to the unit file in a text editor of your choice:
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Grafana Server
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=grafana
|
||||
Group=users
|
||||
ExecStart=/usr/local/grafana/bin/grafana server --config=/usr/local/grafana/conf/grafana.ini --homepath=/usr/local/grafana
|
||||
Restart=on-failure
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
1. Use the binary to manually start the Grafana server:
|
||||
|
||||
```shell
|
||||
/usr/local/grafana/bin/grafana-server --homepath /usr/local/grafana
|
||||
```
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Manually invoking the binary in this step automatically creates the `/usr/local/grafana/data` directory, which needs to be created and configured before the installation can be considered complete.
|
||||
{{< /admonition >}}
|
||||
|
||||
1. Press `CTRL+C` to stop the Grafana server.
|
||||
1. Change the owner of `/usr/local/grafana` to Grafana users again to apply the ownership to the newly created `/usr/local/grafana/data` directory:
|
||||
|
||||
```shell
|
||||
sudo chown -R grafana:users /usr/local/grafana
|
||||
```
|
||||
|
||||
1. [Configure the Grafana server to start at boot time using systemd](https://grafana.com/docs/grafana/latest/setup-grafana/start-restart-grafana/#configure-the-grafana-server-to-start-at-boot-using-systemd).
|
||||
|
||||
## Uninstall on SUSE or openSUSE
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user