Skip to content

Commit 1c522c4

Browse files
Update docker image references
1 parent 8528ad2 commit 1c522c4

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

docs/hub/installation/containers.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,37 +51,47 @@ e.g. `docker run --name certify-management-hub -d -v C:\temp\certifydata -p 8080
5151

5252
For simplest setup you can fetch the combined Certify Management Hub image from:
5353

54-
Docker Hub: https://hub.docker.com/repository/docker/certifytheweb/management-hub
55-
56-
GitHub Packages: https://github.com/certifytheweb?tab=packages
54+
- Docker Hub: https://hub.docker.com/r/certifytheweb/management-hub
55+
- GitHub Packages: https://github.com/certifytheweb?tab=packages
5756

5857
#### OpenShift
5958
Add Storage > persistent volume claim `certifydata` with mount path `/usr/share/certifydata`, see also `CERTIFY_APP_DATA` below.
6059

6160
## Certify Management Agent
6261
Certify Management Agent is a version of the *Certify Certificate Manager* service which can run "headless" (with no UI) on many different platforms.
6362

64-
### Docker Example
63+
- Docker Hub: https://hub.docker.com/r/certifytheweb/certify-agent
64+
- GitHub Packages: https://github.com/certifytheweb?tab=packages
6565

66-
To run an instance of the agent and point it to your management hub:
66+
### Docker Example
6767

68-
`docker run ghcr.io/certifytheweb/certify-agent:latest -v <your data path>:/usr/share/certify -e CERTIFY_MANAGEMENT_HUB=https://<your hub API>/api/internal/managementhub`
68+
To run an instance of the agent and point it to your management hub, with a preset joining secret:
6969

70+
```
71+
docker run docker.io/certifytheweb/certify-agent:latest -v <your data path>:/usr/share/certify -e CERTIFY_MANAGEMENT_HUB=https://<your hub API> -e CERTIFY_MANAGEMENT_HUB_CLIENT_ID= "managedinstance_sp_01" -e CERTIFY_MANAGEMENT_HUB_CLIENT_SECRET= "<your client secret>" -e CERTIFY_MANAGEMENT_HUB_AUTOJOIN= "true"
72+
```
73+
7074
Where `your data path` is a path on your host machine where you will store settings, e.g. `/Users/macos/certifydata` or `C:\CertifyData` - you can make these paths anything you like depending on your requirements. The key thing is that when you update the container you will run it with the same path in order to use the same settings again.
7175

72-
7376
## Environment Variables
7477

75-
`You can optionally specify environment variables to modify the default config:
78+
You can optionally specify environment variables to modify the default config:
79+
80+
`CERTIFY_MANAGEMENT_HUB` : Specify the management hub API URL when working with multiple containers e.g. `http://certify-api:8080`
81+
82+
`CERTIFY_MANAGEMENT_HUB_CLIENT_ID` : Specify the management hub joining secret Client ID
83+
84+
`CERTIFY_MANAGEMENT_HUB_CLIENT_SECRET` : Specify the management hub joining secret
85+
86+
`CERTIFY_MANAGEMENT_HUB_AUTOJOIN` : Set to `"true"` to tell the instance to automatically attempt to join the specified hub
87+
7688

7789
`CERTIFY_ADMIN_DEFAULTUSERNAME` : Override the initial default `admin` username. Only has an effect on initial setup.
7890

7991
`CERTIFY_ADMIN_DEFAULTPWD`: Override the initial default admin password of `changeme!`. Only has an effect on initial setup.
8092

8193
`CERTIFY_APP_DATA` : Specify an alternative path to store core service settings.
8294

83-
`CERTIFY_MANAGEMENT_HUB` : Specify the management hub API URL when working with multiple containers e.g. `http://certify-api:8080/api/internal/managementhub`
84-
8595
`CERTIFY_SERVICE_HOST` : Specify the backend agent host when working with multiple containers.
8696

8797
`CERTIFY_SERVICE_PORT`: Specify the backend agent port when working with multiple containers.

0 commit comments

Comments
 (0)