Просмотр исходного кода

Working on config docs for grafana 2.0

Torkel Ödegaard 10 лет назад
Родитель
Сommit
9c2edba12b
3 измененных файлов с 34 добавлено и 5 удалено
  1. 1 0
      docs/mkdocs.yml
  2. 23 5
      docs/sources/installation/configuration.md
  3. 10 0
      docs/sources/reference/admin.md

+ 1 - 0
docs/mkdocs.yml

@@ -43,6 +43,7 @@ pages:
 - ['reference/scripting.md', 'Reference', 'Scripted dashboards']
 - ['reference/scripting.md', 'Reference', 'Scripted dashboards']
 - ['reference/playlist.md', 'Reference', 'Playlist']
 - ['reference/playlist.md', 'Reference', 'Playlist']
 - ['reference/export_import.md', 'Reference', 'Import & Export']
 - ['reference/export_import.md', 'Reference', 'Import & Export']
+- ['reference/admin.md', 'Reference', 'Grafana Admin']
 
 
 - ['datasources/graphite.md', 'Data Sources', 'Graphite']
 - ['datasources/graphite.md', 'Data Sources', 'Graphite']
 - ['datasources/influxdb.md', 'Data Sources', 'InfluxDB']
 - ['datasources/influxdb.md', 'Data Sources', 'InfluxDB']

+ 23 - 5
docs/sources/installation/configuration.md

@@ -19,7 +19,7 @@ or specified using `ENV` variables.
 > at `/etc/grafana/grafana.ini`. This path is specified in the grafana init.d script using `--config` file
 > at `/etc/grafana/grafana.ini`. This path is specified in the grafana init.d script using `--config` file
 > parameter.
 > parameter.
 
 
-
+<hr>
 ## [server]
 ## [server]
 
 
 ### http_addr
 ### http_addr
@@ -43,6 +43,7 @@ google or github oauth authentication (for the callback url to be correct).
 The path to the directory where the frontend files (html & js & css). Default to `public` which is
 The path to the directory where the frontend files (html & js & css). Default to `public` which is
 why the Grafana binary needs to be executed with working directory set to the installation path.
 why the Grafana binary needs to be executed with working directory set to the installation path.
 
 
+<hr>
 ## [database]
 ## [database]
 
 
 Grafana needs a database to store users and dashboards (and other things). By default it is configured to
 Grafana needs a database to store users and dashboards (and other things). By default it is configured to
@@ -70,7 +71,8 @@ The database user's password (not applicable for `sqlite3`).
 ### ssl_mode
 ### ssl_mode
 For `postgres` only, either "disable", "require" or "verify-full".
 For `postgres` only, either "disable", "require" or "verify-full".
 
 
-## Security
+<hr>
+## [security]
 
 
 ### admin_user
 ### admin_user
 The name of the default grafana admin user (who has full permissions). Defaults to `admin`.
 The name of the default grafana admin user (who has full permissions). Defaults to `admin`.
@@ -78,15 +80,31 @@ The name of the default grafana admin user (who has full permissions). Defaults
 ### admin_password
 ### admin_password
 The password of the default grafana admin.  Defaults to `admin`.
 The password of the default grafana admin.  Defaults to `admin`.
 
 
-### disable_user_signup
-Set to `false` to prohibit users from creating user accounts. Defaults to `false`.
-
 ### login_remember_days
 ### login_remember_days
 The number of days the keep me logged in / remember me cookie lasts.
 The number of days the keep me logged in / remember me cookie lasts.
 
 
 ### secret_key
 ### secret_key
 Used for signing keep me logged in / remember me cookies.
 Used for signing keep me logged in / remember me cookies.
 
 
+<hr>
+## [user]
+
+### allow_sign_up
+Set to `false` to prohibit users from being able to sign up / create user accounts. Defaults to `true`.
+The admin can still create users from the [Grafana Admin Pages](../reference/admin.md)
+
+### allow_org_create
+Set to `false` to prohibit users from creating new organizations. Defaults to `true`.
+
+### auto_assign_org
+Set to `true` to automatically add new users to the main organization (id 1). When set to `false`,
+new users will automatically cause a new organization to be created for that new user.
+
+### auto_assign_org_role
+The role new users will be assigned for the main organization (if the above setting is set to true).
+Defaults to `Viewer`, other valid options are `Admin` and `Editor`.
+
+<hr>
 ## [session]
 ## [session]
 
 
 ### provider
 ### provider

+ 10 - 0
docs/sources/reference/admin.md

@@ -0,0 +1,10 @@
+----
+page_title: Grafana Admin
+page_description: Grafana Admin guide
+page_keywords: grafana, admin, administration, documentation
+---
+
+# Grafana Admin
+
+This documentation page has yet to be written.
+