mirror of
https://github.com/grafana/grafana.git
synced 2024-11-26 02:40:26 -06:00
docs: updates windows/mac install topics (#64740)
* updates windows/mac install topics * corrects typo * Apply suggestions from code review Co-authored-by: Dan Cech <dcech@grafana.com> * tweaks --------- Co-authored-by: Dan Cech <dcech@grafana.com>
This commit is contained in:
Christopher Moyer
GitHub
parent
fc761ad69f
commit
d67ad9efc4
@ -1,23 +1,25 @@
|
||||
---
|
||||
aliases:
|
||||
- ../../installation/mac/
|
||||
description: Installing Grafana on macOS
|
||||
title: Install on macOS
|
||||
description: How to install Grafana OSS or Enterprise on macOS
|
||||
title: Install Grafana on macOS
|
||||
menuTitle: macOS
|
||||
weight: 600
|
||||
---
|
||||
|
||||
# Install on macOS
|
||||
# Install Grafana on macOS
|
||||
|
||||
This page explains how to install Grafana and get the service running on your macOS.
|
||||
This page explains how to install Grafana on macOS.
|
||||
|
||||
**Note on upgrading:** While the process for upgrading Grafana is very similar to installing Grafana, there are some key backup steps you should perform. Before you perform an upgrade, read [Upgrading Grafana]({{< relref "../../../upgrade-guide/" >}}) for tips and guidance on updating an existing installation.
|
||||
## Install Grafana on macOS using Homebrew
|
||||
|
||||
## Install with Homebrew
|
||||
To install Grafana on macOS using Homebrew, complete the following steps:
|
||||
|
||||
Use [Homebrew](http://brew.sh/) to install the most recent released version of Grafana using Homebrew package.
|
||||
1. On the [Homebrew](http://brew.sh/) homepage, search for Grafana.
|
||||
|
||||
1. On the Homebrew homepage, search for Grafana. The last stable and released version is listed.
|
||||
1. Open a terminal and enter:
|
||||
The last stable and released version is listed.
|
||||
|
||||
1. Open a terminal and run the following commands:
|
||||
|
||||
```
|
||||
brew update
|
||||
@ -26,47 +28,39 @@ Use [Homebrew](http://brew.sh/) to install the most recent released version of G
|
||||
|
||||
The brew page downloads and untars the files into:
|
||||
|
||||
- `/usr/local/Cellar/grafana/[version]` (Homebrew v2)
|
||||
- `/opt/homebrew/Cellar/grafana/[version]` (Homebrew v3)
|
||||
- `/usr/local/Cellar/grafana/[version]` (Intel Silicon)
|
||||
- `/opt/homebrew/Cellar/grafana/[version]` (Apple Silicon)
|
||||
|
||||
1. To start Grafana, run the following command:
|
||||
|
||||
1. Start Grafana using the command:
|
||||
```bash
|
||||
brew services start grafana
|
||||
```
|
||||
|
||||
## Install standalone macOS binaries
|
||||
|
||||
To install a nightly build, or to install the latest version of Grafana without Homebrew, go to the [Grafana download page](https://grafana.com/grafana/download?platform=mac).
|
||||
|
||||
1. Select the Grafana version you want to install. By default, the most recent released version is selected.
|
||||
|
||||
> **Note:** The downloads page lists only finished releases. If you want to install a beta version, click [Nightly ] **Nightly Builds** and then select a version.
|
||||
To install Grafana on macOS using the standalone binaries, complete the following steps:
|
||||
|
||||
1. Navigate to the [Grafana download page](https://grafana.com/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**.
|
||||
- **Open Source** - Functionally identical to the enterprise version, but you will need to download the enterprise version if you want enterprise features.
|
||||
- **Enterprise** - Recommended download. 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. Click **Mac**.
|
||||
1. Open a terminal and download the binary using the cURL command. The following example shows Grafana 7.1.5 version:
|
||||
```bash
|
||||
curl -O https://dl.grafana.com/oss/release/grafana-7.1.5.darwin-amd64.tar.gz
|
||||
```
|
||||
1. Untar the gz file and copy the files to the location of your preference.
|
||||
1. Copy and paste the code from the installation page into your command line and run.
|
||||
1. Untar the `gz` file and copy the files to the location of your preference.
|
||||
1. To start Grafana service, go to the directory and run the command:
|
||||
|
||||
```bash
|
||||
./bin/grafana-server web
|
||||
./bin/grafana-server
|
||||
```
|
||||
|
||||
## Upgrade Grafana
|
||||
|
||||
While the process for upgrading Grafana is very similar to installing Grafana, there are important backup tasks you should perform. Refer to [Upgrade Grafana]({{< relref "../../../upgrade-guide/" >}}) for guidance on updating an existing installation.
|
||||
|
||||
## Next steps
|
||||
|
||||
Refer to the [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}) guide for information about logging in, setting up data sources, and so on. Also, refer to the [Configuration]({{< relref "../../configure-grafana/" >}}) page for details on options for customizing your environment, logging, database, and so on.
|
||||
|
||||
## Upgrade
|
||||
|
||||
**Using Homebrew**
|
||||
|
||||
To upgrade Grafana, use the reinstall command:
|
||||
|
||||
```bash
|
||||
brew update
|
||||
brew reinstall grafana
|
||||
```
|
||||
- [Start the Grafana server]({{< relref "../../start-restart-grafana/" >}})
|
||||
|
||||
@ -1,49 +1,63 @@
|
||||
---
|
||||
aliases:
|
||||
- ../../installation/windows/
|
||||
description: Install Grafana on Windows
|
||||
title: Install on Windows
|
||||
description: How to install Grafana OSS or Enterprise on Windows
|
||||
title: Install Grafana on Windows
|
||||
menutitle: Windows
|
||||
weight: 500
|
||||
---
|
||||
|
||||
# Install on Windows
|
||||
# Install Grafana on Windows
|
||||
|
||||
You can either download the Windows installer package or a standalone Windows binary file.
|
||||
You install Grafana using the Windows installer or using the standalone Windows binary file.
|
||||
|
||||
Read [Upgrading Grafana]({{< relref "../../../upgrade-guide/" >}}) for tips and guidance on updating an existing installation.
|
||||
|
||||
1. Navigate to [Download Grafana](https://grafana.com/grafana/download?platform=windows).
|
||||
1. Select a Grafana version you want to install.
|
||||
1. Navigate to the [Grafana download page](https://grafana.com/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 finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version.
|
||||
- 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** - 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.
|
||||
- **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. Click **Windows**.
|
||||
1. To use the Windows installer, complete the following steps:
|
||||
|
||||
You can either use the Windows installer or you can install a standalone Windows binary.
|
||||
a. Click **Download the installer**.
|
||||
|
||||
## Install with Windows installer (recommended)
|
||||
b. Open and run the installer.
|
||||
|
||||
1. Click **Download the installer**.
|
||||
1. Open and run the installer.
|
||||
1. To install the standalone Windows binary, complete the following steps:
|
||||
|
||||
To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}).
|
||||
a. Click **Download the zip file**.
|
||||
|
||||
## Install standalone Windows binary
|
||||
b. Right-click the downloaded file, select **Properties**, select the `unblock` checkbox, and click `OK`.
|
||||
|
||||
1. Click **Download the zip file**.
|
||||
**Important:** After you've downloaded the zip file and before extracting it, make sure to open the properties for that file (right-click **Properties**) and select the `unblock` check box and then click `Ok`.
|
||||
|
||||
1. Extract this folder to anywhere you want Grafana to run from.
|
||||
c. Extract the ZIP file to any folder.
|
||||
|
||||
1. Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, preferably from the command line. If you want to run Grafana as a Windows service, then download
|
||||
[NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows service using that tool.
|
||||
|
||||
To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}).
|
||||
1. To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../../getting-started/build-first-dashboard/" >}}).
|
||||
|
||||
> **Note:** The default Grafana port is `3000`. This port might require extra permissions on Windows. If it does not appear in the default port, you can try changing to a different port.
|
||||
>
|
||||
> 1. Go into the `conf` directory and copy `sample.ini` to `custom.ini`. **Note:** You should edit `custom.ini`, never `defaults.ini`.
|
||||
> 1. Edit `custom.ini` and uncomment the `http_port` configuration option (`;` is the comment character in ini files) and change it to something like `8080` or similar. That port should not require extra Windows privileges.
|
||||
> Read more about the [configuration options]({{< relref "../../configure-grafana/" >}}).
|
||||
> **Note:** The default Grafana port is `3000`. This port might require extra permissions on Windows. If it does not appear in the default port, you can change the port number.
|
||||
|
||||
1. To change the port, perform the following steps:
|
||||
|
||||
a. Open the `conf` directory and copy `sample.ini` to `custom.ini`.
|
||||
|
||||
> **Note:** You should edit `custom.ini`, never `defaults.ini`.
|
||||
|
||||
b. Edit `custom.ini` and uncomment the `http_port` configuration option.
|
||||
|
||||
`;` is the comment character in ini files.
|
||||
|
||||
c. Change the port to `8080` or something similar.
|
||||
|
||||
Port `8080` should not require extra Windows privileges.
|
||||
|
||||
## Upgrade Grafana
|
||||
|
||||
While the process for upgrading Grafana is very similar to installing Grafana, there are important backup tasks you should perform. Refer to [Upgrade Grafana]({{< relref "../../../upgrade-guide/" >}}) for guidance on updating an existing installation.
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Start the Grafana server]({{< relref "../../start-restart-grafana/" >}})
|
||||
|
||||
Loading…
Reference in New Issue
Block a user