diff --git a/cli/tests/compose.users.test.yml b/cli/tests/compose.users.test.yml index 6c4ee4fea..790edca61 100644 --- a/cli/tests/compose.users.test.yml +++ b/cli/tests/compose.users.test.yml @@ -1,4 +1,3 @@ -version: '3' services: astitvasehgal05: image: mltooling/ml-workspace-minimal:0.13.2 diff --git a/client/compose.client.yml b/client/compose.client.yml index 5185eec4e..365d699b1 100644 --- a/client/compose.client.yml +++ b/client/compose.client.yml @@ -1,4 +1,3 @@ -version: '3' services: client: image: intocps/dtaas-web:latest diff --git a/deploy/config/lib.docker b/deploy/config/lib.env similarity index 100% rename from deploy/config/lib.docker rename to deploy/config/lib.env diff --git a/deploy/docker/.env.local b/deploy/docker/.env.local index 3e8055b64..b157e5337 100644 --- a/deploy/docker/.env.local +++ b/deploy/docker/.env.local @@ -1,3 +1,2 @@ DTAAS_DIR='/Users//DTaaS' -CLIENT_CONFIG='/Users//DTaaS/deploy/config/client/env.local.js' username1='user1' \ No newline at end of file diff --git a/deploy/docker/.env.server b/deploy/docker/.env.server index ad7fbef87..12196b4fb 100644 --- a/deploy/docker/.env.server +++ b/deploy/docker/.env.server @@ -1,9 +1,8 @@ DTAAS_DIR='/Users//DTaaS' SERVER_DNS='foo.com' OAUTH_URL='https://gitlab.foo.com' -CLIENT_ID='xx' -CLIENT_SECRET='xx' +OAUTH_CLIENT_ID='xx' +OAUTH_CLIENT_SECRET='xx' OAUTH_SECRET='random-secret-string' -CLIENT_CONFIG='/Users//DTaaS/deploy/config/client/env.js' username1='user1' username2='user2' \ No newline at end of file diff --git a/deploy/docker/DOCKER-ENV.md b/deploy/docker/DOCKER-ENV.md index f78691401..2249db724 100644 --- a/deploy/docker/DOCKER-ENV.md +++ b/deploy/docker/DOCKER-ENV.md @@ -9,17 +9,17 @@ Edit all the fields according to your specific case. | DTAAS_DIR | '/Users/username/DTaaS' | Full path to the DTaaS directory. This is an absolute path with no trailing slash. | | SERVER_DNS | _foo.com_ | The server DNS, if you are deploying with a dedicated server. Remember not use http(s) at the beginning of the DNS string | | OAUTH_URL | _gitlab.foo.com_ | The URL of your Gitlab instance. It can be _gitlab.com_ if you are planning to use it for authorization. | - | CLIENT_ID | 'xx' | The ID of your server OAuth application | - | CLIENT_SECRET | 'xx' | The Secret of your server OAuth application | + | OAUTH_CLIENT_ID | 'xx' | The ID of your server OAuth application | + | OAUTH_CLIENT_SECRET | 'xx' | The Secret of your server OAuth application | | OAUTH_SECRET | 'random-secret-string' | Any private random string. This is a password you choose for local installation. | | username1 | 'user1' | The gitlab instance username of a user of DTaaS | | username2 | 'user2' | The gitlab instance username of a user of DTaaS | - | CLIENT_CONFIG | '/Users/username/DTaaS/deploy/config/client/env.js' | Full path to env.js file for client | :clipboard: Important points to note: 1. The path examples given here are for Linux OS. These paths can be Windows OS compatible paths as well. 1. The Server DNS can also be an IP address. - However, for proper working it is neccessary to use the - same convention (IP/DNS) in the `CLIENT_CONFIG` file as well. \ No newline at end of file + However, for proper working it is neccessary to use the same + convention (IP/DNS) in the client configuration file + (`deploy/config/client/env.js`) as well. diff --git a/deploy/docker/LOCALHOST.SECURE.md b/deploy/docker/LOCALHOST.SECURE.md index d98b18b4a..af23b638b 100644 --- a/deploy/docker/LOCALHOST.SECURE.md +++ b/deploy/docker/LOCALHOST.SECURE.md @@ -94,10 +94,15 @@ Edit all the fields according to your specific case. |:------------|:---------------|:---------------| | DTAAS_DIR | '/home/Desktop/DTaaS' | Full path to the DTaaS directory. This is an absolute path with no trailing slash. | | username1 | 'user1' | Your gitlab username | - | CLIENT_CONFIG | '/home/Desktop/DTaaS/deploy/config/client/env.local.js' | Full path to env.js file for client | -:clipboard: The path examples given here are for Linux OS. -These paths can be Windows OS compatible paths as well. +:clipboard: Important points to note: + +1. The path examples given here are for Linux OS. + These paths can be Windows OS compatible paths as well. +1. The client configuration file is located at + `deploy/config/client/env.local.js`. + Edit the URLs in this file by replacing `http` with `https`. + Beyond this, it is not necessary to modify this file. ### Start DTaaS to Integrate Gitlab @@ -184,14 +189,14 @@ included in the localhost installation scenario. The commands to start and stop the appliation are: ```bash -docker compose -f compose.local.secure.yml --env-file .env.server up -d -docker compose -f compose.local.secure.yml --env-file .env.server down +docker compose -f compose.local.secure.yml --env-file .env.local up -d +docker compose -f compose.local.secure.yml --env-file .env.local down ``` To restart only a specific container, for example `client` ```bash -docker compose -f compose.server.secure.yml --env-file .env.server up -d --force-recreate client +docker compose -f compose.local.secure.yml --env-file .env.local up -d --force-recreate client ``` ## References diff --git a/deploy/docker/LOCALHOST.md b/deploy/docker/LOCALHOST.md index 2f4fca88a..87758664f 100644 --- a/deploy/docker/LOCALHOST.md +++ b/deploy/docker/LOCALHOST.md @@ -58,10 +58,13 @@ Edit all the fields according to your specific case. |:------------|:---------------|:---------------| | DTAAS_DIR | '/home/Desktop/DTaaS' | Full path to the DTaaS directory. This is an absolute path with no trailing slash. | | username1 | 'user1' | Your gitlab username | - | CLIENT_CONFIG | '/home/Desktop/DTaaS/deploy/config/client/env.local.js' | Full path to env.js file for client | -:clipboard: The path examples given here are for Linux OS. -These paths can be Windows OS compatible paths as well. +:clipboard: Important points to note: + +1. The path examples given here are for Linux OS. + These paths can be Windows OS compatible paths as well. +1. The client configuration file is located at `deploy/config/client/env.local.js`. + It is not necessary to modify this file. ### Create User Workspace diff --git a/deploy/docker/SERVER.md b/deploy/docker/SERVER.md index 4ccc9e4e3..f2adeeb7f 100644 --- a/deploy/docker/SERVER.md +++ b/deploy/docker/SERVER.md @@ -96,11 +96,7 @@ Description of file configuration can be found here. [.env file description](./D ### Website Client The frontend React website requires configuration which is specified -via a filename provided in `CLIENT_CONFIG` variable of -`deploy/docker/.env.server` file. - -The `CLIENT_CONFIG` file is in relative directory of -`deploy/config/client/env.js`. +in the client configuration file (`deploy/config/client/env.js`). Further explanation on the client configuration is available in [client config](../../docs/admin/client/config.md). @@ -188,7 +184,6 @@ please change, image: intocps/libms:latest restart: unless-stopped volumes: - - ${DTAAS_DIR}/deploy/config/lib.docker:/dtaas/libms/.env - ${DTAAS_DIR}/files/common:/dtaas/libms/files ``` @@ -300,7 +295,10 @@ To add a new user to your DTaaS instance, follow these steps: Run the appropritate command for a server/local installation: ```bash +# if the server is installed with http option, execute docker compose -f compose.server.yml --env-file .env.server up -d --force-recreate traefik-forward-auth +# if the server is installed with https option, execute +docker compose -f compose.server.secure.yml --env-file .env.server up -d --force-recreate traefik-forward-auth ``` The new users are now added to the DTaaS instance, with authorization enabled. diff --git a/deploy/docker/compose.local.secure.yml b/deploy/docker/compose.local.secure.yml index 9ed29cecd..b1130647f 100644 --- a/deploy/docker/compose.local.secure.yml +++ b/deploy/docker/compose.local.secure.yml @@ -28,7 +28,7 @@ services: image: intocps/dtaas-web:latest restart: unless-stopped volumes: - - "${CLIENT_CONFIG}:/dtaas/client/build/env.js" + - "${DTAAS_DIR}/deploy/config/client/env.local.js:/dtaas/client/build/env.js" labels: - "traefik.enable=true" - "traefik.http.routers.client.rule=PathPrefix(`/`)" diff --git a/deploy/docker/compose.local.yml b/deploy/docker/compose.local.yml index 891cafa15..ea9071024 100644 --- a/deploy/docker/compose.local.yml +++ b/deploy/docker/compose.local.yml @@ -3,6 +3,7 @@ services: image: traefik:v2.10 restart: unless-stopped command: + - "--log.level=DEBUG" - "--api.insecure=true" - "--providers.docker=true" - "--entryPoints.web.address=:80" @@ -20,7 +21,7 @@ services: image: intocps/dtaas-web:latest restart: unless-stopped volumes: - - ${CLIENT_CONFIG}:/dtaas/client/build/env.js + - ${DTAAS_DIR}/deploy/config/client/env.local.js:/dtaas/client/build/env.js labels: - "traefik.enable=true" - "traefik.http.routers.client.entryPoints=web" diff --git a/deploy/docker/compose.server.secure.yml b/deploy/docker/compose.server.secure.yml index 0a6f72f56..042897901 100644 --- a/deploy/docker/compose.server.secure.yml +++ b/deploy/docker/compose.server.secure.yml @@ -28,7 +28,7 @@ services: image: intocps/dtaas-web:latest restart: unless-stopped volumes: - - "${CLIENT_CONFIG}:/dtaas/client/build/env.js" + - "${DTAAS_DIR}/deploy/config/client/env.js:/dtaas/client/build/env.js" labels: - "traefik.enable=true" - "traefik.http.routers.client.rule=Host(`${SERVER_DNS}`)&&PathPrefix(`/`)" @@ -42,7 +42,6 @@ services: image: intocps/libms:latest restart: unless-stopped volumes: - - ${DTAAS_DIR}/deploy/config/lib.docker:/dtaas/libms/.env - ${DTAAS_DIR}/files:/dtaas/libms/files labels: - "traefik.enable=true" @@ -102,8 +101,8 @@ services: - PROVIDERS_GENERIC_OAUTH_AUTH_URL=${OAUTH_URL}/oauth/authorize - PROVIDERS_GENERIC_OAUTH_TOKEN_URL=${OAUTH_URL}/oauth/token - PROVIDERS_GENERIC_OAUTH_USER_URL=${OAUTH_URL}/api/v4/user - - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=${CLIENT_ID} - - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=${CLIENT_SECRET} + - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=${OAUTH_CLIENT_ID} + - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=${OAUTH_CLIENT_SECRET} - PROVIDERS_GENERIC_OAUTH_SCOPE=read_user - SECRET= "${OAUTH_SECRET}" - CONFIG=/conf diff --git a/deploy/docker/compose.server.yml b/deploy/docker/compose.server.yml index 208812f1d..b3f62b6cc 100644 --- a/deploy/docker/compose.server.yml +++ b/deploy/docker/compose.server.yml @@ -2,7 +2,8 @@ services: traefik: image: traefik:v2.10 restart: unless-stopped - command: + command: + - "--log.level=DEBUG" - "--api.insecure=true" - "--providers.docker=true" - "--entryPoints.web.address=:80" @@ -20,7 +21,6 @@ services: image: intocps/libms:latest restart: unless-stopped volumes: - - ${DTAAS_DIR}/deploy/config/lib.docker:/dtaas/libms/.env - ${DTAAS_DIR}/files:/dtaas/libms/files labels: - "traefik.enable=true" @@ -35,7 +35,7 @@ services: image: intocps/dtaas-web:latest restart: unless-stopped volumes: - - ${CLIENT_CONFIG}:/dtaas/client/build/env.js + - ${DTAAS_DIR}/deploy/config/client/env.js:/dtaas/client/build/env.js labels: - "traefik.enable=true" - "traefik.http.routers.client.entryPoints=web" @@ -87,12 +87,13 @@ services: volumes: - ${DTAAS_DIR}/deploy/docker/conf.server:/conf environment: + - LOG_LEVEL=trace - DEFAULT_PROVIDER=generic-oauth - PROVIDERS_GENERIC_OAUTH_AUTH_URL=${OAUTH_URL}/oauth/authorize - PROVIDERS_GENERIC_OAUTH_TOKEN_URL=${OAUTH_URL}/oauth/token - PROVIDERS_GENERIC_OAUTH_USER_URL=${OAUTH_URL}/api/v4/user - - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=${CLIENT_ID} - - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=${CLIENT_SECRET} + - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=${OAUTH_CLIENT_ID} + - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=${OAUTH_CLIENT_SECRET} - PROVIDERS_GENERIC_OAUTH_SCOPE=read_user - SECRET= ${OAUTH_SECRET} # INSECURE_COOKIE is required if not using a https entrypoint diff --git a/deploy/services/gitlab/INTEGRATION.md b/deploy/services/gitlab/INTEGRATION.md index 086e36880..5b7440147 100644 --- a/deploy/services/gitlab/INTEGRATION.md +++ b/deploy/services/gitlab/INTEGRATION.md @@ -80,7 +80,7 @@ the **client website** service. ```sh cd deploy/docker -docker compose -f compose.server.yml --env-file .env.server up -d --force-recreate client +docker compose -f compose.local.yml --env-file .env.local up -d --force-recreate client ``` ### Production Server Installation @@ -88,12 +88,25 @@ docker compose -f compose.server.yml --env-file .env.server up -d --force-recrea The updated OAuth application configuration needs to be loaded into the **client website** and the **forward-auth** services. +The production server can be installed with either **http** +or **https** option. +If it is installed with **http** option, run the following commands. + ```sh cd deploy/docker docker compose -f compose.server.yml --env-file .env.server up -d --force-recreate client docker compose -f compose.server.yml --env-file .env.server up -d --force-recreate traefik-forward-auth ``` +If the production server is installed with **https** option, +run the following commands. + +```sh +cd deploy/docker +docker compose -f compose.server.secure.yml --env-file .env.server up -d --force-recreate client +docker compose -f compose.server.secure.yml --env-file .env.server up -d --force-recreate traefik-forward-auth +``` + ## Post Setup Usage If you have set up everything correctly: diff --git a/deploy/services/gitlab/README.md b/deploy/services/gitlab/README.md index 7698aba16..c8ede730f 100644 --- a/deploy/services/gitlab/README.md +++ b/deploy/services/gitlab/README.md @@ -21,7 +21,7 @@ config file (`.env.server`). If the DTaaS application and gitlab are to be hosted at , then the client config file (`deploy/config/client/env.local.js`) -eeds to use the as `REACT_APP_AUTH_AUTHORITY`. +needs to use the as `REACT_APP_AUTH_AUTHORITY`. If the application and the integrated gitlab are to be hosted at `https://localhost/gitlab`, then `.env.server` need not be modified. @@ -104,6 +104,13 @@ After running the container, your local GitLab instance will be available at `external_url` specified in _gitlab.rb_, i.e., either at or at . +### Create Users + +The newly installed gitlab only contains `root` user. More users need +to be created for use with DTaaS. Please see the +[Gitlab docs](https://docs.gitlab.com/ee/user/profile/account/create_accounts.html) +for further help. + ## Pending Tasks This README helps with installation of Gitlab along side DTaaS application. diff --git a/docker/.env b/docker/.env index ca3ab278b..cc4751d72 100644 --- a/docker/.env +++ b/docker/.env @@ -1,9 +1,10 @@ DTAAS_DIR='/Users//DTaaS' SERVER_DNS='localhost' OAUTH_URL='https://gitlab.com' -CLIENT_ID='xx' -CLIENT_SECRET='xx' +OAUTH_CLIENT_ID='xx' +OAUTH_CLIENT_SECRET='xx' OAUTH_SECRET='random-secret-string' OAUTH_CONF_FILEPATH='/Users//DTaaS/docker/conf.dev' username1='user1' username2='user2' +LIB_CONFIG='/Users//DTaaS/servers/lib/config/.env.default' \ No newline at end of file diff --git a/docker/compose.dev.yml b/docker/compose.dev.yml index 7cae66d00..7f12c87f2 100644 --- a/docker/compose.dev.yml +++ b/docker/compose.dev.yml @@ -1,4 +1,3 @@ -version: '3' services: traefik: image: traefik:v2.10 @@ -9,6 +8,7 @@ services: - "--entryPoints.web.address=:80" - "--entrypoints.web.forwardedHeaders.insecure=true" - "--entrypoints.web.proxyProtocol.insecure=true" + - "--log.level=DEBUG" ports: - "80:80" volumes: @@ -40,6 +40,7 @@ services: restart: unless-stopped volumes: - ${DTAAS_DIR}/files:/dtaas/libms/files + - ${LIB_CONFIG}:/dtaas/libms/config/.env.default labels: - "traefik.enable=true" - "traefik.http.routers.libms.entryPoints=web" @@ -95,13 +96,14 @@ services: - PROVIDERS_GENERIC_OAUTH_AUTH_URL=${OAUTH_URL}/oauth/authorize - PROVIDERS_GENERIC_OAUTH_TOKEN_URL=${OAUTH_URL}/oauth/token - PROVIDERS_GENERIC_OAUTH_USER_URL=${OAUTH_URL}/api/v4/user - - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=${CLIENT_ID} - - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=${CLIENT_SECRET} + - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=${OAUTH_CLIENT_ID} + - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=${OAUTH_CLIENT_SECRET} - PROVIDERS_GENERIC_OAUTH_SCOPE=read_user - SECRET= ${OAUTH_SECRET} # INSECURE_COOKIE is required if not using a https entrypoint - INSECURE_COOKIE=true - CONFIG=/conf + - LOG_LEVEL=debug labels: - "traefik.enable=true" diff --git a/docker/libms.npm.dockerfile b/docker/libms.npm.dockerfile index 6c6c1727d..2290968b5 100644 --- a/docker/libms.npm.dockerfile +++ b/docker/libms.npm.dockerfile @@ -9,7 +9,7 @@ WORKDIR /dtaas/libms ARG VERSION="latest" RUN npm i -g @into-cps-association/libms@${VERSION} -COPY ./deploy/config/lib.docker .env +COPY ./deploy/config/lib.env .env COPY ./servers/lib/config/http.json . # Define the command to run your app diff --git a/docs/admin/host.md b/docs/admin/host.md index 2169c6822..0997dfc3d 100644 --- a/docs/admin/host.md +++ b/docs/admin/host.md @@ -113,12 +113,11 @@ Edit all the fields according to your specific case. | DTAAS_DIR | '/Users/username/DTaaS' | Full path to the DTaaS directory. This is an absolute path with no trailing slash. | | SERVER_DNS | _foo.com_ | The server DNS, if you are deploying with a dedicated server. Remember not use http(s) at the beginning of the DNS string | | OAUTH_URL | _gitlab.foo.com_ | The URL of your Gitlab instance. It can be _gitlab.com_ if you are planning to use it for authorization. | - | CLIENT_ID | 'xx' | The ID of your server OAuth application | - | CLIENT_SECRET | 'xx' | The Secret of your server OAuth application | + | OAUTH_CLIENT_ID | 'xx' | The ID of your server OAuth application | + | OAUTH_CLIENT_SECRET | 'xx' | The Secret of your server OAuth application | | OAUTH_SECRET | 'random-secret-string' | Any private random string. This is a password you choose for local installation. | | username1 | 'user1' | The gitlab instance username of a user of DTaaS | | username2 | 'user2' | The gitlab instance username of a user of DTaaS | - | CLIENT_CONFIG | '/Users/username/DTaaS/deploy/config/client/env.js' | Full path to env.js file for client | @@ -127,19 +126,16 @@ Edit all the fields according to your specific case. 1. The path examples given here are for Linux OS. These paths can be Windows OS compatible paths as well. + 1. The client configuration file is located at `deploy/config/client/env.js`. 1. The Server DNS can also be an IP address. However, for proper working it is neccessary to use the - same convention (IP/DNS) in the `CLIENT_CONFIG` file as well. + same convention (IP/DNS) in the client configuration file as well. ### Website Client The frontend React website requires configuration which is specified -via a filename provided in `CLIENT_CONFIG` variable of -`deploy/docker/.env.server` file. - -The `CLIENT_CONFIG` file is in relative directory of -`deploy/config/client/env.js`. +in the client configuration file (`deploy/config/client/env.js`). Further explanation on the client configuration is available in [client config](client/config.md). @@ -234,7 +230,7 @@ please change, image: intocps/libms:latest restart: unless-stopped volumes: - - ${DTAAS_DIR}/deploy/config/lib.docker:/dtaas/libms/.env + - ${DTAAS_DIR}/deploy/config/lib.env:/dtaas/libms/.env - ${DTAAS_DIR}/files/common:/dtaas/libms/files ``` diff --git a/docs/admin/localhost.md b/docs/admin/localhost.md index 897cee7cf..cdf0f9073 100644 --- a/docs/admin/localhost.md +++ b/docs/admin/localhost.md @@ -64,13 +64,17 @@ Edit all the fields according to your specific case. |:------------|:---------------|:---------------| | DTAAS_DIR | '/home/Desktop/DTaaS' | Full path to the DTaaS directory. This is an absolute path with no trailing slash. | | username1 | 'user1' | Your gitlab username | - | CLIENT_CONFIG | '/home/Desktop/DTaaS/deploy/config/client/env.local.js' | Full path to env.js file for client | !!! tip - The path examples given here are for Linux OS. - These paths can be Windows OS compatible paths as well. + Important points to note: + + 1. The path examples given here are for Linux OS. + These paths can be Windows OS compatible paths as well. + 1. The client configuration file is located at `deploy/config/client/env.local.js`. + If you are following the guide to use HTTPS on localhost, edit the URLs in this file by replacing `http` with `https`. + Beyond this, it is not necessary to modify this file. ### Create User Workspace diff --git a/docs/admin/servers/auth.md b/docs/admin/servers/auth.md index f5869f2d6..92ec88532 100644 --- a/docs/admin/servers/auth.md +++ b/docs/admin/servers/auth.md @@ -79,8 +79,8 @@ the OAuth application registered on GitLab: | GitLab Variable Name | Variable Name in .env of docker compose file | Default Value | |:---|:---|:---| |OAuth Provider|OAUTH_URL|[https://gitlab.foo.com/](https://gitlab.foo.com/)| -|Application ID|CLIENT_ID| _xx_ | -|Application Secret|CLIENT_SECRET| _xx_ | +|Application ID|OAUTH_CLIENT_ID| _xx_ | +|Application Secret|OAUTH_CLIENT_SECRET| _xx_ | |Callback URL|(to be directly entered in Gitlab OAuth registration)|| |Forward-auth secret|OAUTH_SECRET|_random-secret-string_ (password for forward-auth, can be changed to your preferred string) | |Scopes| read_user || diff --git a/docs/admin/servers/lib/compose.lib.yml b/docs/admin/servers/lib/compose.lib.yml index 69b32e960..a4e080791 100644 --- a/docs/admin/servers/lib/compose.lib.yml +++ b/docs/admin/servers/lib/compose.lib.yml @@ -1,4 +1,3 @@ -version: '3' services: libms: image: intocps/libms:latest diff --git a/docs/developer/client/GITLAB-RUNNER.md b/docs/developer/client/GITLAB-RUNNER.md index fc760ad2e..d538bc430 100644 --- a/docs/developer/client/GITLAB-RUNNER.md +++ b/docs/developer/client/GITLAB-RUNNER.md @@ -26,7 +26,8 @@ Follow the steps below: A detailed guide on installation of [gitlab runners](https://docs.gitlab.com/runner/install/) on Linux OS is available on -[gitlab website](https://docs.gitlab.com/runner/install/linux-repository.html) +[gitlab website](https://docs.gitlab.com/runner/install/linux-repository.html). +Remember to use `linux` as tag for the runner. ### Register Runner diff --git a/docs/developer/oauth/AUTHMS.drawio b/docs/developer/oauth/AUTHMS.drawio index 63b42da4b..b60498d0d 100644 --- a/docs/developer/oauth/AUTHMS.drawio +++ b/docs/developer/oauth/AUTHMS.drawio @@ -1,92 +1,79 @@ - - - + + + - + - + - + - + - + - - + + - - - - + - + - + - + - + - + - - - - - - - - - - - + - + - + - + - + @@ -97,29 +84,19 @@ - - - - - - - - - - - + - + - + @@ -129,70 +106,64 @@ - + - + - - + + - - + + - - + + - - + + - - + + - - + + - + - - + + - - + + - - + + - - + + - - + + - + - - - - - - - + - + - + - + - + @@ -201,22 +172,22 @@ - + - + - + - + - + - + @@ -225,7 +196,7 @@ - + @@ -235,102 +206,131 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/developer/oauth/AUTHMS.md b/docs/developer/oauth/AUTHMS.md index 57d4fa86c..346407081 100644 --- a/docs/developer/oauth/AUTHMS.md +++ b/docs/developer/oauth/AUTHMS.md @@ -41,7 +41,7 @@ actual request (a user redirect) looks like: https ://gitlab.foo.com/oauth/ authorize? response_type=code& -client_id=CLIENT_ID& +client_id=OAUTH_CLIENT_ID& redirect_uri=REDIRECT_URI& scope=read_user&state = STATE ``` @@ -97,8 +97,8 @@ REDIRECT_URI?code=AUTHCODE&state=STATE ```json POST https://gitlab.foo.com/oauth/token, -parameters = 'client_id=CLIENT_ID& -client_secret=CLIENT_SECRET& +parameters = 'client_id=OAUTH_CLIENT_ID& +client_secret=OAUTH_CLIENT_SECRET& code=AUTHCODE& grant_type=authorization_code& redirect_uri=REDIRECT_URI' @@ -346,8 +346,8 @@ environment: - PROVIDERS_GENERIC_OAUTH_AUTH_URL=https://gitlab.foo.com/oauth/authorize - PROVIDERS_GENERIC_OAUTH_TOKEN_URL=https://gitlab.foo.com/oauth/token - PROVIDERS_GENERIC_OAUTH_USER_URL=https://gitlab.foo.com/api/v4/user - - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=CLIENT_ID - - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=CLIENT_SECRET + - PROVIDERS_GENERIC_OAUTH_CLIENT_ID=OAUTH_CLIENT_ID + - PROVIDERS_GENERIC_OAUTH_CLIENT_SECRET=OAUTH_CLIENT_SECRET - PROVIDERS_GENERIC_OAUTH_SCOPE = read_user - SECRET = a - random - string # INSECURE_COOKIE is required if