TBSCertBot - The Quick Start Guide
Prerequisite: TBSCertBot is compatible with php 5.4 to 7.x
Once your API user is created, launching TBSCertBot is only a matter of minutes? You'll find the essential steps to the tool installation and use below.
1 - Create an API user
Before using TBSCertBot an API user needs to be created.
Warning: TBSCertBot is available in a test and a production environment. You'll have to create an API user for each of the environment you want to work on.
To do so, log on to your Certificate Center (on the desired environment) and go to the "Administration" > "Users" section.
From this page you'll be able to create one (or several) API user.
Test environment:
open an account /
access the account
Production environment
open an account /
access the account
2 - Install TBSCertBot
First, download TBSCertBot.
Unzip the archive. A TBSCertBot repertory is create and the libraries required for the tool to work correctly are automatically updated.
# tar jxvf tbscertbot.tar.bz2
3 - TBSCertBot configuration
When TBSCertBot is installed, launch it. It check the existence of a configuration file. If it finds none, it will help you create one:
php tbscertbot.php The config file doesn't exist. Do you want create a new config file ? [Y/n]
You'll be asked for your API login and password and the server on which you want TBSCertBot to work on.
The configuration file
Before ordering a certificate you need to edit the configuration file to provide the default information regarding your orders to come: certificate kind, validity, organization, DCV method...
It is possible to order a cert without editing the configuration file but you then have to provide all the information in prompt mode.
4 - Order a certificate
TBSCertBot is now ready to be used. Ordering a certificate is quite simple:
# php tbscertbot.php order
Once the certificate is ordered, the TBS reference is displayed.
When the certificate is ready, launch the "download" command to download your product. By default the certificate and the certification chain are installed in the /data/certs/ repertory while the private key is stored in the /data/keys/ one.
5 - Hooks
Hooks allow you to associate scripts to the end of some operations, like orders, renewals and downloads.
In the following example, a hook is created to indicate a specific repertory for the certificate installation after its deliverance. The hook is executed after the "download" command.
First provide the path to the hook in the configuration file. Then create / modify the hook file to indicate the new installation directory for your certificate, certification chain and private key.