Skip to content

Commit 3eeeeb0

Browse files
authored
Add Aviary org docs (#225)
1 parent 136a749 commit 3eeeeb0

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

docs/artifact_repositories/cargo.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ authentication. You can find out how to generate one in our
1313
In the following examples, all API keys will be represented as
1414
`<PHYLUM_API_KEY>`, so make sure to replace them with your generated key.
1515

16-
Additionally, if the default [policy] is not sufficient, a group can be passed
17-
to evaluate all packages against the group's policy. To do this, just replace
18-
`<PHYLUM_GROUP>` with the desired group name. The supplied API key **must** have
19-
access to this group.
16+
Additionally, if the default policy is not sufficient, a group can be passed to
17+
evaluate all packages against the group's policy. To do this, just replace
18+
`<PHYLUM_ORG>` and `<PHYLUM_GROUP>` with the desired org and group name. The
19+
supplied API key **must** have access to this group.
2020

21-
If Phylum's default [policy] is sufficient, you can remove all instances of
22-
`<PHYLUM_GROUP>`.
21+
If Phylum's default [policy] is sufficient, you can omit the username from the
22+
authentication details.
2323

2424
[API Keys documentation]: ../knowledge_base/api-keys.md#generate-an-api-key
2525
[policy]: ../knowledge_base/policy.md
@@ -72,10 +72,10 @@ global-credential-providers = ["cargo:token"]
7272
Once the file-based `cargo:token` credential provider is configured, you can add
7373
your authentication details to the [`.cargo/credentials.toml` file].
7474

75-
The Phylum group and API key first need to be converted to Base64:
75+
The Phylum org, group, and API key first need to be converted to Base64:
7676

7777
```text
78-
printf "<PHYLUM_GROUP>:<PHYLUM_API_KEY>" | base64
78+
printf "<PHYLUM_ORG>/<PHYLUM_GROUP>:<PHYLUM_API_KEY>" | base64
7979
```
8080

8181
> ⚠️ **WARNING** ⚠️

docs/artifact_repositories/maven.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,24 @@ authentication. You can find out how to generate one in our
1313
In the following examples, all API keys will be represented as
1414
`<PHYLUM_API_KEY>`, so make sure to replace them with your generated key.
1515

16-
Additionally, if the default [policy] is not sufficient, a group can be passed
17-
to evaluate all packages against the group's policy. To do this, just replace
18-
`<PHYLUM_GROUP>` with the desired group name. The supplied API key **must** have
19-
access to this group.
16+
Additionally, if the default policy is not sufficient, a group can be passed to
17+
evaluate all packages against the group's policy. To do this, just replace
18+
`<PHYLUM_ORG>` and `<PHYLUM_GROUP>` with the desired org and group name. The
19+
supplied API key **must** have access to this group.
2020

21-
If Phylum's default [policy] is sufficient, you can remove all instances of
22-
`<PHYLUM_GROUP>`.
21+
If Phylum's default [policy] is sufficient, you can omit the username from the
22+
authentication details.
2323

2424
[API Keys documentation]: ../knowledge_base/api-keys.md#generate-an-api-key
2525
[policy]: ../knowledge_base/policy.md
2626

2727
### `mvn`
2828

2929
The Phylum authorization header expects a token in Base64, so you first need to
30-
convert your Phylum group and API key:
30+
convert your Phylum org, group, and API key:
3131

3232
```sh
33-
printf "<PHYLUM_GROUP>:<PHYLUM_API_KEY>" | base64
33+
printf "<PHYLUM_ORG>/<PHYLUM_GROUP>:<PHYLUM_API_KEY>" | base64
3434
```
3535

3636
> ⚠️ **WARNING** ⚠️

docs/artifact_repositories/npm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ authentication. You can find out how to generate one in our
1313
In the following examples, all API keys will be represented as
1414
`<PHYLUM_API_KEY>`, so make sure to replace them with your generated key.
1515

16-
Additionally, if the default [policy] is not sufficient, a group can be passed
17-
to evaluate all packages against the group's policy. To do this, just replace
18-
`<PHYLUM_GROUP>` with the desired group name. The supplied API key **must** have
19-
access to this group.
16+
Additionally, if the default policy is not sufficient, a group can be passed to
17+
evaluate all packages against the group's policy. To do this, just replace
18+
`<PHYLUM_ORG>` and `<PHYLUM_GROUP>` with the desired org and group name. The
19+
supplied API key **must** have access to this group.
2020

21-
If Phylum's default [policy] is sufficient, you can remove all instances of
22-
`<PHYLUM_GROUP>`.
21+
If Phylum's default [policy] is sufficient, you can omit the username from the
22+
authentication details.
2323

2424
[API Keys documentation]: ../knowledge_base/api-keys.md#generate-an-api-key
2525
[policy]: ../knowledge_base/policy.md
@@ -30,7 +30,7 @@ Custom NPM registries can be configured with `npm`:
3030

3131
```sh
3232
npm config set replace-registry-host never
33-
npm config set registry https://<PHYLUM_GROUP>:<PHYLUM_API_KEY>@npm.phylum.io/
33+
npm config set registry https://<PHYLUM_ORG>%2F<PHYLUM_GROUP>:<PHYLUM_API_KEY>@npm.phylum.io/
3434
```
3535

3636
> ⚠️ **WARNING** ⚠️

docs/artifact_repositories/pypi.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ In the following examples, all API keys will be represented as
1515

1616
Additionally, if the default policy is not sufficient, a group can be passed to
1717
evaluate all packages against the group's policy. To do this, just replace
18-
`<PHYLUM_GROUP>` with the desired group name. The supplied API key **must** have
19-
access to this group.
18+
`<PHYLUM_ORG>` and `<PHYLUM_GROUP>` with the desired org and group name. The
19+
supplied API key **must** have access to this group.
2020

21-
If Phylum's default [policy] is sufficient, you can remove all instances of
22-
`<PHYLUM_GROUP>`.
21+
If Phylum's default [policy] is sufficient, you can omit the username from the
22+
authentication details.
2323

2424
[API Keys documentation]: ../knowledge_base/api-keys.md#generate-an-api-key
2525
[policy]: ../knowledge_base/policy.md
@@ -30,14 +30,14 @@ The easiest way to install a package using the Phylum PyPI registry is using
3030
`pip`'s `--index-url` option:
3131

3232
```sh
33-
pip install --index-url https://<PHYLUM_GROUP>:<PHYLUM_API_KEY>@pypi.phylum.io/simple/ <requirement specifier>
33+
pip install --index-url https://<PHYLUM_ORG>%2F<PHYLUM_GROUP>:<PHYLUM_API_KEY>@pypi.phylum.io/simple/ <requirement specifier>
3434
```
3535

3636
To make this permanent for all `pip` invocations, you can add it to the `pip`
3737
configuration:
3838

3939
```sh
40-
pip config set global.index-url https://<PHYLUM_GROUP>:<PHYLUM_API_KEY>@pypi.phylum.io/simple/
40+
pip config set global.index-url https://<PHYLUM_ORG>%2F<PHYLUM_GROUP>:<PHYLUM_API_KEY>@pypi.phylum.io/simple/
4141
```
4242

4343
> ⚠️ **WARNING** ⚠️
@@ -62,7 +62,7 @@ directory:
6262

6363
```sh
6464
poetry source add phylum https://pypi.phylum.io/simple/
65-
poetry config http-basic.phylum "<PHYLUM_GROUP>" "<PHYLUM_API_KEY>"
65+
poetry config http-basic.phylum "<PHYLUM_ORG>%2F<PHYLUM_GROUP>" "<PHYLUM_API_KEY>"
6666
```
6767

6868
> ⚠️ **WARNING** ⚠️

docs/artifact_repositories/rubygems.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ authentication. You can find out how to generate one in our
1313
In the following examples, all API keys will be represented as
1414
`<PHYLUM_API_KEY>`, so make sure to replace them with your generated key.
1515

16-
Additionally, if the default [policy] is not sufficient, a group can be passed
17-
to evaluate all packages against the group's policy. To do this, just replace
18-
`<PHYLUM_GROUP>` with the desired group name. The supplied API key **must** have
19-
access to this group.
16+
Additionally, if the default policy is not sufficient, a group can be passed to
17+
evaluate all packages against the group's policy. To do this, just replace
18+
`<PHYLUM_ORG>` and `<PHYLUM_GROUP>` with the desired org and group name. The
19+
supplied API key **must** have access to this group.
2020

21-
If Phylum's default [policy] is sufficient, you can remove all instances of
22-
`<PHYLUM_GROUP>`.
21+
If Phylum's default [policy] is sufficient, you can omit the username from the
22+
authentication details.
2323

2424
[API Keys documentation]: ../knowledge_base/api-keys.md#generate-an-api-key
2525
[policy]: ../knowledge_base/policy.md
@@ -39,7 +39,7 @@ After setting up the mirror, you also need to provide Phylum's group and API key
3939
for authorization:
4040

4141
```sh
42-
bundle config set --global rubygems.phylum.io <PHYLUM_GROUP>:<PHYLUM_API_KEY>
42+
bundle config set --global rubygems.phylum.io <PHYLUM_ORG>%2F<PHYLUM_GROUP>:<PHYLUM_API_KEY>
4343
```
4444

4545
> ⚠️ **WARNING** ⚠️

0 commit comments

Comments
 (0)