| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | +++ | 
					
						
							|  |  |  | title = "Overview" | 
					
						
							|  |  |  | description = "Overview for auth" | 
					
						
							|  |  |  | type = "docs" | 
					
						
							|  |  |  | [menu.docs] | 
					
						
							|  |  |  | name = "Overview" | 
					
						
							|  |  |  | identifier = "overview-auth" | 
					
						
							|  |  |  | parent = "authentication" | 
					
						
							|  |  |  | weight = 1 | 
					
						
							|  |  |  | +++ | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | # User Authentication Overview
 | 
					
						
							| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user | 
					
						
							|  |  |  | permissions and org memberships. | 
					
						
							| 
									
										
										
										
											2018-08-31 13:15:07 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 19:15:36 +08:00
										 |  |  | ## OAuth Integrations
 | 
					
						
							| 
									
										
										
										
											2018-08-31 13:15:07 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | - [Google OAuth]({{< relref "auth/google.md" >}}) | 
					
						
							|  |  |  | - [GitHub OAuth]({{< relref "auth/github.md" >}}) | 
					
						
							|  |  |  | - [Gitlab OAuth]({{< relref "auth/gitlab.md" >}}) | 
					
						
							| 
									
										
										
										
											2018-09-06 19:21:11 +08:00
										 |  |  | - [Generic OAuth]({{< relref "auth/generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0) | 
					
						
							| 
									
										
										
										
											2018-08-31 13:15:07 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | ## LDAP integrations
 | 
					
						
							| 
									
										
										
										
											2018-08-31 13:15:07 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | - [LDAP Authentication]({{< relref "auth/ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc) | 
					
						
							| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | ## Auth proxy
 | 
					
						
							| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | - [Auth Proxy]({{< relref "auth/auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse | 
					
						
							|  |  |  |     proxy. | 
					
						
							| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | ## Grafana Auth
 | 
					
						
							| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-20 21:16:43 +08:00
										 |  |  | Grafana of course has a built in user authentication system with password authentication enabled by default. You can | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | disable authentication by enabling anonymous access. You can also hide login form and only allow login through an auth | 
					
						
							|  |  |  | provider (listed above). There is also options for allowing self sign up. | 
					
						
							| 
									
										
										
										
											2018-08-13 20:28:41 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-09-20 21:16:43 +08:00
										 |  |  | ### Anonymous authentication
 | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | You can make Grafana accessible without any login required by enabling anonymous access in the configuration file. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Example: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | [auth.anonymous] | 
					
						
							|  |  |  | enabled = true | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Organization name that should be used for unauthenticated users
 | 
					
						
							|  |  |  | org_name = Main Org. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Role for unauthenticated users, other valid values are `Editor` and `Admin`
 | 
					
						
							|  |  |  | org_role = Viewer | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | If you change your organization name in the Grafana UI this setting needs to be updated to match the new name. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Basic authentication
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Basic auth is enabled by default and works with the built in Grafana user password authentication system and LDAP | 
					
						
							| 
									
										
										
										
											2018-10-06 23:09:41 +08:00
										 |  |  | authentication integration. | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | To disable basic auth: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | [auth.basic] | 
					
						
							|  |  |  | enabled = false | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Disable login form
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | You can hide the Grafana login form using the below configuration settings. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | [auth] | 
					
						
							| 
									
										
										
										
											2018-05-28 22:15:31 +08:00
										 |  |  | disable_login_form = true | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Automatic OAuth login
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Set to true to attempt login with OAuth automatically, skipping the login screen.  | 
					
						
							|  |  |  | This setting is ignored if multiple OAuth providers are configured.  | 
					
						
							|  |  |  | Defaults to `false`. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | [auth] | 
					
						
							|  |  |  | oauth_auto_login = true | 
					
						
							| 
									
										
										
										
											2018-09-06 18:11:56 +08:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Hide sign-out menu
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Set to the option detailed below to true to hide sign-out menu link. Useful if you use an auth proxy. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | [auth] | 
					
						
							|  |  |  | disable_signout_menu = true | 
					
						
							|  |  |  | ``` |