Skip to content

Commit c052e95

Browse files
Add linux install instructions
1 parent 6c03219 commit c052e95

File tree

10 files changed

+1901
-2306
lines changed

10 files changed

+1901
-2306
lines changed

docs/hub/guides/ccm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Using with Certify Certificate Manager
2+
title: Joining the Hub
33
---
44

55
## Summary

docs/hub/installation/containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: containers
3-
title: Docker and other container platforms
3+
title: Install for Docker and container platforms
44
---
55
### Docker
66
:::info

docs/hub/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can install the *Certify Management Hub* using docker, various Linux distrib
1212

1313
- [Docker and container environments](containers)
1414
- [Windows](windows)
15-
- Linux
15+
- [Linux](linux)
1616
- macOS
1717

1818
The product runs in Community Edition mode by default, see [Licensing](../../guides/licensing.md) for more information.

docs/hub/installation/linux.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
id: linux
3+
title: Install for Linux
4+
---
5+
6+
## Certify Management Hub
7+
8+
If you just want to try out the Management Hub and easy way to do that is to use [docker or other container tool](containers.md). However if you want to install the Management Hub (or Management Agent) directly you can do that as well.
9+
10+
#### Scripted Install
11+
The following commands:
12+
- Download the latest version, ensuring any old download and old install files are removed if present
13+
- Extract the downloaded archive to the temporary ./certify-hub-install path
14+
- Runs the install script to install under /opt/certify-hub, and sets up the hub as a systemd service called `certify-hub`, running as user `certify`.
15+
16+
```
17+
rm ./certify-hub-linux-x64-latest.tar.gz -f
18+
wget https://certifytheweb.s3.amazonaws.com/downloads/archive/beta/hub/certify-mgmthub-linux-x64-latest.tar.gz
19+
rm -rf ./certify-hub-install && mkdir -p ./certify-hub-install
20+
tar -xvf certify-mgmthub-linux-x64-latest.tar.gz -C ./certify-hub-install
21+
sudo ./certify-hub-install/scripts/install-hub.sh
22+
```
23+
24+
Note: for arm64, replace `x64` with `arm64` in the above instructions.
25+
26+
This will configure/update a systemd service called `certify-hub` running as user `certify`, with the main installed files under `/opt/certify-hub`. Settings will be stored under `/usr/share/certify`, by default the UI will be available at `http://localhost:8080`
27+
28+
To then clean up the temporary install files:
29+
```
30+
rm -rf ./certify-hub*
31+
```
32+
33+
##### Manual Install
34+
Alternatively, manually update and configure your install to your own preferences, you will need to run the executable `<install location>/Certify.HubService` to run the service and the user for the process will need to write to `/usr/share/certify`.
35+
36+
### Post Install Steps
37+
The default configuration will make the service and UI available at `http://localhost:8080`, with the default username `admin` and default password `changeme!`.
38+
39+
To use the service with https you can either [configure the service to use https](service.md) or reverse proxy the service from a webserver of your choice (Caddy, IIS, nginx, Apache etc and administer https on those as normal).
40+
41+
:::note
42+
Do not install the Hub service where you also want to use Certify Certificate Manager (or Certify Management Agent) as they will share the same settings/databases via different services which could create confusion or conflicts and is not a supported configuration.
43+
:::
44+
45+
Suggested Configuration for multi-user access:
46+
- Create an internal DNS hostname for the service e.g. certify-hub.yourowndomain.com and point it at the internal IP of your server hosting the hub.
47+
- [Configure the service to use https](service.md)
48+
- Setup individual user accounts under Settings > Security > Users, and assign the roles required for each user (e.g. Administrator).
49+
50+
## Certify Management Agent
51+
52+
The following commands:
53+
- Download the latest version, ensuring any old download and old install files are removed if present
54+
- Extract the downloaded archive to the temporary ./certify-agent-install path
55+
- Runs the install script to install under /opt/certify-agent, and sets up the agent as a systemd service running as user `certify`.
56+
57+
```
58+
rm ./certify-agent-linux-x64-latest.tar.gz -f
59+
wget https://certifytheweb.s3.amazonaws.com/downloads/archive/beta/agent/certify-agent-linux-x64-latest.tar.gz
60+
rm -rf ./certify-agent-install && mkdir -p ./certify-agent-install
61+
tar -xvf certify-agent-linux-x64-latest.tar.gz -C ./certify-agent-install
62+
sudo ./certify-agent-install/scripts/install-agent.sh
63+
```
64+
65+
To then clean up the temporary install files:
66+
```
67+
rm -rf ./certify-agent*
68+
```

docs/hub/installation/windows.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
11
---
2-
title: Installing on Windows
2+
title: Install for Windows
33
---
44

5-
:::warning[feature under development]
6-
This feature is under development and documentation may refer to features and procedures that are not yet available.
7-
:::
85

9-
## Installing on Windows
10-
11-
#### Install as a single service (UI and API)
12-
Install as a single combined management hub service is the simplest method with the least amount of configuration between components. This serves the Management Hub API, a backend certify-agent instance, and the web UI. Internally this is using the Kestrel web server which is part of Microsoft ASP.Net.
6+
#### Installing Certify Management Hub
7+
The management hub is installed as a single service which serves the Management Hub API, a backend certify-agent instance, and the web UI. Internally this is using the Kestrel web server which is part of Microsoft ASP.Net.
138

149
You can download the latest **alpha test** version [7.0.2.23-alpha.07 : Released 2025/05/20](https://certifytheweb.s3.amazonaws.com/downloads/archive/hub/CertifyMgmtHubSetup_7.0.2.23-alpha.07.exe) - this is intended for test evaluation and not for production use, as subsequent updates may including breaking changes.
1510

docs/hub/known-issues.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,11 @@ Normally, when the system changes managed certificate or updates it status the c
2626
#### Loading time over slow connections
2727
The web app uses WebAssembly (WASM) and has a large application payload on initial load. Subsequent loads used cached resources.
2828

29-
30-
### Deployment Tasks
31-
The remote option (for SSH etc) is not currently enabled.
32-
3329
### Containers
3430
#### Data not persisted using containers
35-
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 the 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.
31+
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 persistent storage. You can override the 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.
3632

37-
Multiple instances of the Certify Agent or Management Hub service reading and writing the same SQLite database storage is not currently supported, so deployments should only ever have one active container. Continous backups/snapshots etc of your volume are *essential* for production environments because SQLite file based databases can, and do, fail.
33+
Multiple instances of the Certify Agent or Management Hub service reading and writing the same SQLite database storage is not currently supported, so deployments should only ever have one active container. Continuous backups/snapshots etc of your volume are *essential* for production environments because SQLite file based databases can, and do, fail.
3834

3935
Note: We do not provide general support for how to use different container technology and you will likely need to know more about your choice of container deployment technology than we do, if you are using containers at all. Certify Management Hub is our first product that supports deployment to containers, so we expect growing pains.
4036

docusaurus.config.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ module.exports = {
66
favicon: 'img/favicon.ico',
77
organizationName: 'webprofusion', // Usually your GitHub org/user name.
88
projectName: 'certify-docs', // Usually your repo name.
9-
future: {
10-
experimental_faster: true,
11-
},
129
themeConfig: {
1310
algolia: {
1411
appId: 'YX7T7PF7BX',

0 commit comments

Comments
 (0)