From fc4f7a0cc82e2ce38bca10603cf7d8f3bf07444e Mon Sep 17 00:00:00 2001 From: Leandro Lafin Date: Fri, 12 Jul 2024 11:52:19 -0300 Subject: [PATCH] add contribution guide to documentation --- contrib/local-environment/dex.yaml | 4 ++-- .../docker-compose-keycloak.yaml | 17 ++++++++++------- contrib/local-environment/docker-compose.yaml | 16 +++++++++------- .../local-environment/oauth2-proxy-keycloak.cfg | 6 ++---- contrib/local-environment/oauth2-proxy.cfg | 15 ++++++++++----- 5 files changed, 33 insertions(+), 25 deletions(-) diff --git a/contrib/local-environment/dex.yaml b/contrib/local-environment/dex.yaml index ae687e05..fd64152b 100644 --- a/contrib/local-environment/dex.yaml +++ b/contrib/local-environment/dex.yaml @@ -1,7 +1,7 @@ # This configuration is intended to be used with the docker-compose testing # environment. # This should configure Dex to run on port 4190 and provides a static login -issuer: http://dex.localhost:4190/dex +issuer: http://dex.localtest.me:4190/dex storage: type: etcd config: @@ -19,7 +19,7 @@ staticClients: - id: oauth2-proxy redirectURIs: # These redirect URIs point to the `--redirect-url` for OAuth2 proxy. - - 'http://localhost:4180/oauth2/callback' # For basic proxy example. + - 'http://oauth2-proxy.localtest.me:4180/oauth2/callback' # For basic proxy example. - 'http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback' # For nginx and traefik example. name: 'OAuth2 Proxy' secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK diff --git a/contrib/local-environment/docker-compose-keycloak.yaml b/contrib/local-environment/docker-compose-keycloak.yaml index e9dfa17e..ae435ea3 100644 --- a/contrib/local-environment/docker-compose-keycloak.yaml +++ b/contrib/local-environment/docker-compose-keycloak.yaml @@ -12,7 +12,6 @@ # Access http://keycloak.localtest.me:9080 with the same credentials to check out the settings version: '3.0' services: - oauth2-proxy: container_name: oauth2-proxy image: quay.io/oauth2-proxy/oauth2-proxy:v7.5.1 @@ -21,6 +20,8 @@ services: volumes: - "./oauth2-proxy-keycloak.cfg:/oauth2-proxy.cfg" restart: unless-stopped + ports: + - 4180:4180/tcp networks: keycloak: {} httpbin: {} @@ -28,15 +29,17 @@ services: depends_on: - httpbin - keycloak - ports: - - 4180:4180/tcp httpbin: container_name: httpbin image: kennethreitz/httpbin:latest hostname: httpbin + ports: + - 8080:80/tcp networks: - httpbin: {} + httpbin: + aliases: + - httpbin.localtest.me keycloak: container_name: keycloak @@ -50,19 +53,19 @@ services: '-Dkeycloak.migration.action=import', '-Dkeycloak.migration.provider=dir', '-Dkeycloak.migration.dir=/realm-config', - '-Dkeycloak.migration.strategy=IGNORE_EXISTING', + '-Dkeycloak.migration.strategy=IGNORE_EXISTING' ] volumes: - ./keycloak:/realm-config environment: KEYCLOAK_USER: admin@example.com KEYCLOAK_PASSWORD: password + ports: + - 9080:9080/tcp networks: keycloak: aliases: - keycloak.localtest.me - ports: - - 9080:9080/tcp networks: httpbin: {} diff --git a/contrib/local-environment/docker-compose.yaml b/contrib/local-environment/docker-compose.yaml index c5ba9ecf..9a3412a8 100644 --- a/contrib/local-environment/docker-compose.yaml +++ b/contrib/local-environment/docker-compose.yaml @@ -8,19 +8,19 @@ # Or: # make (eg. make up, make down) # -# Access http://localhost:4180 to initiate a login cycle +# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle version: '3.0' services: oauth2-proxy: container_name: oauth2-proxy image: quay.io/oauth2-proxy/oauth2-proxy:v7.5.1 command: --config /oauth2-proxy.cfg - ports: - - 4180:4180/tcp hostname: oauth2-proxy volumes: - "./oauth2-proxy.cfg:/oauth2-proxy.cfg" restart: unless-stopped + ports: + - 4180:4180/tcp networks: dex: {} httpbin: {} @@ -31,16 +31,16 @@ services: container_name: dex image: ghcr.io/dexidp/dex:v2.30.3 command: dex serve /dex.yaml - ports: - - 4190:4190/tcp hostname: dex volumes: - "./dex.yaml:/dex.yaml" restart: unless-stopped + ports: + - 4190:4190/tcp networks: dex: aliases: - - dex.localhost + - dex.localtest.me etcd: {} depends_on: - etcd @@ -50,7 +50,9 @@ services: ports: - 8080:80/tcp networks: - httpbin: {} + httpbin: + aliases: + - httpbin.localtest.me etcd: container_name: etcd image: gcr.io/etcd-development/etcd:v3.4.7 diff --git a/contrib/local-environment/oauth2-proxy-keycloak.cfg b/contrib/local-environment/oauth2-proxy-keycloak.cfg index 6620b8ad..602cf312 100644 --- a/contrib/local-environment/oauth2-proxy-keycloak.cfg +++ b/contrib/local-environment/oauth2-proxy-keycloak.cfg @@ -1,8 +1,8 @@ http_address="0.0.0.0:4180" cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w=" -email_domains=["example.com"] +email_domains="example.com" cookie_secure="false" -upstreams="http://httpbin" +upstreams="http://httpbin.localtest.me:8080" cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains. whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target. @@ -16,5 +16,3 @@ redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback" oidc_issuer_url="http://keycloak.localtest.me:9080/auth/realms/master" provider="oidc" provider_display_name="Keycloak" - - diff --git a/contrib/local-environment/oauth2-proxy.cfg b/contrib/local-environment/oauth2-proxy.cfg index 7ee55d8f..ee58e145 100644 --- a/contrib/local-environment/oauth2-proxy.cfg +++ b/contrib/local-environment/oauth2-proxy.cfg @@ -1,11 +1,16 @@ http_address="0.0.0.0:4180" cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w=" -provider="oidc" email_domains="example.com" -oidc_issuer_url="http://dex.localhost:4190/dex" +cookie_secure="false" +upstreams="http://httpbin.localtest.me:8080" +cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains. +whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target. + +# dex provider client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK" client_id="oauth2-proxy" -cookie_secure="false" +redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback" -redirect_url="http://localhost:4180/oauth2/callback" -upstreams="http://httpbin" +oidc_issuer_url="http://dex.localtest.me:4190/dex" +provider="oidc" +provider_display_name="Dex"