mirror of
https://github.com/gomods/athens
synced 2026-02-03 12:10:32 +00:00
Update shared-team-instance.md (#2032)
This commit is contained in:
@@ -10,7 +10,7 @@ We will use Docker to run the Athens proxy, so first make sure you have Docker [
|
|||||||
|
|
||||||
## Selecting a Storage Provider
|
## Selecting a Storage Provider
|
||||||
|
|
||||||
Athens currently supports a number of storage drivers. For local, use we recommend starting with the local disk provider. For other providers, please see [the Storage Provider documentation](/configuration/storage).
|
Athens currently supports a number of storage drivers. For local use we recommend starting with the local disk provider. For other providers, please see [the Storage Provider documentation](/configuration/storage).
|
||||||
|
|
||||||
|
|
||||||
## Running Athens with Local Disk Storage
|
## Running Athens with Local Disk Storage
|
||||||
@@ -48,7 +48,7 @@ docker run -d -v "$($env:ATHENS_STORAGE):/var/lib/athens" `
|
|||||||
|
|
||||||
Note: if you have not previously mounted this drive with Docker for Windows, you may be prompted to allow access
|
Note: if you have not previously mounted this drive with Docker for Windows, you may be prompted to allow access
|
||||||
|
|
||||||
Athens should now be running as a Docker container with the local directory, `athens-storage` mounted as a volume. When Athens retrieves the modules, they will be will be stored in the directory previously created. First, let's verify that Athens is running:
|
Athens should now be running as a Docker container with the local directory, `athens-storage` mounted as a volume. When Athens retrieves the modules, they will be stored in the directory previously created. First, let's verify that Athens is running:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ docker ps
|
$ docker ps
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ This is a quick recap of the [Walkthrough](/walkthrough)
|
|||||||
|
|
||||||
### Using the `docker` cli
|
### Using the `docker` cli
|
||||||
|
|
||||||
In order to run the Athens Proxy using docker, we need first to create a directory that will store the persitant modules.
|
In order to run the Athens Proxy using docker, we need first to create a directory that will store the persistant modules.
|
||||||
In the example below, the new directory is named `athens-storage` and is located in our userspace (i.e. `$HOME`).
|
In the example below, the new directory is named `athens-storage` and is located in our userspace (i.e. `$HOME`).
|
||||||
Then we need to set the `ATHENS_STORAGE_TYPE` and `ATHENS_DISK_STORAGE_ROOT` environment variables when we run the Docker container.
|
Then we need to set the `ATHENS_STORAGE_TYPE` and `ATHENS_DISK_STORAGE_ROOT` environment variables when we run the Docker container.
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ docker run -d -v "$($env:ATHENS_STORAGE):/var/lib/athens" `
|
|||||||
## Non-Root User
|
## Non-Root User
|
||||||
|
|
||||||
The Athens docker images comes with a non-root user `athens` with `uid: 1000`, `gid: 1000` and home directory `/home/athens`.
|
The Athens docker images comes with a non-root user `athens` with `uid: 1000`, `gid: 1000` and home directory `/home/athens`.
|
||||||
In situations where running as root is not permitted, this user can be used instead. In all other instuctions
|
In situations where running as root is not permitted, this user can be used instead. In all other instructions
|
||||||
replace `/root/` with `/home/athens/` and set the user and group ids in the run environment to `1000`.
|
replace `/root/` with `/home/athens/` and set the user and group ids in the run environment to `1000`.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
Reference in New Issue
Block a user