mirror of https://github.com/grafana/grafana
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>pull/65132/head
Christopher Moyer
2 years ago
committed by
GitHub
parent
fc761ad69f
commit
d67ad9efc4
@ -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. |
||||
|
||||
## Install with Windows installer (recommended) |
||||
a. Click **Download the installer**. |
||||
|
||||
1. Click **Download the installer**. |
||||
1. Open and run the installer. |
||||
b. Open and run the installer. |
||||
|
||||
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 install the standalone Windows binary, complete the following steps: |
||||
|
||||
## Install standalone Windows binary |
||||
a. Click **Download the zip file**. |
||||
|
||||
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`. |
||||
b. Right-click the downloaded file, select **Properties**, select the `unblock` checkbox, and 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 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 |
||||
|
||||
> **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/" >}}). |
||||
- [Start the Grafana server]({{< relref "../../start-restart-grafana/" >}}) |
||||
|
||||
Loading…
Reference in new issue