RCL CertificateBot runs as a Daemon in a Linux Server. The daemon will run every seven (7) days to automatically renew and save SSL/TLS certificates from a user’s subscription in the RCL Portal to a Linux hosting machine.
- Automatically Renew TLS/SSL Certificates
- Download and Extract the Daemon Files to the Linux Server
- Configure the Daemon
- Get the SubscriptionId
- Register the AAD Application’s Client Id in the RCL Portal
- Add the Configuration variables
- Example of a configured appsettings.json file
- Create the Daemon
- Reload the Daemon
- Start the Daemon
- View the Status of the Daemon
- View the Detailed Logs
- When you need to Stop the Daemon
- Certificate Files
- Configuring the Web Servers
Automatically Renew TLS/SSL Certificates
You can use RCL CertificateBot to automatically renew SSL/TLS certificates created in the RCL Portal using the the following creation options :
- Azure DNS (including SAN) – Recommended
‘Stand Alone’ certificates are not supported by RCL CertificateBot.
Download and Extract the Daemon Files to the Linux Server
In this section, you will download the files from the RCL CertificateBot GitHub Project Page in the Releases section; and extract it to your Linux Server in the /usr/sbin folder:
- In your Linux server, navigate to the /usr/sbin folder
- Run the command in the folder to download and extract the linux-x64 files:
or linux-arm files :
Configure the Daemon
Register an AAD Application
An Azure Active Directory (AAD) application must be registered to obtain permission to access a user’s Azure resources (DNS Zone).
Please refer to the following link to register an AAD application:
- Registering an AAD Application
Set Access Control for the AAD Application
Access control must be set for the AAD application to access resources (DNS Zone) in a user’s Azure subscription. Please refer to the following link to set access control :
- Setting Access Control for the AAD Application
Get the AAD Application Credentials
To obtain the following credentials from the AAD application:
follow the instructions in this link :
- Get the AAD Application Credentials
Get the SubscriptionId
Get the Subscription Id in the RCL Portal.
- Scroll down and copy the ‘Subscription Id’
Register the AAD Application’s Client Id in the RCL Portal
The AAD Application must be associated with a user’s RCL subscription. This is achieved by registering the AAD Application’s Client Id in the RCL Portal.
To add the AAD Application’s Client Id to the portal, please follow the instructions in this link :
- Add the Client Id in the RCL Portal
Add the Configuration variables
- Navigate to the folder you downloaded and extracted the daemon files :
or for arm
- Use nano (or other text editor) to edit the appsettings.json file in the folder
- Add the credentials for the AAD Application and SubscriptionId in the RCLSDK section :
In the CertificateBot section, set a folder path to save the SSL/TLS certificates. Recommended path : /etc/ssl/certificatebot
- Create the folder in the server and ensure it has read/write permissions so that the certificates can be saved to it.
- The includeCertificates settings will allow for including specific certificates by its name (eg: “contoso.com” or “contoso.com, *.contoso.com” – for SAN) for the certificate(s) you want to save on the server.
Example of a configured appsettings.json file
- Save the updated appsettings.json file when you are done
Create the Daemon
- Navigate to the /etc/systemd/system folder
- Create the daemon file
- Use nano (or other text editor) to edit the service file
- Add the following code to the file
If you installed the arm version, change the directory to the arm path /usr/sbin/certificatebot-linux-arm instead of /usr/sbin/certificatebot-linux-x64 in the ‘WorkingDirectory’ and ‘ExecStart’ settings
- Save the file when you are done
Reload the Daemon
- Reload the daemon anytime you make changes to the service file
Start the Daemon
- Run the code to start the daemon
View the Status of the Daemon
- Run the code to view the status of the daemon
You will see the status of the daemon. The most recent logs will also be displayed.
Ensure that there are no errors in the logs. If there are errors, the daemon is misconfigured and will not function
View the Detailed Logs
- Run the command to view the daemon’s detailed logs
- If the application is working correctly you should see messages similar to the one below :
When you need to Stop the Daemon
- Run the code when you need to stop the daemon. When the daemon is stopped, CertificateBot will discontinue certificate renewals and installation in the server.
If you encounter errors in the logs for the daemon, please stop the daemon. Ensure the ‘appsettings’ configuration is correct for the AAD Application credentials and the certificate save path settings.
The folder to save the certificate must have read/write access.
Reload and restart the daemon after you make changes and check if the errors were resolved.
RCL CertificateBot will automatically save renewed SSL/TLS certificate files to a folder in the server. You should then configure the web server to use these files to implement SSL/TLS in your website.
The SSL/TLS certificate files will be stored at the path you specified in the appsettings.json configuration file. In this example, we used the path /etc/ssl/certificatebot to store the certificate files.
When configuring the web servers, you will reference the specific certificate files stored at that path in a folder generated by CertificateBot for a specified domain.
The following files are downloaded and saved on the server :
- certificate.pfx – The PFX certificate file
- primaryCertificate.crt The primary certificate file
- fullChainCertificate.crt – The full chain certificate file
- caBundle.crt – The intermediate certificate file
- privateKey.key – The certificate’s private key file
Configuring the Web Servers
Please follow the links below to configure your web server:
- Installing SSL/TLS Certificates in Apache Server
- Installing SSL/TLS Certificates in Apache Tomcat
- Installing SSL/TLS Certificates in NGINX
- Installing SSL/TLS Certificates in Web Servers and Hosting Services