chore(jfrog-oauth): update JFrog OAuth module README (#114)
This commit is contained in:
committed by
GitHub
parent
f8faea1855
commit
382933aece
@@ -12,7 +12,9 @@ tags: [integration, jfrog]
|
|||||||
|
|
||||||
Install the JF CLI and authenticate package managers with Artifactory using OAuth configured via the Coder `external-auth` feature.
|
Install the JF CLI and authenticate package managers with Artifactory using OAuth configured via the Coder `external-auth` feature.
|
||||||
|
|
||||||

|
<p align="center">
|
||||||
|
<img src='../.images/jfrog-oauth.png' alt="JFrog OAuth" width='600'>
|
||||||
|
</p>
|
||||||
|
|
||||||
```hcl
|
```hcl
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
@@ -29,9 +31,53 @@ module "jfrog" {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> Note
|
||||||
|
> This module does not install `npm`, `go`, `pip`, etc but only configure them. You need to handle the installation of these tools yourself.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Coder [`external-auth`](https://coder.com/docs/v2/latest/admin/external-auth) configured with Artifactory. This requires a [custom integration](https://jfrog.com/help/r/jfrog-installation-setup-documentation/enable-new-integrations) in Artifactory with **Callback URL** set to `https://<your-coder-url>/external-auth/jfrog/callback`.
|
Coder [`external-auth`](https://coder.com/docs/v2/latest/admin/external-auth) configured with Artifactory. This requires a [custom integration](https://jfrog.com/help/r/jfrog-installation-setup-documentation/enable-new-integrations) in Artifactory with **Callback URL** set to `https://<your-coder-url>/external-auth/jfrog/callback`.
|
||||||
|
|
||||||
|
To set this up,
|
||||||
|
1 . Modify your `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. Add a new [external authetication](https://coder.com/docs/v2/latest/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_TOKEN_URL="https://JFROG_URL/access/api/v1/integrations/YYYYYYYYYYYYYYY/token"
|
||||||
|
CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
|
||||||
|
```
|
||||||
|
|
||||||
|
> Note
|
||||||
|
> Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g., <artifactory.example.com>
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
@@ -35,6 +35,9 @@ variable "artifactory_access_token" {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> Note
|
||||||
|
> This module does not install `npm`, `go`, `pip`, etc but only configure them. You need to handle the installation of these tools yourself.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|||||||
Reference in New Issue
Block a user