diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 89bebdcd765..9db0225a948 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -43,6 +43,7 @@ pages: - ['reference/scripting.md', 'Reference', 'Scripted dashboards'] - ['reference/playlist.md', 'Reference', 'Playlist'] - ['reference/export_import.md', 'Reference', 'Import & Export'] +- ['reference/admin.md', 'Reference', 'Grafana Admin'] - ['datasources/graphite.md', 'Data Sources', 'Graphite'] - ['datasources/influxdb.md', 'Data Sources', 'InfluxDB'] diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md index d38a3e4363d..6a8063b404a 100644 --- a/docs/sources/installation/configuration.md +++ b/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 > parameter. - +
## [server] ### 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 why the Grafana binary needs to be executed with working directory set to the installation path. +
## [database] 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 For `postgres` only, either "disable", "require" or "verify-full". -## Security +
+## [security] ### admin_user 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 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 The number of days the keep me logged in / remember me cookie lasts. ### secret_key Used for signing keep me logged in / remember me cookies. +
+## [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`. + +
## [session] ### provider diff --git a/docs/sources/reference/admin.md b/docs/sources/reference/admin.md new file mode 100644 index 00000000000..cc0548f0ac6 --- /dev/null +++ b/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. +