Skip to content

Commit 7141149

Browse files
Docs: Edited Windows install instructions (grafana#20780)
* Edited Windows install instructions Moved one section from Windows install guide to developer-guide.md. Edited some content in windows.md and will add questions. * Updated per comments * Fixed broken links in basic_concepts.md * Revert "Fixed broken links in basic_concepts.md" This reverts commit e524ea9. * Update windows.md
1 parent de1e514 commit 7141149

File tree

3 files changed

+22
-31
lines changed

3 files changed

+22
-31
lines changed

contribute/developer-guide.md

+4
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ Log in using the default credentials:
7272

7373
When you log in for the first time, Grafana asks you to change your password.
7474

75+
#### Building on Windows
76+
77+
The Grafana backend includes Sqlite3 which requires GCC to compile. So in order to compile Grafana on Windows you need to install GCC. We recommend [TDM-GCC](http://tdm-gcc.tdragon.net/download).
78+
7579
## Test Grafana
7680

7781
The test suite consists of three types of tests: _Frontend tests_, _backend tests_, and _end-to-end tests_.

docs/sources/installation/requirements.md

100755100644
File mode changed.

docs/sources/installation/windows.md

100755100644
+18-31
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Installing on Windows"
2+
title = "Install on Windows"
33
description = "Installing Grafana on Windows"
44
keywords = ["grafana", "configuration", "documentation", "windows"]
55
type = "docs"
@@ -8,46 +8,33 @@ parent = "installation"
88
weight = 400
99
+++
1010

11-
# Installing on Windows
11+
# Install on Windows
1212

13-
Description | Download
14-
------------ | -------------
15-
Latest stable package for Windows | [x64](https://grafana.com/grafana/download?platform=windows)
13+
[Download the latest stable package for Windows.](https://grafana.com/grafana/download?platform=windows)
14+
15+
You can either download the Windows installer package or a standalone Windows binary file.
1616

1717
Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on updating an existing
1818
installation.
1919

20-
## Configure
21-
22-
**Important:** After you've downloaded the zip file and before extracting it, make sure to open properties for that file (right-click Properties) and check the `unblock` checkbox and `Ok`.
23-
24-
The zip file contains a folder with the current Grafana version. Extract
25-
this folder to anywhere you want Grafana to run from. Go into the
26-
`conf` directory and copy `sample.ini` to `custom.ini`. You should edit
27-
`custom.ini`, never `defaults.ini`.
28-
29-
The default Grafana port is `3000`, this port requires extra permissions
30-
on Windows. Edit `custom.ini` and uncomment the `http_port`
31-
configuration option (`;` is the comment character in ini files) and change it to something like `8080` or similar.
32-
That port should not require extra Windows privileges.
20+
## Install with Windows installer
3321

34-
Default login and password `admin`/ `admin`
22+
Download the .msi installation file and run it, then follow the instructions in [Getting Started](/guides/getting_started/) to log in. The Grafana service starts automatically.
3523

24+
## Install standalone Windows binary
3625

37-
Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, preferably from the
38-
command line. If you want to run Grafana as Windows service, download
39-
[NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows
40-
service using that tool.
26+
1. Download the zip file. The zip file contains a folder with the current Grafana version (or the one that you chose).
4127

42-
Read more about the [configuration options]({{< relref "configuration.md" >}}).
28+
**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`.
4329

44-
## Logging in for the first time
30+
1. Extract this folder to anywhere you want Grafana to run from.
4531

46-
To run Grafana open your browser and go to the port you configured above, e.g. http://localhost:8080/.
47-
Then follow the instructions [here]({{< relref "../guides/getting_started/" >}}).
32+
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
33+
[NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows service using that tool.
4834

49-
## Building on Windows
35+
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](/guides/getting_started/).
5036

51-
The Grafana backend includes Sqlite3 which requires GCC to compile. So
52-
in order to compile Grafana on Windows you need to install GCC. We
53-
recommend [TDM-GCC](http://tdm-gcc.tdragon.net/download).
37+
> **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.
38+
> 1. Go into the `conf` directory and copy `sample.ini` to `custom.ini`. **Note:** You should edit `custom.ini`, never `defaults.ini`.
39+
> 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.
40+
> Read more about the [configuration options]({{< relref "configuration.md" >}}).

0 commit comments

Comments
 (0)