plugins:letsencrypt
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
plugins:letsencrypt [2016/11/23 16:29] nuxwin [Note for PanelRedirect plugin users] |
plugins:letsencrypt [2016/11/23 16:39] nuxwin [Manual execution of the certbot client] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== LetsEncrypt Plugin ====== | + | ===== LetsEncrypt Plugin ===== |
| <WRAP center round important 60%> | <WRAP center round important 60%> | ||
| Line 5: | Line 5: | ||
| </WRAP> | </WRAP> | ||
| - | ===== Introduction ===== | + | ==== Introduction ==== |
| This plugin provides free SSL certificates through the Let's Encrypt CA. | This plugin provides free SSL certificates through the Let's Encrypt CA. | ||
| - | ===== Requirements ===== | + | ==== Requirements ==== |
| * i-MSCP Serie 1.3.x (version >= 1.3.1 - Plugin API 1.0.5) | * i-MSCP Serie 1.3.x (version >= 1.3.1 - Plugin API 1.0.5) | ||
| - | ==== Debian / Ubuntu packages ==== | + | === Debian / Ubuntu packages === |
| * libarray-diff-perl | * libarray-diff-perl | ||
| Line 23: | Line 23: | ||
| # apt-get install -y libarray-diff-perl libconvert-asn1-perl libdatetime-format-strptime-perl | # apt-get install -y libarray-diff-perl libconvert-asn1-perl libdatetime-format-strptime-perl | ||
| - | ===== Installation ===== | + | ==== Installation ==== |
| - Be sure that all requirements as stated in the requirements section are met | - Be sure that all requirements as stated in the requirements section are met | ||
| - Upload the plugin through the plugin management interface | - Upload the plugin through the plugin management interface | ||
| Line 30: | Line 30: | ||
| Note that depending on your network connection and processor capacity, the installation can take up several minutes. | Note that depending on your network connection and processor capacity, the installation can take up several minutes. | ||
| - | ===== Update ===== | + | ==== Update ==== |
| - Be sure to read the update notes in the UPDATE.md file | - Be sure to read the update notes in the UPDATE.md file | ||
| Line 37: | Line 37: | ||
| - Update the plugin list through the plugin management interface | - Update the plugin list through the plugin management interface | ||
| - | ===== Plugin deactivation/uninstallation ===== | + | ==== Plugin deactivation/uninstallation ==== |
| When deactivating, or when uninstalling the plugin, the existents SSL certificate lineages are not removed. Also the database entries that belong to customer SSL certificates are keep in place. This means that any SSL certificate already issued will still be usable by the customer, even if the plugin has been deactivated or uninstalled. | When deactivating, or when uninstalling the plugin, the existents SSL certificate lineages are not removed. Also the database entries that belong to customer SSL certificates are keep in place. This means that any SSL certificate already issued will still be usable by the customer, even if the plugin has been deactivated or uninstalled. | ||
| Line 43: | Line 43: | ||
| According to the previous sentence, It must be noted that the current actions for SSL certificates that are displayed in the interface, at customer and administrator levels, do not predict the action that will actually take place. The real action to be performed will be automagically determined by the plugin at run time (backend side), by checking the state of the SSL certificate. In other words, the plugin is smart enough to not perform new SSL certificate issuance or renewal when that is not necessary. | According to the previous sentence, It must be noted that the current actions for SSL certificates that are displayed in the interface, at customer and administrator levels, do not predict the action that will actually take place. The real action to be performed will be automagically determined by the plugin at run time (backend side), by checking the state of the SSL certificate. In other words, the plugin is smart enough to not perform new SSL certificate issuance or renewal when that is not necessary. | ||
| - | ===== Manual execution of the certbot client ===== | + | ==== Manual execution of the certbot client ==== |
| - | You should avoid execute the Certbot client manually, or even through your own scripts, without knowing what your are doing. If you really want execute the `Certbot` client manually, you should at least reuse the email that is used by this plugin. You can find the email address in the /etc/imscp/imscp.conf file (DEFAULT_ADMIN_ADDRESS parameter). | + | You should avoid execute the Certbot client manually, or even through your own scripts, without knowing what your are doing. If you really want execute the Certbot client manually, you should at least reuse the email that is used by this plugin. You can find the email address in the /etc/imscp/imscp.conf file (**DEFAULT_ADMIN_ADDRESS** parameter). |
| Be aware that not support will be given if following a manual invocation of the Certbot client, one or many of your SSL lineages are in inconsistent states. | Be aware that not support will be given if following a manual invocation of the Certbot client, one or many of your SSL lineages are in inconsistent states. | ||
| - | ===== Certbot client version ===== | + | ==== Certbot client version ==== |
| It is possible to use latest released version or development version of the Certbot client by changing the value of the **certbot_version** configuration parameter in the plugin configuration file. Be aware that usage of the development version is discouraged in production environments. | It is possible to use latest released version or development version of the Certbot client by changing the value of the **certbot_version** configuration parameter in the plugin configuration file. Be aware that usage of the development version is discouraged in production environments. | ||
| - | ===== Let's Encrypt registration ===== | + | ==== Let's Encrypt registration ==== |
| The plugin automatically process your Let's Encrypt account registration, using the administrator email address that you have provided during i-MSCP setup phase. If you need change that email, you must not forget to run the following command to update your Let's Encrypt account: | The plugin automatically process your Let's Encrypt account registration, using the administrator email address that you have provided during i-MSCP setup phase. If you need change that email, you must not forget to run the following command to update your Let's Encrypt account: | ||
| Line 63: | Line 63: | ||
| If you don't do so, a new account will be created using the new email address and there will be inconsistencies with SSL certificate lineages, making the plugin unable to work properly. | If you don't do so, a new account will be created using the new email address and there will be inconsistencies with SSL certificate lineages, making the plugin unable to work properly. | ||
| - | ===== Let's Encrypt Rate Limits ===== | + | ==== Let's Encrypt Rate Limits ==== |
| Be sure to read https://letsencrypt.org/docs/rate-limits | Be sure to read https://letsencrypt.org/docs/rate-limits | ||
| Line 69: | Line 69: | ||
| Note that when the Let's Encrypt limits are reached, the plugin will automatically set the status of the SSL certificate to **pending**. The pending tasks are postponed as long as the limits are not released. | Note that when the Let's Encrypt limits are reached, the plugin will automatically set the status of the SSL certificate to **pending**. The pending tasks are postponed as long as the limits are not released. | ||
| - | ===== Let's Encrypt SSL certificates for the control panel and services (FTP, IMAP/POP and SMTP) ===== | + | ==== Let's Encrypt SSL certificates for the control panel and services (FTP, IMAP/POP and SMTP) ==== |
| To enable Let's Encrypt for the control panel and/or services you must in order: | To enable Let's Encrypt for the control panel and/or services you must in order: | ||
| Line 83: | Line 83: | ||
| Be aware that this feature is still experimental. | Be aware that this feature is still experimental. | ||
| - | ==== Regarding SSL certificate for the control panel ==== | + | === Regarding SSL certificate for the control panel === |
| Note that after enabling Let's Encrypt for the control panel, you may have to close and re-open your browser. Indeed, in some cases, the newly created SSL certificate is not loaded after a simple page refresh. | Note that after enabling Let's Encrypt for the control panel, you may have to close and re-open your browser. Indeed, in some cases, the newly created SSL certificate is not loaded after a simple page refresh. | ||
| - | ===== Note for PanelRedirect plugin users ===== | + | ==== Note for PanelRedirect plugin users ==== |
| If you use the PanelRedirect plugin, you must ensure that you have a version greater or equal to **1.1.5**, else, the domain validations will fail. | If you use the PanelRedirect plugin, you must ensure that you have a version greater or equal to **1.1.5**, else, the domain validations will fail. | ||
| - | ===== SANs for alternative URLs ===== | + | ==== SANs for alternative URLs ==== |
| - | You can enable support for alternative URLs by setting the `include_altnames` configuration parameter to`true` in the plugin configuration file. Once done, don't forget to trigger a plugin list update. | + | You can enable support for alternative URLs by setting the **include_altnames** configuration parameter to **true** in the plugin configuration file. Once done, don't forget to trigger a plugin list update. |
| Be aware that this parameters acts only for new SSL certificate issuances. | Be aware that this parameters acts only for new SSL certificate issuances. | ||
| - | ==== Warning regarding this feature ==== | + | === Warning regarding this feature === |
| - | Due to the current Let's Encrypt rate limits, it is not recommended to enable this feature. Indeed, each SSL certificate issuance for which a SAN is added for an alternative URL will hits the `Certificate per Registered Domain` limit (20 per week) for the control panel domain. This explain why this feature is turned off by default. | + | Due to the current Let's Encrypt rate limits, it is not recommended to enable this feature. Indeed, each SSL certificate issuance for which a SAN is added for an alternative URL will hits the **Per Registered Domain limit** (20 per week) for the control panel domain. This explain why this feature is turned off by default. |
| Note that alternative URLs as provided by i-MSCP are meant to allow the customers to access their domains for DNS propagation time. These URLs should not be exposed publicly. | Note that alternative URLs as provided by i-MSCP are meant to allow the customers to access their domains for DNS propagation time. These URLs should not be exposed publicly. | ||
| - | ===== Plugin translation ===== | + | ==== Plugin translation ==== |
| - | You can translate this plugin using a gettext translation editor such as poedit. Translation files are located under the ./l10n directory, inside of this plugin archive. Once translated you can send us your translation file (po file) for integration in future release. | + | You can translate this plugin using a gettext translation editor such as poedit. Translation files are located under the **./l10n** directory, inside of this plugin archive. Once translated you can send us your translation file (po file) for integration in future release. |
| - | Note that if no translation file exists for your localization in the ./l10n/po directory, you must create it first from the l10n/LetsEncrypt.pot file. Be aware that your file must be UTF-8, else, it won't be accepted. | + | Note that if no translation file exists for your localization in the **./l10n/po** directory, you must create it first from the **l10n/LetsEncrypt.pot** file. Be aware that your file must be UTF-8, else, it won't be accepted. |
| - | ===== License ===== | + | ==== License ==== |
| i-MSCP LetsEncrypt plugin | i-MSCP LetsEncrypt plugin | ||
| Line 121: | Line 121: | ||
| See the LICENSE file inside the archive for further details. | See the LICENSE file inside the archive for further details. | ||
| - | ===== Sponsors ===== | + | ==== Sponsors ==== |
| The development of this plugin has been sponsored by: | The development of this plugin has been sponsored by: | ||
| - | [IP-Projects GmbH & Co. KG](https://www.ip-projects.de/ "IP-Projects GmbH & Co. KG") | + | * [[https://www.ip-projects.de/|IP-Projects GmbH & Co. KG]] |
| - | ===== Authors ===== | + | ==== Authors ==== |
| * Laurent Declercq <[email protected]> | * Laurent Declercq <[email protected]> | ||
| * Ninos Ego <[email protected]> | * Ninos Ego <[email protected]> | ||
/var/www/virtual/i-mscp.net/wiki/htdocs/data/pages/plugins/letsencrypt.txt · Last modified: 2017/09/13 23:39 by nuxwin
