mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Enterprise 6.6 (#21666)
* Docs: gitlab team-sync documented correctly * docs: initial docs for whitelabeling * Docs: enterprise repositories * Docs: rpm enterprise install * Docs: re-structured the rpm install page to be more similar to the deb page * Docs: responded to review feedback * Docs: recommends the enterprise edition * Update docs/sources/installation/debian.md
This commit is contained in:
Leonard Gram
GitHub
parent
4c41d7e7fb
commit
90f552b6b6
@ -125,5 +125,5 @@ the correct teams.
|
||||
|
||||
Your GitLab groups can be referenced in the same way as `allowed_groups`, like `example` or `foo/bar`.
|
||||
|
||||
[Learn more about Team Sync]({{< relref "enhanced_ldap.md" >}})
|
||||
[Learn more about Team Sync]({{< relref "team-sync.md" >}})
|
||||
|
||||
|
||||
@ -44,4 +44,5 @@ a user as member of a team and it will not be removed when the user signs in. Th
|
||||
|
||||
* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
* [GitHub OAuth]({{< relref "github.md#team-sync-enterprise-only" >}})
|
||||
* [GitLab OAuth]({{< relref "gitlab.md#team-sync-enterprise-only" >}})
|
||||
* [Auth Proxy]({{< relref "auth-proxy.md#team-sync-enterprise-only">}})
|
||||
|
||||
@ -37,8 +37,14 @@ Supported auth providers:
|
||||
|
||||
* [LDAP]({{< relref "../auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}})
|
||||
* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}})
|
||||
* [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}})
|
||||
* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}})
|
||||
|
||||
### White labeling
|
||||
|
||||
White labeling makes it possible to customize the logos and footer links of Grafana. [Learn More]({{< relref "white-labeling.md" >}}).
|
||||
|
||||
|
||||
### Data source permissions
|
||||
|
||||
Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "../permissions/datasource_permissions.md" >}}).
|
||||
|
||||
56
docs/sources/enterprise/white-labeling.md
Normal file
56
docs/sources/enterprise/white-labeling.md
Normal file
@ -0,0 +1,56 @@
|
||||
+++
|
||||
title = "White-labeling"
|
||||
description = "White-labeling"
|
||||
keywords = ["grafana", "white-labeling", "enterprise"]
|
||||
aliases = ["/docs/grafana/latest/enterprise/white-labeling/"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "White-labeling"
|
||||
parent = "enterprise"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
# White labeling
|
||||
|
||||
> Only available in Grafana Enterprise v6.6+. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}).
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v66/whitelabeling_1.png" max-width="800px" caption="White labeling example" >}}
|
||||
|
||||
This release adds new white labeling options to the `grafana.ini` file (can also be set via ENV variables).
|
||||
|
||||
You can change the following elements:
|
||||
|
||||
- Login Background
|
||||
- Login Logo
|
||||
- Side menu top logo
|
||||
- Footer & Help menu links
|
||||
- Fav icon (shown in browser tab)
|
||||
|
||||
> You will have to host your logo and other images used by the white labeling feature separately
|
||||
|
||||
```ini
|
||||
# Enterprise only
|
||||
[white_labeling]
|
||||
# Set to complete url to override login logo
|
||||
;login_logo =
|
||||
|
||||
# Set to complete css background expression to override login background
|
||||
# example: login_background = url(http://www.bhmpics.com/wallpapers/starfield-1920x1080.jpg)
|
||||
;login_background =
|
||||
|
||||
# Set to complete url to override menu logo
|
||||
;menu_logo =
|
||||
|
||||
# Set to complete url to override fav icon (icon shown in browser tab)
|
||||
;fav_icon =
|
||||
|
||||
# Set to complete url to override apple/ios icon
|
||||
;apple_touch_icon =
|
||||
|
||||
# Below is an example for how to replace the default footer & help links with 2 custom links
|
||||
;footer_links = support guides
|
||||
;footer_links_support_text = Support
|
||||
;footer_links_support_url = http://your.support.site
|
||||
;footer_links_guides_text = Guides
|
||||
;footer_links_guides_url = http://your.guides.site
|
||||
```
|
||||
@ -24,26 +24,40 @@ You can install Grafana using our official APT repository, by downloading a `.de
|
||||
|
||||
If you install from the APT repository, then Grafana is automatically updated every time you run `apt-get update`.
|
||||
|
||||
The APT repository installs the open source edition of Grafana.
|
||||
| Grafana Version | Package | Repository |
|
||||
|-----------------|---------|------------|
|
||||
| Grafana OSS | grafana | `https://packages.grafana.com/oss/deb stable main` |
|
||||
| Grafana OSS (Beta) | grafana | `https://packages.grafana.com/oss/deb beta main` |
|
||||
| Grafana Enterprise | grafana-enterprise | `https://packages.grafana.com/enterprise/deb stable main` |
|
||||
| Grafana Enterprise (Beta) | grafana-enterprise | `https://packages.grafana.com/enterprise/deb beta main` |
|
||||
|
||||
#### To install the latest stable release:
|
||||
> We recommend all users to install the Enterprise Edition of Grafana, which can be seamlessly upgraded with a Grafana Enterprise [subscription](https://grafana.com/products/enterprise/?utm_source=grafana-install-page).
|
||||
|
||||
#### To install the latest Enterprise edition:
|
||||
|
||||
```bash
|
||||
sudo apt-get install -y apt-transport-https
|
||||
sudo apt-get install -y software-properties-common wget
|
||||
wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add -
|
||||
sudo add-apt-repository "deb https://packages.grafana.com/oss/deb stable main"
|
||||
|
||||
|
||||
# Alternatively you can add the beta repository, see in the table above
|
||||
sudo add-apt-repository "deb https://packages.grafana.com/enterprise/deb stable main"
|
||||
|
||||
sudo apt-get update
|
||||
sudo apt-get install grafana
|
||||
sudo apt-get install grafana-enterprise
|
||||
```
|
||||
|
||||
#### To install the latest beta release:
|
||||
#### To install the latest OSS release:
|
||||
|
||||
```bash
|
||||
sudo apt-get install -y apt-transport-https
|
||||
sudo apt-get install -y software-properties-common wget
|
||||
wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add -
|
||||
sudo add-apt-repository "deb https://packages.grafana.com/oss/deb beta main"
|
||||
|
||||
# Alternatively you can add the beta repository, see in the table above
|
||||
sudo add-apt-repository "deb https://packages.grafana.com/oss/deb stable main"
|
||||
|
||||
sudo apt-get update
|
||||
sudo apt-get install grafana
|
||||
```
|
||||
@ -72,7 +86,7 @@ If you install the `.deb` package, then you will need to manually update Grafana
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
1. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the enterprise version, but you will need to download the enterprise version if you want enterprise features.
|
||||
* **Open Source** - 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 **Linux** or **ARM**.
|
||||
1. Copy and paste the code from the installation page into your command line and run. It follows the pattern shown below.
|
||||
|
||||
|
||||
@ -17,7 +17,65 @@ This page explains how to install Grafana dependencies, download and install Gra
|
||||
|
||||
**Note on upgrading:** While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing installation.
|
||||
|
||||
## 1. Download and install
|
||||
## Install from YUM repository
|
||||
|
||||
If you install from the YUM repository, then Grafana is automatically updated every time you run `sudo yum update`.
|
||||
|
||||
| Grafana Version | Package | Repository |
|
||||
|----------------------------|--------------------|----------------------------------------------------|
|
||||
| Grafana OSS | grafana | `https://packages.grafana.com/oss/rpm` |
|
||||
| Grafana OSS (Beta) | grafana | `https://packages.grafana.com/oss/rpm-beta` |
|
||||
| Grafana Enterprise | grafana-enterprise | `https://packages.grafana.com/enterprise/rpm` |
|
||||
| Grafana Enterprise (Beta) | grafana-enterprise | `https://packages.grafana.com/enterprise/rpm-beta` |
|
||||
|
||||
|
||||
Add a new file to your YUM repo using the method of your choice. The command below uses `nano`.
|
||||
|
||||
```bash
|
||||
sudo nano /etc/yum.repos.d/grafana.repo
|
||||
```
|
||||
|
||||
Choose if you want to install the Open Source or Enterprise edition of Grafana and enter the information from the edition you've chosen into `grafana.repo`. If you want to install the beta version of Grafana you need to replace the URL with a beta URL from the table above.
|
||||
|
||||
> We recommend all users to install the Enterprise Edition of Grafana, which can be seamlessly upgraded with a Grafana Enterprise [subscription](https://grafana.com/products/enterprise/?utm_source=grafana-install-page).
|
||||
|
||||
For Enterprise releases:
|
||||
```bash
|
||||
[grafana]
|
||||
name=grafana
|
||||
baseurl=https://packages.grafana.com/enterprise/rpm
|
||||
repo_gpgcheck=1
|
||||
enabled=1
|
||||
gpgcheck=1
|
||||
gpgkey=https://packages.grafana.com/gpg.key
|
||||
sslverify=1
|
||||
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
|
||||
```
|
||||
|
||||
For OSS releases:
|
||||
```bash
|
||||
[grafana]
|
||||
name=grafana
|
||||
baseurl=https://packages.grafana.com/oss/rpm
|
||||
repo_gpgcheck=1
|
||||
enabled=1
|
||||
gpgcheck=1
|
||||
gpgkey=https://packages.grafana.com/gpg.key
|
||||
sslverify=1
|
||||
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
|
||||
```
|
||||
|
||||
Install Grafana:
|
||||
|
||||
```bash
|
||||
sudo yum install grafana
|
||||
|
||||
# or
|
||||
|
||||
sudo yum install grafana-enterprise
|
||||
```
|
||||
|
||||
## Download and install
|
||||
|
||||
You can install Grafana from a YUM repository, manually using YUM, manually using RPM, or by downloading a binary `.tar.gz` file.
|
||||
|
||||
@ -30,7 +88,7 @@ If you install manually with YUM, then you will need to manually update Grafana
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
2. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the enterprise version, but you will need to download the enterprise version if you want enterprise features.
|
||||
* **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want enterprise features.
|
||||
3. Depending on which system you are running, click **Linux** or **ARM**.
|
||||
4. Copy and paste the code from the installation page into your command line and run. It follows the pattern shown below.
|
||||
|
||||
@ -44,47 +102,6 @@ sudo yum localinstall <local rpm package>
|
||||
sudo yum install <rpm package url>
|
||||
```
|
||||
|
||||
### Install from YUM repository
|
||||
|
||||
If you install from the YUM repository, then Grafana is automatically updated every time you run `sudo yum update`.
|
||||
|
||||
The YUM repository installs the open source edition of Grafana.
|
||||
|
||||
1. Add a new file to your YUM repo using the method of your choice. The command below uses `nano`.
|
||||
```bash
|
||||
sudo nano /etc/yum.repos.d/grafana.repo
|
||||
```
|
||||
2. Enter the following information in grafana.repo and then save it.
|
||||
|
||||
For stable releases:
|
||||
```bash
|
||||
[grafana]
|
||||
name=grafana
|
||||
baseurl=https://packages.grafana.com/oss/rpm
|
||||
repo_gpgcheck=1
|
||||
enabled=1
|
||||
gpgcheck=1
|
||||
gpgkey=https://packages.grafana.com/gpg.key
|
||||
sslverify=1
|
||||
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
|
||||
```
|
||||
For beta releases:
|
||||
```bash
|
||||
[grafana]
|
||||
name=grafana
|
||||
baseurl=https://packages.grafana.com/oss/rpm-beta
|
||||
repo_gpgcheck=1
|
||||
enabled=1
|
||||
gpgcheck=1
|
||||
gpgkey=https://packages.grafana.com/gpg.key
|
||||
sslverify=1
|
||||
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
|
||||
```
|
||||
3. Install Grafana.
|
||||
```bash
|
||||
sudo yum install grafana
|
||||
```
|
||||
|
||||
### Install with RPM
|
||||
|
||||
If you install with RPM, then you will need to manually update Grafana for each new version. This method varies according to which Linux OS you are running. Read the instructions fully before you begin.
|
||||
@ -96,7 +113,7 @@ If you install with RPM, then you will need to manually update Grafana for each
|
||||
* The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
2. Select an **Edition**.
|
||||
* **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose.
|
||||
* **Open Source** - Functionally identical to the enterprise version, but you will need to download the enterprise version if you want enterprise features.
|
||||
* **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features.
|
||||
3. Depending on which system you are running, click **Linux** or **ARM**.
|
||||
4. Copy and paste the .rpm package URL and the local .rpm package information from the installation page into the pattern shown below, then run the commands.
|
||||
|
||||
|
||||
@ -237,6 +237,8 @@
|
||||
name: SAML
|
||||
- link: /auth/team-sync/
|
||||
name: Team Sync
|
||||
- link: /enterprise/white-labeling/
|
||||
name: White labeling
|
||||
- name: Tutorials
|
||||
link: /tutorials/
|
||||
children:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user