Skip to content

Commit 595e589

Browse files
Update container instructions
1 parent f870663 commit 595e589

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

docs/hub/installation/containers.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,43 @@ Using [docker](https://docker.com/) is a way to quickly try out *Certify Managem
99

1010
:::
1111

12-
A key thing to know about running apps in docker is that the container should be considered temporary (to be recreated later), so data should not be stored only within the container itself. To host the app in docker properly, you need to specify a persistent data volume to store configuration data (which hy default is under `/usr/share/certify`).
12+
A key thing to know about running apps in docker is that the container should be considered temporary (to be recreated later), so data should not be stored only within the container itself. To host the app in docker properly, you need to specify a persistent data volume to store configuration data (which by default is under `/usr/share/certify`).
1313

14-
#### Quick Start using Docker Compose
14+
#### Quick Start using Docker Compose (recommended)
1515
Save this file as `docker-compose.yaml`
1616

1717
```yaml
1818
name: certify-management-hub
1919
services:
2020
certify-hubservice:
2121
image: docker.io/certifytheweb/management-hub:latest
22-
hostname: certify-hubservice
2322
ports:
2423
- "8080:8080"
2524
volumes:
2625
- certifydata:/usr/share/certify/
26+
restart: unless-stopped
2727
volumes:
2828
certifydata:
2929
```
3030
31-
Then from the same path, run `docker compose up -d` to start the container.
31+
Then from the same path, run `docker compose up -d` to start/restart the container.
32+
33+
##### Upgrading
34+
35+
Using the latest version with docker compose is quick and easy:
36+
- Fetch the latest update with `docker pull certifytheweb/management-hub:latest`
37+
- then restart your container (from the path where your above `docker-compose.yaml` is kept): `docker compose up -d`
3238

3339
#### Quick Start directly with Docker Run
3440
Alternatively, to quickly try it out without using docker compose:
3541

36-
`docker run -v /local/path/to/data:/usr/share/certify -p HOST_PORT:8080 docker.io/certifytheweb/management-hub:latest`
42+
`docker run --name certify-management-hub -d -v /local/path/to/data:/usr/share/certify -p HOST_PORT:8080 --restart unless-stopped docker.io/certifytheweb/management-hub:latest`
43+
44+
e.g. `docker run --name certify-management-hub -d -v C:\temp\certifydata -p 8080:8080 --restart unless-stopped docker.io/certifytheweb/management-hub:latest`
45+
46+
##### Upgrading
3747

38-
e.g. `docker run -v C:\temp\certifydata -p HOST_PORT:8080 docker.io/certifytheweb/management-hub:latest`
48+
- Fetch the latest update with `docker pull certifytheweb/management-hub:latest` then recreate your container.
3949

4050
### Other common container environments
4151

docs/hub/known-issues.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ The web app uses WebAssembly (WASM) and has a large application payload on initi
2323
#### Errors when trying to login
2424
The UI needs to know the URL of the API it should talk to. This is configured by default to https://localhost:44361 or http://localhosts:808 when running from docker. The setting is changed for all users by editing wwwroot/appsettings.json or you can temporarily change the URL in the login page by clicking the Settings gear icon and setting the correct URL for your installation.
2525

26-
### DNS Providers
27-
#### Posh-ACME based DNS providers not working
28-
This is a known issue and is being worked on.
29-
3026
### Containers
3127
#### Data not persisted using containers
3228
The app will store settings in a combination of json files and SQLite DB files under `/usr/share/certify`. We will eventually offer the option to store some configuration in external databases such as postgres but the app does need to store some basic settings on file storage. In Docker etc this is achieved by mounting `/usr/share/certify` to persistant storage. You can override teh app data path used by setting the `CERTIFY_APPDATA_PATH` environment variable to a preferred path. This path must be writeable by the non-root container user.

0 commit comments

Comments
 (0)