1,574
edits
Changes
From SME Server
Jump to navigationJump to search
mLine 1:
Line 1: − + + + + + + + + + + + + + + + + + + + + + + + + + Line 27:
Line 51: − − === Version === − {{#smeversion:smeserver-letsencrypt }} − <br> − {{#smeversion:dehydrated }} − <br> Line 59:
Line 77: − + + + + + + + + + + − + + − + − Your server will report available updates from the smecontribs repository as they are available. If you have previously installed smeserver-letsencrypt from the reetp repository, you will need to make sure that you've set the ACCEPT_TERMS configuration property:+ − + − config setprop letsencrypt ACCEPT_TERMS yes − Line 77:
Line 103: − + + + + + + − It is important to do the usual+ − signal-event post-upgrade; signal-event reboot+ − otherwise+ + + + + + + + + + + + + + + + + + + + + + − failure to do this might leave the contribution not working and your certificates not renewed.+ + + + + + + + + + + − + − There are several configuration database entries that need to be made in order to set up this contrib. Most of them tell the scripts which hostnames need to be part of your certificate. Line 98:
Line 159: − : www.domain1.com+ − : mail.domain1.com+ − : ftp.domain1.com+ + − : www.domain2.com+ − : mail.domain2.com+ − Line 130:
Line 191: − + − − ====Other configuration properties==== − No other settings are mandatory. However, it's recommended to configure an email address. If there should be a problem with renewing your certificate, and it comes close to expiring, the Let's Encrypt servers will notify you of this. Do so with this command: − config setprop letsencrypt email admin@domain1.com − − The email domain specified here doesn't need to match any of the domains you're obtaining a cert for. − − You can also set the length of your certificate's private key, if you don't want the default of 4096 bits. This should not be necessary in most cases, but if desired, use this command to do so: − config setprop letsencrypt keysize NUMBER − − ===Accept Let's Encrypt terms === − Please first read the condition terms for using Let's Encrypt [[https://letsencrypt.org/documents/LE-SA-v1.1.1-August-1-2016.pdf]] − config setprop letsencrypt ACCEPT_TERMS yes − − {{Note box|Creation of a new certificate requires the API being set to V2, see warning box above}} − − ===V2 API=== − With the latest version of letsencrypt/dehydrated the V2 API is needed to create new certificates, V1 is depreciated for creation of new certificates however is still valid for existing certificates created with it. − − The key is called API. It will default to '1' if left unset. Options are '1', '2', 'auto' − − For updating current V1 certificates leave as default or set to 1, auto − − # config show letsencrypt − letsencrypt=service − ACCEPT_TERMS=yes − configure=none − email=####@#####.### − hookScript=disabled − status=enabled − − # config setprop letsencrypt API 1 − # signal-event console-save − − # config show letsencrypt − letsencrypt=service − ACCEPT_TERMS=yes − API=1 − configure=none − email=####@#####.### − hookScript=disabled − status=enabled − − For creating a new certificate or updating a V2 set to 2 − # config setprop letsencrypt API 2 + − # signal-event console-save+ − − # config show letsencrypt − letsencrypt=service − ACCEPT_TERMS=yes − API=2 − configure=none − email=####@#####.### − hookScript=disabled − status=enabled − − − The next step is to enable test mode. This will obtain certificates from the staging server. The rate limits discussed in the introduction won't apply, so any errors or other issues won't prevent you from obtaining your production certificate. Enable test mode using this command: Line 202:
Line 207: − + Line 217:
Line 222: − + Line 223:
Line 228: − + − for the test ('''adjust the domains and hosts'''):+ − config setprop letsencrypt ACCEPT_TERMS yes status test API 2+ − #foreach of your domains you want SSL do the following+ − db domains setprop '''domain1.com''' letsencryptSSLcert enabled+ − #foreach of your hosts (subdomains) you want SSL do the following+ − db hosts setprop '''www.domain1.com''' letsencryptSSLcert enabled+ − signal-event console-save+ − dehydrated -c+ − + − Check that the certificates are available ( your browser will still issue an error, but you can explore the content of the certificate to see that the Let's Encrypt test CA was used to sign your SSL certificate and that all your domains and hosts are in the "Certificate Subject Alt Name" property.+ − + − for the production ('''adjust your email'''):+ − config setprop letsencrypt status enabled email '''admin@domain1.com'''+ − signal-event console-save+ − dehydrated -c -x+ − + − ==Manual Installation of Dehydrated==+ − {{warning box| the following is not to be executed if you have installed the smeserver-letsencrypt contrib rpm as it is already handled by the contrib}}+ − As discussed above, dehydrated is a lightweight ACME client that's implemented as a BASH script. It has very few dependencies, and is a better fit for the "SME way" of doing things than the official certbot client. If you'd prefer to configure it manually, rather than installing the contrib described above, you may do so manually or by pulling a copy of the latest version using git.+ − + − ===Install of Dehydrated rpm from smecontrib repository===+ − The dehydrated script has been imported into the contribs repository and can be installed as follows:+ − + − yum --enablerepo=smecontribs install dehydrated+ − + − The script must be configured as described below.+ − + − ===Git install of latest version===+ − + − If you need or want the absolute latest version of the script then you can manually install as follows:+ − + − Begin by installing git:+ − yum install git+ − + − Then download the Dehydrated client:+ − cd /etc+ − git clone https://github.com/lukas2511/dehydrated+ − mv dehydrated/dehydrated /usr/local/bin/+ − + − ===Manual Configuration of Dehydrated===+ − + − You'll need to create two configuration files for Dehydrated.+ − cd /etc/dehydrated+ − mkdir -p /home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge+ − nano -w domains.txt+ − + − In this file, you'll list every hostname that you want your certificate to cover, all on one line. It will look like this:+ − domain1.com www.domain1.com mail.domain1.com domain2.net www.domain2.net domain3.org ftp.domain3.org+ − Ctrl-X to exit, Y to save. − − Second, you'll need to create the configuration file '''config''': − nano -w config − − It should look like this: − #!/bin/bash − # config − # CA="https://acme-staging.api.letsencrypt.org/directory" − WELLKNOWN="/home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge" − HOOK="/usr/local/bin/dehydrated-hook" − # E-mail to use during the registration (default: <unset>) − CONTACT_EMAIL="admin@yourdomain.com" − − Ctrl-X to exit, Y to save. − − For testing purposes, it's recommended that you uncomment the third line (so it begins with "CA="). Any certificates issued while testing will not be trusted, but they will also not count against your rate limits. Once your configuration is set, you can comment out that line and re-run dehydrated. − − You'll need to create a custom "hook" script to set the config database up properly, and to trigger reloads of your system services when a certificate is issued or renewed. − nano /usr/local/bin/dehydrated-hook − − Its contents should look like this: − #!/bin/bash − − if [ $1 = "deploy_cert" ]; then − KEY=$3 − CERT=$4 − CHAIN=$6 − /sbin/e-smith/db configuration setprop modSSL key $KEY − /sbin/e-smith/db configuration setprop modSSL crt $CERT − /sbin/e-smith/db configuration setprop modSSL CertificateChainFile $CHAIN − /sbin/e-smith/signal-event ssl-update − fi − − Ctrl-X to exit, Y to save. Then make it executable: − chmod +x /usr/local/bin/dehydrated-hook − − You'll also need to create a custom template fragment for Apache: − mkdir -p /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf − nano -w /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf/VirtualHosts40ACME − − The contents of that file should look like: − # Alias for letsencrypt − Alias /.well-known/acme-challenge /home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge − Again, Ctrl-X to exit, Y to save. − − Expand the template and restart apache: − expand-template /etc/httpd/conf/httpd.conf − service httpd-e-smith restart − − Now you're ready to run dehydrated and get your certificate. − dehydrated -c − − The script will run for a moment and should report success. If it does, look in /etc/dehydrated/certs/YOURDOMAIN and see if you have your files there. You should see a number of .pem files, at least one .csr file, and five symbolic links (chain.pem, cert.csr, cert.pem, fullchain.pem, and privkey.pem). If you do, congratulations! You've successfully obtained your certificate. The hook script should have also configured your server to use the new certificate. To make sure, run − config show modSSL − and make sure there are values set for crt, key, and CertificateChainFile. − − If dehydrated ran successfully in test mode, comment out the CA= line in /etc/dehydrated/config and run − dehydrated -c -x − − to obtain trusted a trusted certificate. − − ===Renewal=== − When run, the dehydrated script will check your existing certificate to see how long it's valid. If it has less than 30 days' lifetime remaining (by default; this can be changed by setting RENEW_DAYS in config to something other than 30), the script will renew your certificates. If more than 30 days remain, the script will exit without further action. All that's necessary is to run dehydrated daily: − nano -w /etc/cron.daily/call-dehydrated − − Enter the following in this file: − #!/bin/bash − /usr/bin/dehydrated -c − Ctrl-X to exit, Y to save. Then make it executable: − chmod +x /etc/cron.daily/call-dehydrated − − {{warning box| end of the manual installation and configuration of dehydrated without smeserver-letsencrypt contrib}} − − ==Requiring SSL== − Whether you used the contrib, or configured dehydrated manually, you'll probably want to configure your server to force secure web connections. For any i-bays, you can do this using the server-manager page, or using a shell command. For the Primary i-bay, you'll need to use the shell command: − db accounts setprop {accountname} SSL enabled − or − db accounts setprop Primary SSL enabled − − ==Backup== − Your certificate, private key, and other important information are stored in /etc/dehydrated, which is not included in the standard SME Server backup routines. Make sure to add this directory to your backups. See, e.g., [[Backup with dar#Adding_Files_and_Directories|Backup with dar]] if you're using the workstation backup feature. If using Affa for backup, add − Include=/etc/dehydrated − − to the Affa configuration file. − ===Certificate Errors===+ − Errors in the certificate files may prevent Apache and some other services from starting. If you previously had custom settings for modSSL, revert those with: − config setprop modSSL crt (old value) − config setprop modSSL key (old value) − config setprop modSSL CertificateChainFile (old value--if this property was empty, delete it using the command line below) − − If you did not have custom settings for modSSL, remove your changes with: − config delprop modSSL crt − config delprop modSSL key − config delprop modSSL CertificateChainFile − − Once you've made these changes, do: − signal-event post-upgrade − signal-event reboot − − ===Authorization Errors=== − The first thing is to check all your domains can resolve − − http://my.domain/.well-known/acme-challenge − − Check that the following files are correctly generated − − /etc/dehydrated/config − /etc/dehydrated/domains.txt − − Set letsencrypt back to test and remove any generated keys − − db configuration setprop letsencrypt status test − − rm /etc/dehydrated/certs/* -rf − rm /etc/dehydrated/accounts/* -rf − − Then run letsencrypt again − − dehydrated -c − − To restore the original certificates: − − config delprop modSSL CertificateChainFile − config delprop modSSL crt − config delprop modSSL key − − signal-event console-save − − ===Errors=== − − − ====No registration exists matching provided key==== − − − If you see the following: − − {"type":"urn:acme:error:unauthorized","detail":"No registration exists matching provided key","status":403} − − https://github.com/lukas2511/letsencrypt.sh/issues/2 − − See above for removing private keys and regenerating − ====rateLimited, Too many currently pending Authorizations====+ − + − If you see something like this you may have hit the rate limit: − − {"type":"urn:acme:error:rateLimited","detail":"Error creating new authz :: Too many currently pending authorizations.","status":429} − − https://github.com/lukas2511/letsencrypt.sh/blob/master/docs/staging.md − − https://letsencrypt.org/docs/rate-limits/ − − ====Some challenges complete successfully but some hostnames fail==== − − If you see some of your challenges returned without error but some fail, you possibly do not have Public DNS A or MX records for all the host names that you are adding to your certificate. − − Using the command: − config setprop letsencrypt configure all − − Is likely to cause this error. When a domain is added to an SME server, several host names are created automatically. these include ftp.your-domain.com, wpad.your-domain.com, proxy.your-domain.com, mail.your-domain.com, www.your-domain.com. Most of us do not create public DNS records for all these host names. When letsencrypt issues a challenge for a list of host names and '''ONE''' does not resolve, the challenge will fail and the certificate will not generate at all. − − To resolve this, issue the following command: − config setprop letsencrypt configure none − − Then follow up with the commands to enable letsencrypt for each PUBLIC resolvable domain and hostname: − db domains setprop domain1.com letsencryptSSLcert enabled − and for each hostname: − db hosts setprop www.domain1.com letsencryptSSLcert enabled − − db hosts setprop mail.domain1.com letsencryptSSLcert enabled − until all the public facing hostnames are enabled − followed by: − signal-event console-save − − Thanks to MSmith for the following forum thread. − − https://forums.contribs.org/index.php/topic,53052.0.html − − ====Challenge fails with unauthorized 403 error==== − − If your challenge returns something like the following: − ERROR: Challenge is invalid! (returned: invalid) (result: { − "type": "http-01", − "status": "invalid", − "error": { − "type": "urn:acme:error:unauthorized", − "detail": "Invalid response from http://www.your-domain.com/.well-known/acme-challenge/<redacted text> − "status": 403 − and your ''httpd error_log'' on your server shows something like this: − (13)Permission denied: access to /.well-known/acme-challenge/<redacted> denied − (13)Permission denied: access to /.well-known/acme-challenge/<redacted> denied − (13)Permission denied: access to /.well-known/acme-challenge/<redacted> denied − − You need to check the ownership and rights on ''/home/e-smith/files/ibays/Primary'' and on ''/home/e-smith/files/ibays/Primary/html''. The contrib creates a hidden working directory at ''/home/e-smith/files/ibays/Primary/html/.well-known'' and inside that directory a second directory with the following path ''/home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge''. The script creates the two new directories with the correct ownerships and rights, however, if the ownership and rights on the ibay and the html directory do not allow the script to access the new location, the challenge will fail with ''access denied'' − − use the following to check the rights: − cd /home/e-smith/files/ibays − then − ls -l − on my test server with only the Primary ibay I get the following (you will probably show a bunch more ibays on your server but we are only concerned with Primary): − total 4 − drwxr-xr-x 5 root root 4096 Jul 25 2016 Primary − − If this is not what you see, you need to correct it. − − '''THIS MAY BREAK NON STANDARD CUSTOMIZATION OF YOUR SERVER, YOU NEED TO UNDERSTAND WHY THIS HAS BEEN CHANGED BEFORE YOU REVERSE IT''' − − From within ''/home/e-smith/files/ibays/'' issue the following: − chown root:root Primary − If the rights are not correct, issue: − chmod 0755 Primary − − Next check the html directory. − cd /home/e-smith/files/ibays/Primary − then − ls -l − on my test server I have the following − [root@backupserver Primary]# ls -l − total 12 − drwxr-s--- 2 admin shared 4096 Jul 25 2016 cgi-bin − drwxr-s--- 2 admin shared 4096 Jul 25 2016 files − '''drwxr-s--- 3 admin shared 4096 Jun 11 08:06 html''' − − If this is not what you see, − − '''FIRST READ ABOVE WARNING''' − − then adjust as follows − chown admin:shared html − If the rights are not correct, issue: − chmod 2750 html − − rerun − dehydrated -c − − and your challenges should complete. − − https://forums.contribs.org/index.php/topic,53147.0.html − − − ===Obtaining certificates for other servers=== − The dehydrated client can be used to obtain certificates for other servers on your network, if the hostnames resolve (from outside your network) to your SME Server. Here's how to do this using the smeserver-letsencrypt contrib. − − ====Hosts and Domains==== − {{Note box| This section is not necessary as far as I am aware. You should just be able to set a host with "HostType local" and an InternalIP address as letsencryptSSLcert enabled and then regenerate domains.txt}} − − You'll need to create two template fragments: one to add your hostname to /etc/dehydrated/domains.txt, and the second to handle the certificate once it's generated. To create the first, do − − mkdir -p /etc/e-smith/templates-custom/etc/dehydrated/domains.txt − nano -w /etc/e-smith/templates-custom/etc/dehydrated/domains.txt/15Hostname − − You can replace "Hostname" in "15Hostname" with something that's descriptive of the host you're obtaining a certificate for. If you want more than one additional certificate, create separate fragments for each one. In the file, just enter the fully-qualified domain name of the system: − − hostname.domain.tld − − Then Ctrl-X to exit, Y to save. − − ====Hook Script deployment==== − − The second template fragment will be a portion of the hook script, so the dehydrated client knows what to do with this certificate. This must be present, otherwise dehydrated will configure your SME server to use this certificate rather than the certificate for the SME Server. − − mkdir -p /etc/e-smith/templates-custom/usr/bin/hook-script.sh/ − nano -w 05deploy_cert_hostname − − As above, replace "hostname" with something that describes the host that this script will apply to. The numeric portion can be changed, but MUST be less than 10. − − At a minimum, this fragment will need to recognize that it's being called for a certificate other than the main server certificate, and exit in order to prevent later portions of the script from installing that certificate as the main server certificate. The minimal form of this fragment would be: − − { − use strict; − use warnings; − use esmith::ConfigDB; − − my $configDB = esmith::ConfigDB->open_ro or die("can't open Config DB"); − − my $letsencryptStatus = $configDB->get_prop( 'letsencrypt', 'status' ) || 'disabled'; − − if ( $letsencryptStatus ne 'disabled' ) { − − $OUT .=<<'_EOF'; − if [ $1 = "deploy_cert" ] && [ $2 = "hostname.domain.tld" ]; then − echo "$2 certificate renewed" | mail -s "Certificate renewal" admin@yourdomain.com − exit 0 − fi − _EOF − − } − } − − Depending on the characteristics of the other system, though, this script may be able to install the certificate on that system. The following fragment would copy the certificate files to a remote Linux system running Apache for the web server, and reload Apache to get it to begin using the new certificate: − − { − use strict; − use warnings; − use esmith::ConfigDB; − − my $configDB = esmith::ConfigDB->open_ro or die("can't open Config DB"); − − my $letsencryptStatus = $configDB->get_prop( 'letsencrypt', 'status' ) || 'disabled'; − − if ( $letsencryptStatus ne 'disabled' ) { − − $OUT .=<<'_EOF'; − if [ $1 = "deploy_cert" ] && [ $2 = "hostname.domain.tld" ]; then − KEY=$3 − CERT=$4 − CHAIN=$6 − scp $CERT root@hostname:/etc/pki/tls/certs/pbx.familybrown.org.crt − scp $KEY root@hostname:/etc/pki/tls/private/pbx.familybrown.org.key − scp $CHAIN root@hostname:/etc/pki/tls/certs/server-chain.crt − ssh root@pbx "/sbin/service httpd reload" − echo "$2 certificate renewed" | mail -s "Certificate renewal" admin@domain.tld − exit 0 − fi − _EOF − − } − } − − The following fragment would install the new certificate on a Proxmox VE host: − − { − use strict; − use warnings; − use esmith::ConfigDB; − − my $configDB = esmith::ConfigDB->open_ro or die("can't open Config DB"); − − my $letsencryptStatus = $configDB->get_prop( 'letsencrypt', 'status' ) || 'disabled'; − − if ( $letsencryptStatus ne 'disabled' ) { − − $OUT .=<<'_EOF'; − if [ $1 = "deploy_cert" ] && [ $2 = "pve.domain.tld" ]; then − KEY=$3 − CHAIN=$5 − scp $KEY root@pve:/etc/pve/nodes/pve/pveproxy-ssl.key − scp $CHAIN root@pve:/etc/pve/nodes/pve/pveproxy-ssl.pem − ssh root@pve "systemctl restart pveproxy" − echo "$2 certificate renewed" | mail -s "Certificate renewal" admin@domain.tld − exit 0 − fi − _EOF − − } − } − − Once you've created the template fragments, expand the templates and run dehydrated to generate the certificates: − signal-event console-save − dehydrated -c − − These certificates will be automatically renewed, just like the main server certificate. − − ===Obtaining certificates for a private SME Server=== − As noted above in the prerequisites section, your SME Server must ordinarily be accessible from the Internet so that the Let's Encrypt servers can validate that you control it. However, if your SME Server is not accessible from the Internet, the smeserver-letsencrypt contrib provides a method that can be used to validate domain control. In order to use this method, the following conditions must be true: − * The hostname of your internal SME Server (example: internal.mydomain.tld) resolves, on the public Internet, to a valid IP address − * The host to which internal.mydomain.tld resolves (example: external.mydomain.tld) has a running web server on port 80 − * The root user from internal.mydomain.tld can connect to external.mydomain.tld via SSH without entering a password (i.e., you've set up SSH public key authentication) − − This method uses a simple script that's included in the smeserver-letsencrypt contrib, which requires that four database entries be set: − config setprop letsencrypt hookScript enabled − config setprop letsencrypt host '''external.mydomain.tld''' − config setprop letsencrypt user '''root''' − config setprop letsencrypt path '''/home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge''' − signal-event console-save − The parts in bold above should be changed to match your situation; the path variable should be the filesystem location that external.mydomain.tld serves as /.well-known/acme-challenge/ . When dehydrated creates the challenge file, it will transfer it via scp to user@host:path/, and then allow the Let's Encrypt server to validate. Once validation is accomplished, the script will remove the challenge file from user@host:path/ − + + + Line 649:
Line 293: − +
Add correct wiki page for Note re fail on All
{{Languages|Letsencrypt}}
{{Languages|Letsencrypt}}
{{Level|Medium}}
{{Level|Medium}}
==Introduction==
<!-- here we define the contrib name variable -->
<!-- we get the page title, remove suffix for translated version; if needed you can define there with the value you want-->
{{#vardefine:contribname| {{lc: {{#titleparts: {{BASEPAGENAME}} |1}} }} }}
{{#vardefine:smecontribname| smeserver-{{lc: {{#titleparts: {{BASEPAGENAME}} |1}} }} }}
<!-- we define the language -->
{{#vardefine:lang| {{lc: {{#titleparts: {{PAGENAME}} | | -1}} }} |en }}
{{Infobox contribs
|name={{#var:contribname}}
|image={{#var:contribname}}.jpg
|description_image= {{#var:contribname}} logo
|maintainer= John Crisp
|licence= MIT license
|url= https://github.com/dehydrated-io/dehydrated
|category= certificates
|tags=dehydrated,letsencrypt,dns,http,ssl
}}
==Maintainer==
John Crisp
== Version ==
{{#set: Version=Contrib10}}
{{#smeversion:smeserver-letsencrypt }}
<br>
==Description==
{{warning box| The original protocol used by Let’s Encrypt for certificate issuance and management is called ACMEv1. In March of 2018 Letsencrypt introduced support for ACMEv2, a newer version of the protocol that matches what was finalized today as RFC 8555 328. They have been encouraging subscribers to move to the ACMEv2 protocol.
{{warning box| The original protocol used by Let’s Encrypt for certificate issuance and management is called ACMEv1. In March of 2018 Letsencrypt introduced support for ACMEv2, a newer version of the protocol that matches what was finalized today as RFC 8555 328. They have been encouraging subscribers to move to the ACMEv2 protocol.
Multiple clients are available for the Letsencrypt services. The official "certbot" client from letsencrypt.org is quite full-featured, but has a number of dependencies that it needs to install. It also requires a newer version of Python than is included with a standard SME Server installation. Due to this complexity, and the lack of compatibility with SME 8.x, this document describes installation and use of ''[https://github.com/lukas2511/dehydrated dehydrated]'', an alternative client implemented as a BASH shell script.
Multiple clients are available for the Letsencrypt services. The official "certbot" client from letsencrypt.org is quite full-featured, but has a number of dependencies that it needs to install. It also requires a newer version of Python than is included with a standard SME Server installation. Due to this complexity, and the lack of compatibility with SME 8.x, this document describes installation and use of ''[https://github.com/lukas2511/dehydrated dehydrated]'', an alternative client implemented as a BASH shell script.
==Prerequisites==
==Prerequisites==
config show modSSL > "/root/db_configuration_modSSL_backup_$(date +%Y%m%d_%H%M%S)"
config show modSSL > "/root/db_configuration_modSSL_backup_$(date +%Y%m%d_%H%M%S)"
==Contrib Installation of Dehydrated==
==Installation of Dehydrated letsencrypt contrib==
John Crisp has prepared a contrib that installs the dehydrated script, creates the appropriate configuration files, and integrates with the SME templates system. This is the simplest way to install dehydrated on your SME Server.
John Crisp has prepared a contrib that installs the dehydrated script, creates the appropriate configuration files, and integrates with the SME templates system. This is the simplest way to install dehydrated on your SME Server.
<tabs container style="display: inline-block;"><tab name="For SME 10">
yum install smeserver-letsencrypt
You will then need to configure the domains and hosts for which you want to ask a certificate. See the following Configuration section.
If your smeaddons repo has been disabled add --enablerepo=smeaddons and reenable it, as it should be by default.
db yum_repositories setprop smeaddons status enabled
signal-event yum-modify
</tab><tab name="For SME 9">
===Installation===
===Installation===
yum install smeserver-letsencrypt --enablerepo=smecontribs
yum install smeserver-letsencrypt
signal-event console-save
You will then need to configure the domains and hosts for which you want to ask a certificate. See the following Configuration section.
You will then need to configure the domains and hosts for which you want to ask a certificate. See the following Configuration section.
===Updates===
If your smeaddons repo has been disabled add --enablerepo=smeaddons and reenable it, as it should be by default.
db yum_repositories setprop smeaddons status enabled
signal-event yum-modify
signal-event console-save
===Updating===
===Updating===
A full update can be done as follow :
A full update can be done as follow :
yum update smeserver-letsencrypt dehydrated --enablerepo=smecontribs
yum update smeserver-letsencrypt dehydrated
config setprop letsencrypt ACCEPT_TERMS yes
signal-event console-save
failure to do this might leave the contribution not working and your certificates not renewed.
</tab>
</tabs>
==Configuration==
There are several configuration database entries that need to be made in order to set up this contrib. Most of them tell the scripts which hostnames need to be part of your certificate.
=== Rush jobs ===
For the test ('''adjust the domains and hosts'''):
<tabs container style="display: inline-block;"><tab name="For SME 10">
config setprop letsencrypt ACCEPT_TERMS yes status test
# really fast job to enable the primary domain
db domains setprop $(config get DomainName) letsencryptSSLcert enabled
#foreach of your domains you want SSL do the following
db domains setprop '''domain1.com''' letsencryptSSLcert enabled
#foreach of your hosts (subdomains) you want SSL do the following
db hosts setprop '''www.domain1.com''' letsencryptSSLcert enabled
signal-event smeserver-letsencrypt-update
dehydrated -c
</tab><tab name="For SME 9">
config setprop letsencrypt ACCEPT_TERMS yes status test API 2
#foreach of your domains you want SSL do the following
db domains setprop '''domain1.com''' letsencryptSSLcert enabled
#foreach of your hosts (subdomains) you want SSL do the following
db hosts setprop '''www.domain1.com''' letsencryptSSLcert enabled
signal-event console-save
signal-event console-save
dehydrated -c
</tab>
</tabs>
Check that the certificates are available ( your browser will still issue an error, but you can explore the content of the certificate to see that the Let's Encrypt test CA was used to sign your SSL certificate and that all your domains and hosts are in the "Certificate Subject Alt Name" property.
For the production ('''adjust your email'''):
<tabs container style="display: inline-block;"><tab name="For SME 10">
config setprop letsencrypt status enabled email admin@$(config get DomainName)
signal-event smeserver-letsencrypt-update
dehydrated -c -x
</tab><tab name="For SME 9">
config setprop letsencrypt status enabled email '''admin@domain1.com'''
signal-event console-save
dehydrated -c -x
</tab>
</tabs>
===Configuration===
===Step by step configuration===
====Hosts and domains for the certificate====
====Hosts and domains for the certificate====
* domain1.com
* domain1.com
** www.domain1.com
** mail.domain1.com
** ftp.domain1.com
* domain2.com
* domain2.com
** www.domain2.com
** mail.domain2.com
For each DOMAIN that you want to be included in the certificate, run this command:
For each DOMAIN that you want to be included in the certificate, run this command:
db domains setprop $DOMAIN letsencryptSSLcert enabled
db domains setprop $DOMAIN letsencryptSSLcert enabled
With the system configuration described above, setting this to "domains" will obtain a certificate covering domain1.com and domain2.com, but not www.domain1.com, etc. Setting it to "hosts" will obtain a certificate covering www.domain1.com, mail.domain1.com, ftp.domain1.com, etc., but not domain1.com or domain2.com. Setting this property to "all" will include all domain names and hostnames in the certificate. '''see [[Letsencrypt#Some_challenges_complete_successfully_but_some_hostnames_fail|NOTE]] before setting this to "all"'''
With the system configuration described above, setting this to "domains" will obtain a certificate covering domain1.com and domain2.com, but not www.domain1.com, etc. Setting it to "hosts" will obtain a certificate covering www.domain1.com, mail.domain1.com, ftp.domain1.com, etc., but not domain1.com or domain2.com. Setting this property to "all" will include all domain names and hostnames in the certificate. '''See [[Letsencrypt/Troubleshooting#Some_challenges_complete_successfully_but_some_hostnames_fail|NOTE]] before setting this to "all".'''
==== Enable test mode ====
After installing and configuring all the domains and hosts, the next step is to use test mode, which is enabled by default. This will obtain certificates from the staging server. The rate limits discussed in the introduction won't apply, so any errors or other issues won't prevent you from obtaining your production certificate. Enable test mode using this command:
===Enable Test Mode===
config setprop letsencrypt status test
config setprop letsencrypt status test
signal-event console-save
signal-event console-save
If this runs without errors, try to connect to your server-manager page. You should see an error that the security certificate wasn't issued by a trusted certification authority; this is perfectly normal. However, there should be a certificate, it should include all the hostnames you wanted included, and it should be valid for the next ninety days. If this was successful, proceed to production.
If this runs without errors, try to connect to your server-manager page. You should see an error that the security certificate wasn't issued by a trusted certification authority; this is perfectly normal. However, there should be a certificate, it should include all the hostnames you wanted included, and it should be valid for the next ninety days. If this was successful, proceed to production.
===Enable Production Mode===
====Enable Production Mode====
Once you've successfully tested your installation, set it to production mode using these commands:
Once you've successfully tested your installation, set it to production mode using these commands:
Once you've obtained your certificate and configured your server, test your server with a tool like [https://www.ssllabs.com/ssltest/ SSLLabs.com] to make sure it's working properly.
Once you've obtained your certificate and configured your server, test your server with a tool like [https://www.ssllabs.com/ssltest/ SSLLabs.com] to make sure it's working properly.
===Archive old certificates===
====Archive old certificates====
A new function lets you cleanup old and archive old certificates.
A new function lets you cleanup old and archive old certificates.
dehydrated --cleanup (-gc)
dehydrated --cleanup (-gc)
===Rush jobs===
===Configuration properties===
{| class="wikitable"
!Key
!property
!default
!values
!
|-
| rowspan="10" |letsencrypt
|ACCEPT_TERMS
|
|empty, yes
|set to yes to accept terms of service, if left empty the contrib will not work.
|-
|API
|2
|1,2
|deprecated, will always be v2, as v1 is deprecated as per june 2021
|-
|configure
|none
|none,all,domains,hosts
|this will change the default behaviour on non explicitly domains or hosts with "letsencryptSSLcert enabled". By default will not be used, if hosts is set will ask a cert for all hosts, if domains is set will ask a cert for all domains, if all is set, will ask for both domains and hosts. In all situation it will ask a cert for domains/hosts where "letsencryptSSLcert enabled" is set and it is not set to "letsencryptSSLcert disabled"
|-
|email
|
|email
|enter the email to create account and receive updates from Let's Encrypt
|-
|hookScript
|disabled
|enabled,disabled
|will trigger advanced hook script if enabled, even if disabled the part to signal-event ssl-update to propagate the cert will run.
|-
|hostOverride
|disabled
|yes,disabled
|default disabled, if disabled will only ask cert for hosts (if selected according to configure and "letsencryptSSLcert enabled") for hosts with type=Self. If set to yes will include any listed hosts whether remote or local.
|-
|keysize
|4096
|base 2 number
|length of your certificate's private key, if you don't want the '''default of 4096''' bits. This should not be necessary in most cases, but if desired, use this command to do so:
|-
|status
|test
|enabled,disabled,test
|default status is disabled, '''First set it to test''' to connect to the test server of let's Encrypt to check if your server is well configured. After checking everything is ok, you can set it to enabled.
|}
== Troubleshooting ==
== Troubleshooting ==
see [[Letsencrypt/Troubleshooting]]
== Advanced Topics ==
see [[Letsencrypt/Advanced]]
==Advanced Topics==
= Bugs =
== Uninstall ==
yum remove {{#var:smecontribname}} {{#var:contribname}}
== Bugs ==
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
and select the smeserver-letsencrypt component or use {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-letsencrypt|title=this link}}
and select the smeserver-letsencrypt component or use {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-letsencrypt|title=this link}}
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=smeserver-letsencrypt |disablecache=1|noresultsmessage="No open bugs found."}}
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=smeserver-letsencrypt |disablecache=1|noresultsmessage="No open bugs found."}}
= Changelog =
== Changelog ==
Only released version in smecontrib are listed here.
Only released version in smecontrib are listed here.
