1  ==============================
 2  Using the Let's Encrypt client
 3  ==============================
 4  
 5  
 6  Getting the code
 7  ================
 8  
 9  Please `install Git`_ and run the following commands:
10  
11  .. code-block:: shell
12  
13     git clone https://github.com/letsencrypt/letsencrypt
14     cd letsencrypt
15  
16  Alternatively you could `download the ZIP archive`_ and extract the
17  snapshot of our repository, but it's strongly recommended to use the
18  above method instead.
19  
20  .. _`install Git`: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
21  .. _`download the ZIP archive`:
22     https://github.com/letsencrypt/letsencrypt/archive/master.zip
23  
24  
25  Installation and Usage
26  ======================
27  
28  To install and run the client you just need to type:
29  
30  .. code-block:: shell
31  
32     ./letsencrypt-auto
33  
34  (Once letsencrypt is packaged by distributions, the command will just be
35  ``letsencrypt``.  ``letsencrypt-auto`` is a wrapper which installs virtualized
36  dependencies and provides automated updates during the beta program)
37  
38  .. warning:: Please do **not** use ``python setup.py install`` or ``sudo pip install`.
39               Those mode of operation might corrupt your operating system and is
40               **not supported** by the Let's Encrypt team!
41  
42  The ``letsencrypt`` commandline tool has a builtin help:
43  
44  .. code-block:: shell
45  
46     ./letsencrypt-auto --help
47  
48  
49  Configuration file
50  ------------------
51  
52  It is possible to specify configuration file with
53  ``letsencrypt-auto --config cli.ini`` (or shorter ``-c cli.ini``). For
54  instance, if you are a contributor, you might find the following
55  handy:
56  
57  .. include:: ../examples/dev-cli.ini
58     :code: ini
59  
60  By default, the following locations are searched:
61  
62  - ``/etc/letsencrypt/cli.ini``
63  - ``$XDG_CONFIG_HOME/letsencrypt/cli.ini`` (or
64    ``~/.config/letsencrypt/cli.ini`` if ``$XDG_CONFIG_HOME`` is not
65    set).
66  
67  .. keep it up to date with constants.py
68  
69  
70  Running with Docker
71  ===================
72  
73  Docker_ is another way to quickly obtain testing certs. From the
74  server that the domain your requesting a cert for resolves to,
75  `install Docker`_, issue the following command:
76  
77  .. code-block:: shell
78  
79     sudo docker run -it --rm -p 443:443 --name letsencrypt \
80                 -v "/etc/letsencrypt:/etc/letsencrypt" \
81                 -v "/var/lib/letsencrypt:/var/lib/letsencrypt" \
82                 quay.io/letsencrypt/letsencrypt:latest auth
83  
84  and follow the instructions. Your new cert will be available in
85  ``/etc/letsencrypt/certs``.
86  
87  .. _Docker: https://docker.com
88  .. _`install Docker`: https://docs.docker.com/userguide/