8000 move external auth to own directory · coder/coder@d3ac4ea · GitHub
[go: up one dir, main page]
Skip to content

Commit d3ac4ea

Browse files
EdwardAngertEdwardAngert
committed
move external auth to own directory
1 parent 2f07f99 commit d3ac4ea

File tree

10 files changed

+15
-15
lines changed
  • vault.md
  • setup
  • templates
  • ai-coder
  • manifest.json
  • tutorials

    • 10 files changed

    +15
    -15
    lines changed

    ‎docs/admin/external-auth.md renamed to ‎docs/admin/external-auth/index.md

    File renamed without changes.

    ‎docs/admin/infrastructure/architecture.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -108,10 +108,10 @@ Users will likely need to pull source code and other artifacts from a git
    108108
    provider. The Coder control plane and workspaces will need network connectivity
    109109
    to the git provider.
    110110

    111-
    - [GitHub Enterprise](../external-auth.md#github-enterprise)
    112-
    - [GitLab](../external-auth.md#gitlab-self-managed)
    113-
    - [BitBucket](../external-auth.md#bitbucket-server)
    114-
    - [Other Providers](../external-auth.md#self-managed-git-providers)
    111+
    - [GitHub Enterprise](../external-auth/index.md#github-enterprise)
    112+
    - [GitLab](../external-auth/index.md#gitlab-self-managed)
    113+
    - [BitBucket](../external-auth/index.md#bitbucket-server)
    114+
    - [Other Providers](../external-auth/index.md#self-managed-git-providers)
    115115

    116116
    ### Artifact Manager (Optional)
    117117

    ‎docs/admin/integrations/jfrog-artifactory.md

    Lines changed: 2 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -26,7 +26,7 @@ two type of modules that automate the JFrog Artifactory and Coder integration.
    2626
    ### JFrog-OAuth
    2727

    2828
    This module is usable by JFrog self-hosted (on-premises) Artifactory as it
    29-
    requires configuring a custom integration. This integration benefits from Coder's [external-auth](../../admin/external-auth.md) feature allows each user to authenticate with Artifactory using an OAuth flow and issues user-scoped tokens to each user.
    29+
    requires configuring a custom integration. This integration benefits from Coder's [external-auth](../external-auth/index.md) feature allows each user to authenticate with Artifactory using an OAuth flow and issues user-scoped tokens to each user.
    3030

    3131
    To set this up, follow these steps:
    3232

    @@ -53,7 +53,7 @@ To set this up, follow these steps:
    5353
    `https://JFROG_URL/ui/admin/configuration/integrations/app-integrations/new` and select the
    5454
    Application Type as the integration you created in step 1 or `Custom Integration` if you are using SaaS instance i.e. example.jfrog.io.
    5555

    56-
    1. Add a new [external authentication](../../admin/external-auth.md) to Coder by setting these
    56+
    1. Add a new [external authentication](../external-auth/index.md) to Coder by setting these
    5757
    environment variables in a manner consistent with your Coder deployment. Replace `JFROG_URL` with your JFrog Artifactory base URL:
    5858

    5959
    ```env

    ‎docs/admin/integrations/vault.md

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -19,7 +19,7 @@ will show you how to use these modules to integrate HashiCorp Vault with Coder.
    1919

    2020
    The [`vault-github`](https://registry.coder.com/modules/vault-github) module is a Terraform module that allows you to
    2121
    authenticate with Vault using a GitHub token. This module uses the existing
    22-
    GitHub [external authentication](../external-auth.md) to get the token and authenticate with Vault.
    22+
    GitHub [external authentication](../external-auth/index.md) to get the token and authenticate with Vault.
    2323

    2424
    To use this module, add the following code to your Terraform configuration.
    2525

    ‎docs/admin/setup/index.md

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -148,7 +148,7 @@ integrations with Git providers, such as GitHub, GitLab, and Bitbucket.
    148148
    External authentication can also be used to integrate with external services
    149149
    like JFrog Artifactory and others.
    150150

    151-
    Please refer to the [external authentication](../external-auth.md) section for
    151+
    Please refer to the [external authentication](../external-auth/index.md) section for
    152152
    more information.
    153153

    154154
    ## Up Next

    ‎docs/admin/templates/open-in-coder.md

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -15,7 +15,7 @@ approach for "Open in Coder" flows.
    1515

    1616
    ### 1. Set up git authentication
    1717

    18-
    See [External Authentication](../external-auth.md) to set up git authentication
    18+
    See [External Authentication](../external-auth/index.md) to set up Git authentication
    1919
    in your Coder deployment.
    2020

    2121
    ### 2. Modify your template to auto-clone repos

    ‎docs/ai-coder/best-practices.md

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -33,7 +33,7 @@ for development. With AI Agents, this is no exception.
    3333
    development without manual intervention (e.g. repos are cloned, dependencies
    3434
    are built, secrets are added/mocked, etc.).
    3535

    36-
    > Note: [External authentication](../admin/external-auth.md) can be helpful
    36+
    > Note: [External authentication](../admin/external-auth/index.md) can be helpful
    3737
    > to authenticate with third-party services such as GitHub or JFrog.
    3838
    3939
    - Give your agent the proper tools via MCP to interact with your codebase and

    ‎docs/manifest.json

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -589,7 +589,7 @@
    589589
    {
    590590
    "title": "External Authentication",
    591591
    "description": "Learn how to configure external authentication",
    592-
    "path": "./admin/external-auth.md",
    592+
    "path": "./admin/external-auth/index.md",
    593593
    "icon_path": "./images/icons/plug.svg"
    594594
    },
    595595
    {

    ‎docs/tutorials/cloning-git-repositories.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -20,9 +20,9 @@ authorization. This can be achieved by using the Git provider, such as GitHub,
    2020
    as an authentication method. If you don't know how to do that, we have written
    2121
    documentation to help you:
    2222

    23-
    - [GitHub](../admin/external-auth.md#github)
    24-
    - [GitLab self-managed](../admin/external-auth.md#gitlab-self-managed)
    25-
    - [Self-managed git providers](../admin/external-auth.md#self-managed-git-providers)
    23+
    - [GitHub](../admin/external-auth/index.md#github)
    24+
    - [GitLab self-managed](../admin/external-auth/index.md#gitlab-self-managed)
    25+
    - [Self-managed git providers](../admin/external-auth/index.md#self-managed-git-providers)
    2626

    2727
    With the authentication in place, it is time to set up the template to use the
    2828
    [Git Clone module](https://registry.coder.com/modules/git-clone) from the

    ‎docs/tutorials/template-from-scratch.md

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -171,7 +171,7 @@ resource "coder_agent" "main" {
    171171
    Because Docker is running locally in the Coder server, there is no need to
    172172
    authenticate `coder_agent`. But if your `coder_agent` is running on a remote
    173173
    host, your template will need
    174-
    [authentication credentials](../admin/external-auth.md).
    174+
    [authentication credentials](../admin/external-auth/index.md).
    175175

    176176
    This template's agent also runs a startup script, sets environment variables,
    177177
    and provides metadata.

    0 commit comments

    Comments
     (0)
    0