Skip to content

chore(docs): small fixes in JFrog integration docs #8736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2023
Merged

chore(docs): small fixes in JFrog integration docs #8736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/platforms/jfrog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Use Coder and JFrog together to secure your development environments without dis
This guide will demonstrate how to use JFrog Artifactory as a package registry
within a workspace. We'll use Docker as the underlying compute. But, these concepts apply to any compute platform.

The full example template can be found [here](https://github.com/coder/coder/tree/main/examples/jfrog-docker).
The full example template can be found [here](https://github.com/coder/coder/tree/main/examples/templates/jfrog-docker).

## Requirements

Expand Down Expand Up @@ -68,7 +68,7 @@ When pushing the template, you can pass in the variables using the `-V` flag:
coder templates push --var 'jfrog_url=https://YYY.jfrog.io' --var 'artifactory_access_token=XXX'
```

## Installing jf
## Installing JFrog CLI

`jf` is the JFrog CLI. It can do many things across the JFrog platform, but
we'll focus on its ability to configure package managers, as that's the relevant
Expand All @@ -80,13 +80,12 @@ The generic method of installing the JFrog CLI is the following command:
curl -fL https://install-cli.jfrog.io | sh
```

Other methods are listed [here](https://jfrog.com/help/r/jfrog-cli/download-and-installation).
Other methods are listed [here](https://jfrog.com/getcli/).

In our Docker-based example, we install `jf` by adding these lines to our `Dockerfile`:

```Dockerfile
RUN curl -fL https://install-cli.jfrog.io | sh
RUN chmod 755 $(which jf)
RUN curl -fL https://install-cli.jfrog.io | sh && chmod 755 $(which jf)
```

and use this `coder_agent` block:
Expand Down Expand Up @@ -145,7 +144,7 @@ by inserting the following lines into your `startup_script`:
/tmp/code-server/bin/code-server --install-extension /tmp/jfrog.vsix
```

Note that this will method will only work if your developers use code-server.
Note that this method will only work if your developers use code-server.

## Configuring npm

Expand All @@ -171,5 +170,5 @@ supported by Artifactory.

## More reading

- See the full example template [here](https://github.com/coder/coder/tree/main/examples/jfrog-docker).
- See the full example template [here](https://github.com/coder/coder/tree/main/examples/templates/jfrog-docker).
- To serve extensions from your own VS Code Marketplace, check out [code-marketplace](https://github.com/coder/code-marketplace#artifactory-storage).