BSOFTINDIA APP DOCUMENTATION
FREE AND EASY-TO-INSTALL SSL CERTIFICATE
STARTING WITH VERSION 9.20, BSOFT APP PROVIDES AN EASY TO USE FEATURE TO GENERATE OF A FREE AND VALID SSL CERTIFICATE.
IN 3 MOUSE CLICKS YOU WILL GET A SECURED VALID CERTIFICATE, RENEWED AUTOMATICALLY, AND CONFIGURED AUTOMATICALLY INTO BSOFT APP BUILT-IN WEB SERVER.
THIS FEATURE USES LET’S ENCRYPT TO PROVIDE A FREE AND SECURE SSL CERTIFICATE FOR YOUR HTTPS CONNECTIONS.
Please ensure that your Bsoft App server meet these requirements before using the Free Certificate Manager:
- You must use Bsoft App built-in web server listening on port 80 for HTTP. This is required by Let’s Encrypt domain ownership validation process.
- Your server’s domain name must be accessible from the public Internet. This is required as well to validate that you are the real owner of the domain.
- You must run this program on the Gateway server or a Standalone server, not an Application server (except if your Application Server is accessible from the public Internet and has a public domain name).
Please read carefully and check that your server meet all the requirements, then click on the “Next” button.
It is not possible to get a certificate for an IP address, be it public or private.
It is not possible to get a certificate for an internal domain name (i.e. a domain which only resolves inside your private network).
The Free Certificate Manager GUI will open and remind you about the prerequisites, as shown in the screenshot below:
STEP 1: ENTER YOUR EMAIL
As shown in the screenshot below, you only need to enter a valid email address.
This email will not be used to spam you. Actually it will not even be sent to Terminal Service Plus or any third party, except the certificate issuer: Let’s Encrypt.
They will only contact you if needed, according to their Terms Of Service.
Enter a valid email, then click on the “Next” button.
STEP 2: ACCEPT THE TERMS OF SERVICE
As shown in the screenshot below, you will be able to open Let’s Encrypt Terms Of Service by clicking on the big button.
To accept these Terms Of Service and continue, check the checkbox and click on the “Next” button.
STEP 3: ENTER THE SERVER'S DOMAIN NAME
As shown in the screenshot below, you only need to enter your server’s public domain name.
This is the public Internet accessible Domain Name, something like gateway.your-company.com. You can also enter another domain name or a subdomain name, separated with a comma. Example: “server1.example.com,www.server1example.com”
As explained in the GUI, do not add a protocol prefix and/or a port suffix, just enter the clean domain name(s).
The certificate will be generated for this domain name, and it will only be valid on a web page hosted at this domain name. If your users connect to your Web Portal using https://server1.example.com:1234, then you must enter “server1.example.com”.
ENJOY YOUR CERTIFICATE!
Bsoft App Free Certificate Manager will now use all the data to connect with Let’s Encrypt, validate that you really own the domain name you typed, and get the matching valid certificate.
Once the program receives the certificate, it will automatically handle all the required file format conversions and softly reload Bsoft App built-in web server in order to apply the new certificate to every new connection. The web server is not restarted and no connection is stopped.
LET’S ENCRYPT CERTIFICATES ARE VALID FOR 90 DAYS.
BSOFT APP WILL AUTOMATICALLY RENEW THE CERTIFICATE EVERY 60 DAYS FOR SAFETY. A CHECK IS DONE AT EVERY REBOOT OF THE WINDOWS SERVER, AND THEN EVERY 24 HOURS.
YOU CAN MANUALLY RENEW YOUR CERTIFICATE BY OPENING THE FREE CERTIFICATE MANAGER TOOL. IT WILL DISPLAY THE DOMAIN NAME OF THE CERTIFICATE AND ITS EXPIRATION DATE, AS SHOWN IN THE SCREENSHOT BELOW.
To manually renew your certificate, just click on the “Next” button.
The “Reset Domain” button on this window deletes the SSL certificate and reconfigure the Web Server to its original state before using the Certificate Manager.
If no error occurs, Bsoft App will renew the certificate automatically every 60 days. We recommend that you check every 60-70 days that your certificate has been automatically renewed.
We also recommend that you backup at least every month the following folder and its sub-folders:
C:\Program Files (x86)\ Bsoft App\UserDesktop\files\.lego
This is an internal folder, containing your Let’s Encrypt account private key, as well as the key pair of your certificate.
In case of an error, please contact support and email them the following log file:.
C:\Program Files (x86)\Bsoft App\UserDesktop\files\.lego\logs\cli.log
This log file (and maybe the other log files in the same folder) should help our support team to investigate and to better understand the issue.
If you want to restore a previously used certificate, go to the folder:
C:\Program Files (x86)\Bsoft App\Clients\webserv
It will contain every “cert.jks” files used. These are the “key store” files and we never delete them, we only rename them with the date and time of their disabling.
- Error 801: Free Certificate Manager was not able to register your Let’s Encrypt account. Check your Internet connection. Check that your email is not already registered at Let’s Encrypt. Try again with another email.
- Error 802 & Error 803: Free Certificate Manager could not retrieve Let’s Encrypt Terms Of Service URL address. This is a non blocking error: you can still continue and accept Let’s Encrypt Terms Of Service – be sure to read them from your browser first of course.
- Error 804: Free Certificate Manager was not able to validate your agreement to Let’s Encrypt Terms Of Service with Let’s Encrypt servers. Check you Internet connection. Try again.
- Error 805 & Error 806: Free Certificate Manager was not able to validate that you own the domain you entered during certificate creation (Error 805) or certificate renewal (Error 806). Check again all the prerequisites. Check your Internet connection. Check that your web server is listening on port 80. Check that you do not use a third-party web server such as IIS or Apache. Check that your domain name is accessible from the public Internet.