diff options
| author | Jacob Hoffman-Andrews <github@hoffman-andrews.com> | 2017-03-17 23:17:08 +0300 |
|---|---|---|
| committer | Peter Eckersley <pde@users.noreply.github.com> | 2017-03-17 23:17:08 +0300 |
| commit | b23a1377e04a7f53269bb36e008a3cf495d2853f (patch) | |
| tree | 54db9dd414765a5b37c95c26600fb92405b90a27 /docs | |
| parent | 672f206309df2e3be8d5fb37b47116bd948a6f78 (diff) | |
Clarify documentation for low-memory machines. (#4305)
* Clarify documentation for low-memory machines.
* Restore py26/py27 requirement.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/install.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/install.rst b/docs/install.rst index 548c8f2a3..e1ec06f16 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -22,9 +22,8 @@ your system. System Requirements =================== -The Let's Encrypt Client presently only runs on Unix-ish OSes that include -Python 2.6 or 2.7; Python 3.x support will hopefully be added in the future. The -client requires root access in order to write to ``/etc/letsencrypt``, +Certbot currently requires Python 2.6 or 2.7. By default, it requires root +access in order to write to ``/etc/letsencrypt``, ``/var/log/letsencrypt``, ``/var/lib/letsencrypt``; to bind to ports 80 and 443 (if you use the ``standalone`` plugin) and to read and modify webserver configurations (if you use the ``apache`` or ``nginx`` plugins). If none of @@ -33,11 +32,16 @@ but for most users who want to avoid running an ACME client as root, either `letsencrypt-nosudo <https://github.com/diafygi/letsencrypt-nosudo>`_ or `simp_le <https://github.com/kuba/simp_le>`_ are more appropriate choices. -The Apache plugin currently requires OS with augeas version 1.0; currently `it +The Apache plugin currently requires an OS with augeas version 1.0; currently `it supports <https://github.com/certbot/certbot/blob/master/certbot-apache/certbot_apache/constants.py>`_ modern OSes based on Debian, Fedora, SUSE, Gentoo and Darwin. +Installing with ``certbot-auto`` requires 512MB of RAM in order to build some +of the dependencies. Installing from pre-built OS packages avoids this +requirement. You can also temporarily set a swap file. See "Problems with +Python virtual environment" below for details. + Alternate installation methods ================================ @@ -76,7 +80,7 @@ For full command line help, you can type:: Problems with Python virtual environment ---------------------------------------- -On a low memory system such as VPS with only 256MB of RAM, the required dependencies of Certbot will failed to build. +On a low memory system such as VPS with less than 512MB of RAM, the required dependencies of Certbot will failed to build. This can be identified if the pip outputs contains something like ``internal compiler error: Killed (program cc1)``. You can workaround this restriction by creating a temporary swapfile:: |