mirror of
https://github.com/certbot/certbot.git
synced 2026-07-27 16:30:31 +02:00
Merge pull request #3294 from certbot/docs-structure
New docs structure and introduction
This commit is contained in:
+25
-1
@@ -5,6 +5,25 @@ User Guide
|
||||
.. contents:: Table of Contents
|
||||
:local:
|
||||
|
||||
|
||||
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``,
|
||||
``/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
|
||||
these apply to you, it is theoretically possible to run without root privileges,
|
||||
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 a Debian-based OS with augeas version
|
||||
1.0; this includes Ubuntu 12.04+ and Debian 7+.
|
||||
|
||||
|
||||
Getting Certbot
|
||||
===============
|
||||
|
||||
@@ -13,7 +32,7 @@ visit certbot.eff.org_. This is the easiest way to learn how to get
|
||||
Certbot up and running on your system.
|
||||
|
||||
If you're offline, you can find some general
|
||||
instructions `in the README / Introduction <intro.html#installation>`__
|
||||
instructions under `Quick Installation <install.html>`__.
|
||||
|
||||
__ installation_
|
||||
.. _certbot.eff.org: https://certbot.eff.org
|
||||
@@ -564,3 +583,8 @@ Beyond the methods discussed here, other methods may be possible, such as
|
||||
installing Certbot directly with pip from PyPI or downloading a ZIP
|
||||
archive from GitHub may be technically possible but are not presently
|
||||
recommended or supported.
|
||||
|
||||
.. include:: ../README.rst
|
||||
:start-after: tag:features-begin
|
||||
:end-before: tag:features-end
|
||||
.. include:: ../CHANGES.rst
|
||||
|
||||
Reference in New Issue
Block a user