You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

114 lines
3.3 KiB

9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
  1. # le
  2. Simplest shell script for LetsEncrypt free Certificate client
  3. Pure written in bash, no dependencies to python , acme-tiny or LetsEncrypt official client (https://github.com/letsencrypt/letsencrypt)
  4. Just one script, to issue, renew your certificates automatically.
  5. This is a shell version from https://github.com/diafygi/acme-tiny, but without any dependencies.
  6. Probably it's the smallest&easiest&smartest shell script to automatically issue&renew the free certificates from LetsEncrypt.
  7. #Supported OS
  8. 1. Ubuntu/Debian.
  9. 2. CentOS
  10. #Supported Mode
  11. 1. Webroot mode
  12. 2. Standalone mode
  13. 3. Apache mode
  14. #How to use
  15. 1. Clone this project: https://github.com/Neilpang/le.git
  16. 2. Install le:
  17. ```
  18. ./le.sh install
  19. ```
  20. Which does 3 jobs:
  21. * create and copy `le.sh` to your home dir: `~/.le`
  22. All the certs will be placed in this folder.
  23. * create symbol link: `/bin/le -> ~/.le/le.sh`
  24. * create everyday cron job to check and renew the cert if needed.
  25. Ok, you are ready to issue cert now.
  26. Show help message:
  27. ```
  28. root@xvm:~# le
  29. Usage: issue|renew|renewAll|createAccountKey|createDomainKey|createCSR|install|uninstall
  30. root@xvm:~# le issue
  31. Usage: le issue webroot|no|apache a.com [www.a.com,b.com,c.com]|no [key-length]|no [cert-file-path]|no [key-file-path]|no [ca-cert-file-path]|no [reloadCmd]|no
  32. ```
  33. You can set "no" to the param to use default value.
  34. # Just issue a cert:
  35. ```
  36. le issue /home/wwwroot/aa.com aa.com www.aa.com,cp.aa.com
  37. ```
  38. First argument `/home/wwwroot/aa.com` is the web root folder, You must have `write` access to this folder.
  39. Second argument "aa.com" is the main domain you want to issue cert for.
  40. Third argument is the additional domain list you want to use. Comma separated list, which is Optional.
  41. You must point and bind all the domains to the same webroot dir:`/home/wwwroot/aa.com`
  42. The cert will be placed in `~/.le/aa.com/`
  43. The issued cert will be renewed every 50 days automatically.
  44. # Issue a cert, and install to apache/nginx
  45. ```
  46. le issue /home/wwwroot/aa.com aa.com www.aa.com,cp.aa.com 2048 /path/to/certfile/in/apache/nginx /path/to/keyfile/in/apache/nginx /path/to/ca/certfile/apahce/nginx "service apache2/nginx reload"
  47. ```
  48. Which issues the cert and then links it to the production apache or nginx path.
  49. The cert will be renewed every 50 days by default (which is configurable), Once the cert is renewed, the apache/nginx will be automatically reloaded by the command: ` service apache2 reload` or `service nginx reload`
  50. # Use Standalone server:
  51. Same usage as all above, just give `no` as the webroot.
  52. The tcp `80` port must be free to listen, otherwise you will be prompted to free the `80` port and try again.
  53. ```
  54. le issue no aa.com www.aa.com,cp.aa.com
  55. ```
  56. # Use Apache mode:
  57. If you are running a web server, apache or nginx, it its recommended to use the Webroot mode.
  58. Particularly, if you are running an apache server, you can use apache mode instead. Which doesn't write any file to your web root folder.
  59. Just set string "apache" to the first argument, it will use apache plugin automatically.
  60. ```
  61. le issue apache aa.com www.aa.com
  62. ```
  63. All the other arguments are the same with previous.
  64. #Under the Hood
  65. Speak ACME language with bash directly to Let's encrypt.
  66. TODO:
  67. #License & Other
  68. License is GPLv3
  69. Please Star and Fork me.
  70. Issues and pullrequests are welcomed.