From b6968005e1e1758e37edc7830c02e2217ee5fd90 Mon Sep 17 00:00:00 2001 From: mo khan Date: Thu, 15 May 2025 14:37:51 -0600 Subject: docs: add info on how to create an OAuth Application --- README.md | 3 +++ share/man/DEVELOPMENT.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 45d0eff..c449b91 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,11 @@ The Authorization team is researching ways to evolve GitLab's authorization stac ```bash $ vim .env.local ``` + Follow these instructions to [create a user-owned application](https://docs.gitlab.com/integration/oauth_provider/#create-a-user-owned-application) and set the `OAUTH_CLIENT_ID` and `OAUTH_CLIENT_SECRET`. 6. Start the service ```bash $ make run ``` 7. Open a browser and navigate to: http://localhost:10000 + +See the [DEVELOPMENT](./share/man/development.md) guide for additional instructions. diff --git a/share/man/DEVELOPMENT.md b/share/man/DEVELOPMENT.md index c3077a8..cc5fe5e 100644 --- a/share/man/DEVELOPMENT.md +++ b/share/man/DEVELOPMENT.md @@ -60,6 +60,9 @@ The following environment variables must be defined: | `OAUTH_CLIENT_SECRET` | The corresponding client secret | | `OIDC_ISSUER` | The issuer URL (e.g., `http://gdk.test:3000`) | +Follow these instructions to [create a user-owned application](https://docs.gitlab.com/integration/oauth_provider/#create-a-user-owned-application) +and set the `OAUTH_CLIENT_ID` and `OAUTH_CLIENT_SECRET`. + You can refer to the `Dockerfile` in the root of this repository to determine the exact version of Envoy required. To install Envoy locally, follow the [official installation guide](https://www.envoyproxy.io/docs/envoy/latest/start/install). -- cgit v1.2.3