fix md in jfrog-artifactory

EdwardAngert · EdwardAngert · commit a8b2217e6822 · 2024-11-25T21:59:09.000Z
diff --git a/docs/admin/integrations/jfrog-artifactory.md b/docs/admin/integrations/jfrog-artifactory.md
@@ -31,7 +31,7 @@ by using our official Coder [modules](https://registry.coder.com). We publish
 two type of modules that automate the JFrog Artifactory and Coder integration.
 
 1. [JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth)
-2. [JFrog-Token](https://registry.coder.com/modules/jfrog-token)
+1. [JFrog-Token](https://registry.coder.com/modules/jfrog-token)
 
 ### JFrog-OAuth
 
@@ -45,70 +45,70 @@ To set this up, follow these steps:
 
 1. Modify your Helm chart `values.yaml` for JFrog Artifactory to add,
 
-```yaml
-artifactory:
-  enabled: true
-  frontend:
-  extraEnvironmentVariables:
-    - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION
-      value: "true"
-  access:
-  accessConfig:
-    integrations-enabled: true
-    integration-templates:
-      - id: "1"
-        name: "CODER"
-        redirect-uri: "https://CODER_URL/external-auth/jfrog/callback"
-        scope: "applied-permissions/user"
-```
-
-> Note Replace `CODER_URL` with your Coder deployment URL, e.g.,
-> <coder.example.com>
-
-2. Create a new Application Integration by going to
+   ```yaml
+   artifactory:
+     enabled: true
+     frontend:
+     extraEnvironmentVariables:
+       - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION
+         value: "true"
+     access:
+     accessConfig:
+       integrations-enabled: true
+       integration-templates:
+         - id: "1"
+           name: "CODER"
+           redirect-uri: "https://CODER_URL/external-auth/jfrog/callback"
+           scope: "applied-permissions/user"
+   ```
+
+   > Note Replace `CODER_URL` with your Coder deployment URL, e.g.,
+   > <coder.example.com>
+
+1. Create a new Application Integration by going to
    <https://JFROG_URL/ui/admin/configuration/integrations/new> and select the
    Application Type as the integration you created in step 1.
 
-![JFrog Platform new integration](../../images/guides/artifactory-integration/jfrog-oauth-app.png)
+   ![JFrog Platform new integration](../../images/guides/artifactory-integration/jfrog-oauth-app.png)
 
-3. Add a new
+1. Add a new
    [external authentication](https://coder.com/docs/admin/external-auth) to
    Coder by setting these env variables,
 
-```env
-# JFrog Artifactory External Auth
-CODER_EXTERNAL_AUTH_1_ID="jfrog"
-CODER_EXTERNAL_AUTH_1_TYPE="jfrog"
-CODER_EXTERNAL_AUTH_1_CLIENT_ID="YYYYYYYYYYYYYYY"
-CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXX"
-CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="JFrog Artifactory"
-CODER_EXTERNAL_AUTH_1_DISPLAY_ICON="/icon/jfrog.svg"
-CODER_EXTERNAL_AUTH_1_AUTH_URL="https://JFROG_URL/ui/authorization"
-CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
-```
-
-> Note Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g.,
-> <example.jfrog.io>
-
-4. Create or edit a Coder template and use the
+   ```env
+   # JFrog Artifactory External Auth
+   CODER_EXTERNAL_AUTH_1_ID="jfrog"
+   CODER_EXTERNAL_AUTH_1_TYPE="jfrog"
+   CODER_EXTERNAL_AUTH_1_CLIENT_ID="YYYYYYYYYYYYYYY"
+   CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXX"
+   CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="JFrog Artifactory"
+   CODER_EXTERNAL_AUTH_1_DISPLAY_ICON="/icon/jfrog.svg"
+   CODER_EXTERNAL_AUTH_1_AUTH_URL="https://JFROG_URL/ui/authorization"
+   CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
+   ```
+
+   > Note Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g.,
+   > <example.jfrog.io>
+
+1. Create or edit a Coder template and use the
    [JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth) module to
    configure the integration.
 
-```tf
-module "jfrog" {
-  source = "registry.coder.com/modules/jfrog-oauth/coder"
-  version = "1.0.0"
-  agent_id = coder_agent.example.id
-  jfrog_url = "https://jfrog.example.com"
-  configure_code_server = true # this depends on the code-server
-  username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
-  package_managers = {
-    "npm": "npm",
-    "go": "go",
-    "pypi": "pypi"
-  }
-}
-```
+   ```tf
+   module "jfrog" {
+     source = "registry.coder.com/modules/jfrog-oauth/coder"
+     version = "1.0.0"
+     agent_id = coder_agent.example.id
+     jfrog_url = "https://jfrog.example.com"
+     configure_code_server = true # this depends on the code-server
+        username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
+     package_managers = {
+       "npm": "npm",
+       "go": "go",
+       "pypi": "pypi"
+     }
+   }
+   ```
 
 ### JFrog-Token
 
@@ -123,37 +123,36 @@ To set this up, follow these steps:
 1. Get a JFrog access token from your Artifactory instance. The token must be an
    [admin token](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token)
    with scope `applied-permissions/admin`.
-2. Create or edit a Coder template and use the
+1. Create or edit a Coder template and use the
    [JFrog-Token](https://registry.coder.com/modules/jfrog-token) module to
    configure the integration and pass the admin token. It is recommended to
    store the token in a sensitive terraform variable to prevent it from being
    displayed in plain text in the terraform state.
 
-```tf
-variable "artifactory_access_token" {
-  type      = string
-  sensitive = true
-}
-
-module "jfrog" {
-  source = "registry.coder.com/modules/jfrog-token/coder"
-  version = "1.0.0"
-  agent_id = coder_agent.example.id
-  jfrog_url = "https://example.jfrog.io"
-  configure_code_server = true # this depends on the code-server
-  artifactory_access_token = var.artifactory_access_token
-  package_managers = {
-    "npm": "npm",
-    "go": "go",
-    "pypi": "pypi"
-  }
-}
-```
-
-<blockquote class="info">
-The admin-level access token is used to provision user tokens and is never exposed to
-developers or stored in workspaces.
-</blockquote>
+   ```tf
+   variable "artifactory_access_token" {
+     type      = string
+     sensitive = true
+   }
+
+   module "jfrog" {
+     source = "registry.coder.com/modules/jfrog-token/coder"
+     version = "1.0.0"
+     agent_id = coder_agent.example.id
+     jfrog_url = "https://example.jfrog.io"
+     configure_code_server = true # this depends on the code-server
+     artifactory_access_token = var.artifactory_access_token
+     package_managers = {
+       "npm": "npm",
+       "go": "go",
+       "pypi": "pypi"
+     }
+   }
+   ```
+
+   <blockquote class="info">
+   The admin-level access token is used to provision user tokens and is never exposed to developers or stored in workspaces.
+   </blockquote>
 
 If you do not want to use the official modules, you can check example template
 that uses Docker as the underlying compute
