From e6ea8f7e0bd3df2677411846261bbbad72154a7f Mon Sep 17 00:00:00 2001 From: Patrick O'Carroll Date: Tue, 14 Aug 2018 13:21:52 +0200 Subject: [PATCH 1/3] added guide for logging in to grafana for the first and how to add a datasource --- docs/sources/guides/getting_started.md | 25 ++++++++++++++++++++ docs/sources/installation/debian.md | 6 +++++ docs/sources/installation/docker.md | 6 +++++ docs/sources/installation/mac.md | 5 ++++ docs/sources/installation/rpm.md | 5 ++++ docs/sources/installation/windows.md | 6 +++++ docs/sources/project/building_from_source.md | 6 +++++ 7 files changed, 59 insertions(+) diff --git a/docs/sources/guides/getting_started.md b/docs/sources/guides/getting_started.md index f724504156f..fcb7ff9b060 100644 --- a/docs/sources/guides/getting_started.md +++ b/docs/sources/guides/getting_started.md @@ -15,6 +15,31 @@ weight = 1 This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running and have added at least one [Data Source](/features/datasources/). +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + + +## How to add a data source + +{{< docs-imagebox img="/img/docs/v52/sidemenu-datasource.png" max-width="250px" class="docs-image--right docs-image--no-shadow">}} + +Before you create your first dashboard you need to add your data source. + +First move your cursor to the cog on the side menu which will show you the configuration menu. If the side menu is not visible click the Grafana icon in the upper left corner. The first item on the configuration menu is data sources. Click and you will come to data sources. You can also simply click the cog. + + +Click Add data source and you will come to the settings page of your new data source. + +{{< docs-imagebox img="/img/docs/v52/add-datasource.png" max-width="700px" class="docs-image--no-shadow">}} + +The first thing you will do is give the data source a name and select the right type. +Next you need to specify the data sources HTTP URL and how you will access the data source. + +{{< docs-imagebox img="/img/docs/v52/datasource-settings.png" max-width="700px" class="docs-image--no-shadow">}} + +Now you are ready to save and test. + ## Beginner guides Watch the 10min [beginners guide to building dashboards](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) to get a quick intro to setting up Dashboards and Panels. diff --git a/docs/sources/installation/debian.md b/docs/sources/installation/debian.md index 4bb245a586e..e9504c7cbf3 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/installation/debian.md @@ -166,3 +166,9 @@ To configure Grafana add a configuration file named `custom.ini` to the Start Grafana by executing `./bin/grafana-server web`. The `grafana-server` binary needs the working directory to be the root install directory (where the binary and the `public` folder is located). + +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + +Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file diff --git a/docs/sources/installation/docker.md b/docs/sources/installation/docker.md index 1f755625699..719af9a4e05 100644 --- a/docs/sources/installation/docker.md +++ b/docs/sources/installation/docker.md @@ -212,3 +212,9 @@ chown -R root:root /etc/grafana && \ chown -R grafana:grafana /var/lib/grafana && \ chown -R grafana:grafana /usr/share/grafana ``` + +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + +Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 12ff4adaab9..72ec0871646 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -92,3 +92,8 @@ Start Grafana by executing `./bin/grafana-server web`. The `grafana-server` binary needs the working directory to be the root install directory (where the binary and the `public` folder is located). +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + +Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file diff --git a/docs/sources/installation/rpm.md b/docs/sources/installation/rpm.md index 13597b9d921..0f50ed026b8 100644 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/installation/rpm.md @@ -193,3 +193,8 @@ Start Grafana by executing `./bin/grafana-server web`. The `grafana-server` binary needs the working directory to be the root install directory (where the binary and the `public` folder is located). +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + +Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md index 5dc87984512..5bd66b8ac6d 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/installation/windows.md @@ -43,3 +43,9 @@ Read more about the [configuration options]({{< relref "configuration.md" >}}). 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). + +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + +Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file diff --git a/docs/sources/project/building_from_source.md b/docs/sources/project/building_from_source.md index a0b553594ce..6a9e56a5eda 100644 --- a/docs/sources/project/building_from_source.md +++ b/docs/sources/project/building_from_source.md @@ -144,3 +144,9 @@ Please contribute to the Grafana project and submit a pull request! Build new fe **Problem**: On Windows, getting errors about a tool not being installed even though you just installed that tool. **Solution**: It is usually because it got added to the path and you have to restart your command prompt to use it. + +## Logging in for the first time + +To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. + +Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file From d38c159893bec77d1a6ce1657f8375f08f20cb3c Mon Sep 17 00:00:00 2001 From: Patrick O'Carroll Date: Thu, 23 Aug 2018 14:39:50 +0200 Subject: [PATCH 2/3] added link to getting started to all, changed wording --- docs/sources/guides/getting_started.md | 10 +++++----- docs/sources/installation/debian.md | 5 ++--- docs/sources/installation/docker.md | 5 ++--- docs/sources/installation/mac.md | 5 ++--- docs/sources/installation/rpm.md | 5 ++--- docs/sources/installation/windows.md | 5 ++--- docs/sources/project/building_from_source.md | 5 ++--- 7 files changed, 17 insertions(+), 23 deletions(-) diff --git a/docs/sources/guides/getting_started.md b/docs/sources/guides/getting_started.md index fcb7ff9b060..783009c60b5 100644 --- a/docs/sources/guides/getting_started.md +++ b/docs/sources/guides/getting_started.md @@ -17,7 +17,7 @@ This guide will help you get started and acquainted with Grafana. It assumes you ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. +To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. There you will see the login page. Default username is admin and default password is admin. When you log in for the first time you will be asked to change your password. We strongly encourage you to follow Grafana’s best practices and change the default administrator password. You can later go to user preferences and change your user name. ## How to add a data source @@ -26,19 +26,19 @@ To run Grafana open your browser and go to port 3000 which is the default port. Before you create your first dashboard you need to add your data source. -First move your cursor to the cog on the side menu which will show you the configuration menu. If the side menu is not visible click the Grafana icon in the upper left corner. The first item on the configuration menu is data sources. Click and you will come to data sources. You can also simply click the cog. +First move your cursor to the cog on the side menu which will show you the configuration menu. If the side menu is not visible click the Grafana icon in the upper left corner. The first item on the configuration menu is data sources, click on that and you'll be taken to the data sources page where you can add and edit data sources. You can also simply click the cog. Click Add data source and you will come to the settings page of your new data source. {{< docs-imagebox img="/img/docs/v52/add-datasource.png" max-width="700px" class="docs-image--no-shadow">}} -The first thing you will do is give the data source a name and select the right type. -Next you need to specify the data sources HTTP URL and how you will access the data source. +First, give the data source a Name and then select which Type of data source you'll want to create, see [Supported data sources](/features/datasources/#supported-data-sources/) for more information and how to configure your data source. + {{< docs-imagebox img="/img/docs/v52/datasource-settings.png" max-width="700px" class="docs-image--no-shadow">}} -Now you are ready to save and test. +After you have configuered your data source you are ready to save and test. ## Beginner guides diff --git a/docs/sources/installation/debian.md b/docs/sources/installation/debian.md index e9504c7cbf3..2d0c5aaf36e 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/installation/debian.md @@ -169,6 +169,5 @@ binary and the `public` folder is located). ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. - -Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file +To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/docker.md b/docs/sources/installation/docker.md index 719af9a4e05..714143547ab 100644 --- a/docs/sources/installation/docker.md +++ b/docs/sources/installation/docker.md @@ -215,6 +215,5 @@ chown -R root:root /etc/grafana && \ ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. - -Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file +To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 72ec0871646..0bc09aee61a 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -94,6 +94,5 @@ binary and the `public` folder is located). ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. - -Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file +To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/rpm.md b/docs/sources/installation/rpm.md index 0f50ed026b8..2e22d424c29 100644 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/installation/rpm.md @@ -195,6 +195,5 @@ binary and the `public` folder is located). ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. - -Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file +To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md index 5bd66b8ac6d..6cf68e75d67 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/installation/windows.md @@ -46,6 +46,5 @@ recommend [TDM-GCC](http://tdm-gcc.tdragon.net/download). ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. - -Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file +To run Grafana open your browser and go to the port you configured above, e.g. http://localhost:8080. +Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/project/building_from_source.md b/docs/sources/project/building_from_source.md index 6a9e56a5eda..b1e17b655c8 100644 --- a/docs/sources/project/building_from_source.md +++ b/docs/sources/project/building_from_source.md @@ -147,6 +147,5 @@ Please contribute to the Grafana project and submit a pull request! Build new fe ## Logging in for the first time -To run Grafana open your browser and go to port 3000 which is the default port. If you have changed the port you go to that port. There you will see the login page. User name is admin and password is admin. When you log in for the first time you will be asked to change your password. You can later go to user preferences and change your user name. - -Here you can get help [getting started](https://www.youtube.com/watch?v=sKNZMtoSHN4&index=7&list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2) with your dashboards. \ No newline at end of file +To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file From b218290f3ae28c2109f4a67039ae922319caaa9b Mon Sep 17 00:00:00 2001 From: Marcus Efraimsson Date: Thu, 23 Aug 2018 17:39:39 +0200 Subject: [PATCH 3/3] docs: changes --- docs/sources/guides/getting_started.md | 7 +++++-- docs/sources/installation/debian.md | 2 +- docs/sources/installation/docker.md | 2 +- docs/sources/installation/mac.md | 2 +- docs/sources/installation/rpm.md | 2 +- docs/sources/installation/windows.md | 10 +++++----- 6 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/sources/guides/getting_started.md b/docs/sources/guides/getting_started.md index 783009c60b5..a27c6ca4c99 100644 --- a/docs/sources/guides/getting_started.md +++ b/docs/sources/guides/getting_started.md @@ -13,11 +13,14 @@ weight = 1 # Getting started -This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running and have added at least one [Data Source](/features/datasources/). +This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running. If not please read the [installation guide](/installation/). ## Logging in for the first time -To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. There you will see the login page. Default username is admin and default password is admin. When you log in for the first time you will be asked to change your password. We strongly encourage you to follow Grafana’s best practices and change the default administrator password. You can later go to user preferences and change your user name. +To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default http port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port). + +There you will see the login page. Default username is admin and default password is admin. When you log in for the first time you will be asked to change your password. We strongly encourage you to +follow Grafana’s best practices and change the default administrator password. You can later go to user preferences and change your user name. ## How to add a data source diff --git a/docs/sources/installation/debian.md b/docs/sources/installation/debian.md index 2d0c5aaf36e..13fa3440170 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/installation/debian.md @@ -169,5 +169,5 @@ binary and the `public` folder is located). ## Logging in for the first time -To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default http port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port). Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/docker.md b/docs/sources/installation/docker.md index 714143547ab..c9d69f854d2 100644 --- a/docs/sources/installation/docker.md +++ b/docs/sources/installation/docker.md @@ -215,5 +215,5 @@ chown -R root:root /etc/grafana && \ ## Logging in for the first time -To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default http port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port). Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 0bc09aee61a..fbc00c01737 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -94,5 +94,5 @@ binary and the `public` folder is located). ## Logging in for the first time -To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default http port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port). Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/rpm.md b/docs/sources/installation/rpm.md index 2e22d424c29..24c301c5763 100644 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/installation/rpm.md @@ -195,5 +195,5 @@ binary and the `public` folder is located). ## Logging in for the first time -To run Grafana open your browser and go to the default port http://localhost:3000 or the port you have configured. +To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default http port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port). Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md index 6cf68e75d67..572081a1c54 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/installation/windows.md @@ -38,13 +38,13 @@ service using that tool. Read more about the [configuration options]({{< relref "configuration.md" >}}). +## Logging in for the first time + +To run Grafana open your browser and go to the port you configured above, e.g. http://localhost:8080/. +Then follow the instructions [here](/guides/getting_started/). + ## Building on Windows 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). - -## Logging in for the first time - -To run Grafana open your browser and go to the port you configured above, e.g. http://localhost:8080. -Then follow the instructions [here](/guides/getting_started/). \ No newline at end of file