Skip to content

Commit 32c8e3e

Browse files
Add upgrade guide for custom service accounts
1 parent 2252e9e commit 32c8e3e

2 files changed

Lines changed: 28 additions & 2 deletions

File tree

docs/guides/installation.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Use this guide when you are installing *Certify Certificate Manager* on a Window
1515

1616
## System Requirements
1717

18-
**Supported OS: Any currently Microsoft Supported Windows or Windows Server edition with .NET Framework 4.6.2 (or higher).**
18+
**Supported OS: Any currently Microsoft Supported Windows or Windows Server edition compatible with [.NET 10](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md).**
1919

2020
This app requires outgoing https for API calls. Proxies are not officially supported. The app will need to communicate with your choice of Certificate Authority over https (the default is Let's Encrypt). For licensing or status reporting it will need to connect to https://api.certifytheweb.com and if you use any DNS APIs or Deployment Tasks which communicate with a remote API or service you will need connectivity to those.
2121

@@ -48,6 +48,32 @@ The latest release notes for the app can be found at https://certifytheweb.com/h
4848
### Settings are preserved between installs/upgrades
4949
Your settings are preserved in `%PROGRAMDATA%\certify`. For most users, this is `C:\ProgramData\certify`. Uninstalling the app or installing a new version does not remove the files stored here. We recommend including this location in your regular backup procedure.
5050

51+
### Upgrade from v6 to v7
52+
v7 onwards of our app use .Net 10 or higher (self-contained, you do not need to update .net) include substantial changes to compatabilty.
53+
- The Service exctuable has changed from Certify.Service.exe to Certify.Server.Core.exe (Certify Management Agent). If you had special security/firewall rules in place you may need to update them. If you have used a custom service account see below.
54+
- You should test before upgrading, in particular if you have any custom powershell scripts for deployment tasks. Our internal Powershell process has changed from PS5.1 to PS7.x and the app will now call out to the system powershell process by default for compatability.
55+
56+
#### Upgrading with custom service accounts
57+
By default the app would have previously used Local System for it's service. If you have customized this you will need to perform a careful upgrade to preserve encrypted items like Stored Credentials.
58+
59+
To proceed:
60+
- Backup C:\ProgramData\certify (or equivalent location)
61+
. Note which service account you were running the Certify background service under.
62+
- Uninstall Certify Certificate Manager (your ProgramData settings will be preserved)
63+
- Run the install for Certify Certificate Manager 7.x but choose the advanced option, this is to avoid starting the service after the install
64+
- In Windows Local Services, set the log on for the new Certify.Server.Core.exe (Certify Management Agent) service to the same account you were using previously for the old service, ensure service startup is set to automatic, then start the service.
65+
- The service will upgrade your settings and you can now launch the app.
66+
- You should review that renewals are working as expected and any stored credentials for DNS etc are still operational.
67+
68+
#### Emergency Downgrade
69+
If you require an emergency downgrade to 6.x:
70+
- Ensure you have your previous backup of C:\ProgramData\certify ready to restore
71+
- Download the [old version](https://certifytheweb.s3.amazonaws.com/downloads/archive/CertifyTheWebSetup_V6.1.11.exe)
72+
- Uninstall Certify Certificate Manager.
73+
- Copy the newer C:\ProgramData\certify to a temp/backup location, then remove C:\ProgramData\certify
74+
- Restore your old backup settings to C:\ProgramData\certify
75+
- Install the older version normally.
76+
5177
### Common Issues
5278
- For in-app upgrading issues, download the latest version from https://certifytheweb.com and install normally.
5379
- If you are prompted to retry a file copy during upgrade, *do not cancel the setup or attempt rollback*. Instead, wait a moment and try again. The installer will automatically stop the background service but this can take a few seconds.

docs/guides/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you have found a specific security vulnerability you believe we need to be aw
1313
To ensure the best possible outcome always ensure that your operating system and the app components are fully up to date with vendor/os updates. Operating an internet facing server (web, email, ftp etc) without applying the latest security patches means your system will likely only continue to function due to luck (i.e. not yet being targeted by an attacker). This is doubly important if there is a network path from your internet facing server back to your corporate network. [Auto Updating](auto-update.md) is possible but comes with its own security risks and caveats.
1414

1515
## Service Account
16-
By default the application background service (Certify.Service) runs as Local System. This account has an *extremely* high level of privileges on the system (but not on the network). As an alternative it's possible to configure the service to run under a more restricted user account and just grant it the permissions it actually needs to run. If you do this you are required to ensure that the account has the permission you require and to re-apply this service account after updates are installed for the app (the installer will not currently preserve this account choice). You are also required to sync account credentials changes in order for the service to continue normal operation.
16+
By default the application background service runs as Local System. This account has an *extremely* high level of privileges on the system (but not on the network). As an alternative it's possible to configure the service to run under a more restricted user account and just grant it the permissions it actually needs to run. If you do this you are required to ensure that the account has the permission you require and to re-apply this service account after updates are installed for the app. You are also required to sync account credentials changes in order for the service to continue normal operation.
1717

1818
### Permissions Required
1919
During normal operation the service will/may need to perform the following privileged actions:

0 commit comments

Comments
 (0)