| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | --- | 
					
						
							|  |  |  | title: Custom OIDC SSO for Docker | 
					
						
							|  |  |  | slug: /deployment/security/custom-oidc/docker | 
					
						
							|  |  |  | --- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Custom OIDC SSO for Docker
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | To enable security for the Docker deployment, follow the next steps: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## 1. Create an .env file
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-08-05 23:03:33 +05:30
										 |  |  | Create an `openmetadata_oidc.env` file and add the following contents as an example. Use the information | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | generated when setting up the account. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-10-07 12:47:43 +02:00
										 |  |  | ### 1.1 Before 0.12.1
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-08-05 23:03:33 +05:30
										 |  |  | ```shell | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | # OpenMetadata Server Authentication Configuration
 | 
					
						
							| 
									
										
										
										
											2022-10-05 21:54:02 -07:00
										 |  |  | AUTHORIZER_CLASS_NAME=org.openmetadata.service.security.DefaultAuthorizer | 
					
						
							|  |  |  | AUTHORIZER_REQUEST_FILTER=org.openmetadata.service.security.JwtFilter | 
					
						
							| 
									
										
										
										
											2022-08-05 23:03:33 +05:30
										 |  |  | AUTHORIZER_ADMIN_PRINCIPALS=[admin]  # Your `name` from name@domain.com | 
					
						
							|  |  |  | AUTHORIZER_INGESTION_PRINCIPALS=[ingestion-bot] | 
					
						
							|  |  |  | AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | AUTHENTICATION_PROVIDER=custom-oidc | 
					
						
							|  |  |  | CUSTOM_OIDC_AUTHENTICATION_PROVIDER_NAME=KeyCloak | 
					
						
							|  |  |  | AUTHENTICATION_PUBLIC_KEYS=[{http://localhost:8080/realms/myrealm/protocol/openid-connect/certs}] | 
					
						
							|  |  |  | AUTHENTICATION_AUTHORITY={http://localhost:8080/realms/myrealm} | 
					
						
							|  |  |  | AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID | 
					
						
							|  |  |  | AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | # Airflow Configuration
 | 
					
						
							| 
									
										
										
										
											2022-08-05 23:03:33 +05:30
										 |  |  | AIRFLOW_AUTH_PROVIDER=custom-oidc | 
					
						
							|  |  |  | OM_AUTH_AIRFLOW_CUSTOM_OIDC_CLIENT_ID={Client Id} # Update with your Client ID | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | # Make sure to add the path where the file is saved in the Airflow Volume
 | 
					
						
							|  |  |  | # It needs to be reachable locally by the container
 | 
					
						
							| 
									
										
										
										
											2022-11-29 18:28:16 +05:30
										 |  |  | OM_AUTH_AIRFLOW_CUSTOM_OIDC_SECRET_KEY={Secret Key Path} # Update with your Secret Key Path | 
					
						
							| 
									
										
										
										
											2022-08-05 23:03:33 +05:30
										 |  |  | OM_AUTH_AIRFLOW_CUSTOM_OIDC_TOKEN_ENDPOINT_URL={endpoint}  | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-10-07 12:47:43 +02:00
										 |  |  | ### 1.2 After 0.12.1
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```shell | 
					
						
							|  |  |  | # OpenMetadata Server Authentication Configuration
 | 
					
						
							|  |  |  | AUTHORIZER_CLASS_NAME=org.openmetadata.service.security.DefaultAuthorizer | 
					
						
							|  |  |  | AUTHORIZER_REQUEST_FILTER=org.openmetadata.service.security.JwtFilter | 
					
						
							|  |  |  | AUTHORIZER_ADMIN_PRINCIPALS=[admin]  # Your `name` from name@domain.com | 
					
						
							|  |  |  | AUTHORIZER_INGESTION_PRINCIPALS=[ingestion-bot] | 
					
						
							|  |  |  | AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | AUTHENTICATION_PROVIDER=custom-oidc | 
					
						
							|  |  |  | CUSTOM_OIDC_AUTHENTICATION_PROVIDER_NAME=KeyCloak | 
					
						
							|  |  |  | AUTHENTICATION_PUBLIC_KEYS=[{http://localhost:8080/realms/myrealm/protocol/openid-connect/certs}] | 
					
						
							|  |  |  | AUTHENTICATION_AUTHORITY={http://localhost:8080/realms/myrealm} | 
					
						
							|  |  |  | AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID | 
					
						
							|  |  |  | AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-11-24 12:33:59 +05:30
										 |  |  | ### 1.3 After 0.13.0
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```shell | 
					
						
							|  |  |  | # OpenMetadata Server Authentication Configuration
 | 
					
						
							|  |  |  | AUTHORIZER_CLASS_NAME=org.openmetadata.service.security.DefaultAuthorizer | 
					
						
							|  |  |  | AUTHORIZER_REQUEST_FILTER=org.openmetadata.service.security.JwtFilter | 
					
						
							|  |  |  | AUTHORIZER_ADMIN_PRINCIPALS=[admin]  # Your `name` from name@domain.com | 
					
						
							|  |  |  | AUTHORIZER_PRINCIPAL_DOMAIN=open-metadata.org # Update with your domain | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | AUTHENTICATION_PROVIDER=custom-oidc | 
					
						
							|  |  |  | CUSTOM_OIDC_AUTHENTICATION_PROVIDER_NAME=KeyCloak | 
					
						
							|  |  |  | AUTHENTICATION_PUBLIC_KEYS=[{http://localhost:8080/realms/myrealm/protocol/openid-connect/certs}] | 
					
						
							|  |  |  | AUTHENTICATION_AUTHORITY={http://localhost:8080/realms/myrealm} | 
					
						
							|  |  |  | AUTHENTICATION_CLIENT_ID={Client ID} # Update with your Client ID | 
					
						
							|  |  |  | AUTHENTICATION_CALLBACK_URL=http://localhost:8585/callback | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-10-07 12:47:43 +02:00
										 |  |  | **Note:** Follow [this](/how-to-guides/feature-configurations/bots) guide to configure the `ingestion-bot` credentials for | 
					
						
							|  |  |  | ingesting data from Airflow. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | ## 2. Start Docker
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```commandline | 
					
						
							| 
									
										
										
										
											2022-09-12 05:06:30 +02:00
										 |  |  | docker compose --env-file ~/openmetadata_oidc.env up -d | 
					
						
							| 
									
										
										
										
											2022-07-09 20:31:41 +02:00
										 |  |  | ``` |