jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #164 from moderneinc/adding-alternative-urls-to-documentataion

Browse Source 
Adding alternative url for github and gitlab
This commit is contained in:
Leanne Kerford
2025-01-02 14:16:19 -08:00
committed by GitHub
parent 509a19723d e953ae89ee
commit 6ba88aa95d
1 changed files with 26 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/administrator-documentation/moderne-platform/how-to-guides/agent-configuration/agent-variables.md
View File

@@ -246,6 +246,7 @@ You can configure multiple GitHub OAuth apps by including multiple entries, each
| `MODERNE_AGENT_GITHUB_{index}_OAUTH_CLIENTID` | `true` | | The client id configured in GitHub. |
| `MODERNE_AGENT_GITHUB_{index}_OAUTH_CLIENTSECRET` | `true` | | The client secret configured in GitHub. |
| `MODERNE_AGENT_GITHUB_{index}_URL` | `true` | | The fully-qualified hostname of the running GitHub instance. |
| `MODERNE_AGENT_GITHUB_{index}_ALTERNATEURLS_{index}` | `false` | | The list of alternative fully-qualified URL of the running GitHub instance. |
| `MODERNE_AGENT_GITHUB_{index}_SKIPSSL` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this GitHub instance. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
| `MODERNE_AGENT_GITHUB_{index}_ALLOWABLE_ORGANIZATIONS_{index}` | `false` | See description | Specifies what organizations you can fork recipe results to. By default, there are no restrictions on which organizations can be committed to. If you want multiple organizations, increase the last index and add one per line. |
| `MODERNE_AGENT_GITHUB_{index}_OAUTH_INCLUDEPRIVATEREPOS` | `false` | See description | By default, the OAuth app will only have access to public repositories within your organization(s). To provide the OAuth app access to private repositories, you can set this to `true`. |
@@ -279,6 +280,7 @@ docker run \
| `--moderne.agent.github[{index}].oauth.clientId` | `true` | | The client id configured in GitHub. |
| `--moderne.agent.github[{index}].oauth.clientSecret` | `true` | | The client secret configured in GitHub. |
| `--moderne.agent.github[{index}].url` | `true` | | The fully-qualified hostname of the running GitHub instance. |
| `--moderne.agent.github[{index}].alternateUrls[{index}]` | `false` | | The list of alternative fully-qualified URL of the running GitHub instance. |
| `--moderne.agent.github[{index}].skipSsl` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this GitHub instance. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
| `--moderne.agent.github[{index}].allowableOrganizations[{index}]` | `false` | See description | Specifies what organizations you can fork recipe results to. By default, there are no restrictions on which organizations can be committed to. If you want multiple organizations, increase the last index and add one per line. |
| `--moderne.agent.github[{index}].oauth.includePrivateRepos` | `false` | See description | By default, the OAuth app will only have access to public repositories within your organization(s). To provide the OAuth app access to private repositories, you can set this to `true`. |
@@ -313,17 +315,18 @@ You can configure multiple GitLab OAuth apps by including multiple entries, each
**Variables:**
| Variable Name | Required | Default | Description |
|---------------------------------------------------|----------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `MODERNE_AGENT_GITLAB_{index}_OAUTH_CLIENTID` | `true` | | The application id configured in GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_OAUTH_CLIENTSECRET` | `true` | | The secret configured in GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_URL` | `true` | | The fully-qualified hostname of your GitLab instance. |
| `MODERNE_AGENT_GITLAB_{index}_SKIPSSL` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this GitLab instance. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_PRIVATEKEY` | `false` | | The SSH private key used to establish a SSH connection with GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_PASSPHRASE` | `true` (If the SSH private key is specified) | | The passphrase used to encrypt the SSH private key. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_SSHFILENAME` | `true` (If the SSH private key is specified) | | The file name of the private key, which the agent will store locally. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_USER` | `true` (If the SSH private key is specified) | | The username used for SSH communication with GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_PORT` | `false` | `7999` | The port used to communicate via SSH with GitLab. |
| Variable Name | Required | Default | Description |
|------------------------------------------------------|----------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `MODERNE_AGENT_GITLAB_{index}_OAUTH_CLIENTID` | `true` | | The application id configured in GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_OAUTH_CLIENTSECRET` | `true` | | The secret configured in GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_URL` | `true` | | The fully-qualified hostname of your GitLab instance. |
| `MODERNE_AGENT_GITLAB_{index}_ALTERNATEURLS_{index}` | `false` | | The list of alternative fully-qualified URL of the running GitLab instance. |
| `MODERNE_AGENT_GITLAB_{index}_SKIPSSL` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this GitLab instance. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_PRIVATEKEY` | `false` | | The SSH private key used to establish a SSH connection with GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_PASSPHRASE` | `true` (If the SSH private key is specified) | | The passphrase used to encrypt the SSH private key. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_SSHFILENAME` | `true` (If the SSH private key is specified) | | The file name of the private key, which the agent will store locally. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_USER` | `true` (If the SSH private key is specified) | | The username used for SSH communication with GitLab. |
| `MODERNE_AGENT_GITLAB_{index}_SSH_PORT` | `false` | `7999` | The port used to communicate via SSH with GitLab. |
**Example:**
@@ -341,17 +344,18 @@ docker run \
**Arguments:**
| Argument Name | Required | Default | Description |
|------------------------------------------------------|----------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--moderne.agent.gitlab[{index}].oauth.clientId` | `true` | | The application id configured in GitLab. |
| `--moderne.agent.gitlab[{index}].oauth.clientSecret` | `true` | | The secret configured in GitLab. |
| `--moderne.agent.gitlab[{index}].url` | `true` | | The fully-qualified hostname of your GitLab instance. |
| `--moderne.agent.gitlab[{index}].skipSsl` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this GitLab instance. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
| `--moderne.agent.gitlab[{index}].ssh.privateKey` | `false` | | The SSH private key used to establish a SSH connection with GitLab. |
| `--moderne.agent.gitlab[{index}].ssh.passphrase` | `true` (If the SSH private key is specified) | | The passphrase used to encrypt the SSH private key. |
| `--moderne.agent.gitlab[{index}].ssh.sshFileName` | `true` (If the SSH private key is specified) | | The file name of the private key, which the agent will store locally. |
| `--moderne.agent.gitlab[{index}].ssh.user` | `true` (If the SSH private key is specified) | | The username used for SSH communication with GitLab. |
| `--moderne.agent.gitlab[{index}].ssh.port` | `false` | `7999` | The port used to communicate via SSH with GitLab. |
| Argument Name | Required | Default | Description |
|------------------------------------------------------------|----------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--moderne.agent.gitlab[{index}].oauth.clientId` | `true` | | The application id configured in GitLab. |
| `--moderne.agent.gitlab[{index}].oauth.clientSecret` | `true` | | The secret configured in GitLab. |
| `--moderne.agent.gitlab[{index}].url` | `true` | | The fully-qualified hostname of your GitLab instance. |
| `--moderne.agent.gitlab[{index}].alternateUrls[{index}]` | `false` | | The list of alternative fully-qualified URL of the running GitLab instance. |
| `--moderne.agent.gitlab[{index}].skipSsl` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this GitLab instance. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
| `--moderne.agent.gitlab[{index}].ssh.privateKey` | `false` | | The SSH private key used to establish a SSH connection with GitLab. |
| `--moderne.agent.gitlab[{index}].ssh.passphrase` | `true` (If the SSH private key is specified) | | The passphrase used to encrypt the SSH private key. |
| `--moderne.agent.gitlab[{index}].ssh.sshFileName` | `true` (If the SSH private key is specified) | | The file name of the private key, which the agent will store locally. |
| `--moderne.agent.gitlab[{index}].ssh.user` | `true` (If the SSH private key is specified) | | The username used for SSH communication with GitLab. |
| `--moderne.agent.gitlab[{index}].ssh.port` | `false` | `7999` | The port used to communicate via SSH with GitLab. |
**Example:**