forked from certbot/certbot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
51 changed files
with
883 additions
and
497 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
.. This file contains of a series of comments that are used to include sections of this README in other files. Do not modify these comments unless you know what you are doing. tag:intro-begin | ||
.. This file contains a series of comments that are used to include sections of this README in other files. Do not modify these comments unless you know what you are doing. tag:intro-begin | ||
Certbot is part of EFF’s effort to encrypt the entire Internet. Secure communication over the Web relies on HTTPS, which requires the use of a digital certificate that lets browsers verify the identify of web servers (e.g., is that really google.com?). Web servers obtain their certificates from trusted third parties called certificate authorities (CAs). Certbot is an easy-to-use client that fetches a certificate from Let’s Encrypt—an open certificate authority launched by the EFF, Mozilla, and others—and deploys it to a web server. | ||
|
||
|
@@ -8,6 +8,134 @@ How you use Certbot depends on the configuration of your web server. The best wa | |
|
||
If you’re using a hosted service and don’t have direct access to your web server, you might not be able to use Certbot. Check with your hosting provider for documentation about uploading certificates or using certificates issues by Let’s Encrypt. | ||
|
||
Certbot is a fully-featured, extensible client for the Let's | ||
Encrypt CA (or any other CA that speaks the `ACME | ||
<https://github.com/ietf-wg-acme/acme/blob/master/draft-ietf-acme-acme.md>`_ | ||
protocol) that can automate the tasks of obtaining certificates and | ||
configuring webservers to use them. This client runs on Unix-based operating | ||
systems. | ||
|
||
Until May 2016, Certbot was named simply ``letsencrypt`` or ``letsencrypt-auto``, | ||
depending on install method. Instructions on the Internet, and some pieces of the | ||
software, may still refer to this older name. | ||
|
||
Contributing | ||
------------ | ||
|
||
If you'd like to contribute to this project please read `Developer Guide | ||
<https://certbot.eff.org/docs/contributing.html>`_. | ||
|
||
.. _installation: | ||
|
||
Installation | ||
------------ | ||
|
||
The easiest way to install Certbot is by visiting https://certbot.eff.org, where you can | ||
find the correct installation instructions for many web server and OS combinations. | ||
For more information, see the `User Guide <https://certbot.eff.org/docs/using.html#getting-certbot>`_. | ||
|
||
How to run the client | ||
--------------------- | ||
|
||
In many cases, you can just run ``certbot-auto`` or ``certbot``, and the | ||
client will guide you through the process of obtaining and installing certs | ||
interactively. | ||
|
||
For full command line help, you can type:: | ||
|
||
./certbot-auto --help all | ||
|
||
|
||
You can also tell it exactly what you want it to do from the command line. | ||
For instance, if you want to obtain a cert for ``example.com``, | ||
``www.example.com``, and ``other.example.net``, using the Apache plugin to both | ||
obtain and install the certs, you could do this:: | ||
|
||
./certbot-auto --apache -d example.com -d www.example.com -d other.example.net | ||
|
||
(The first time you run the command, it will make an account, and ask for an | ||
email and agreement to the Let's Encrypt Subscriber Agreement; you can | ||
automate those with ``--email`` and ``--agree-tos``) | ||
|
||
If you want to use a webserver that doesn't have full plugin support yet, you | ||
can still use "standalone" or "webroot" plugins to obtain a certificate:: | ||
|
||
./certbot-auto certonly --standalone --email [email protected] -d example.com -d www.example.com -d other.example.net | ||
|
||
|
||
Understanding the client in more depth | ||
-------------------------------------- | ||
|
||
To understand what the client is doing in detail, it's important to | ||
understand the way it uses plugins. Please see the `explanation of | ||
plugins <https://certbot.eff.org/docs/using.html#plugins>`_ in | ||
the User Guide. | ||
|
||
Links | ||
===== | ||
|
||
Documentation: https://certbot.eff.org/docs | ||
|
||
Software project: https://github.com/certbot/certbot | ||
|
||
Notes for developers: https://certbot.eff.org/docs/contributing.html | ||
|
||
Main Website: https://letsencrypt.org/ | ||
|
||
IRC Channel: #letsencrypt on `Freenode`_ or #certbot on `OFTC`_ | ||
|
||
Community: https://community.letsencrypt.org | ||
|
||
ACME spec: http://ietf-wg-acme.github.io/acme/ | ||
|
||
ACME working area in github: https://github.com/ietf-wg-acme/acme | ||
|
||
|
||
Mailing list: `client-dev`_ (to subscribe without a Google account, send an | ||
email to [email protected]) | ||
|
||
|build-status| |coverage| |docs| |container| | ||
|
||
|
||
|
||
.. |build-status| image:: https://travis-ci.org/certbot/certbot.svg?branch=master | ||
:target: https://travis-ci.org/certbot/certbot | ||
:alt: Travis CI status | ||
|
||
.. |coverage| image:: https://coveralls.io/repos/certbot/certbot/badge.svg?branch=master | ||
:target: https://coveralls.io/r/certbot/certbot | ||
:alt: Coverage status | ||
|
||
.. |docs| image:: https://readthedocs.org/projects/letsencrypt/badge/ | ||
:target: https://readthedocs.org/projects/letsencrypt/ | ||
:alt: Documentation status | ||
|
||
.. |container| image:: https://quay.io/repository/letsencrypt/letsencrypt/status | ||
:target: https://quay.io/repository/letsencrypt/letsencrypt | ||
:alt: Docker Repository on Quay.io | ||
|
||
.. _`installation instructions`: | ||
https://letsencrypt.readthedocs.org/en/latest/using.html#getting-certbot | ||
|
||
.. _watch demo video: https://www.youtube.com/watch?v=Gas_sSB-5SU | ||
|
||
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+. | ||
|
||
.. Do not modify this comment unless you know what you're doing. tag:intro-end | ||
.. Do not modify this comment unless you know what you're doing. tag:features-begin | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
FROM debian:jessie | ||
MAINTAINER Brad Warren <[email protected]> | ||
|
||
# no need to mkdir anything: | ||
# https://docs.docker.com/reference/builder/#copy | ||
# If <dest> doesn't exist, it is created along with all missing | ||
# directories in its path. | ||
|
||
# TODO: Install non-default Python versions for tox. | ||
# TODO: Install Apache/Nginx for plugin development. | ||
COPY certbot-auto /opt/certbot/src/certbot-auto | ||
RUN /opt/certbot/src/certbot-auto -n --os-packages-only | ||
|
||
# the above is not likely to change, so by putting it further up the | ||
# Dockerfile we make sure we cache as much as possible | ||
|
||
COPY setup.py README.rst CHANGES.rst MANIFEST.in linter_plugin.py tox.cover.sh tox.ini pep8.travis.sh .pep8 .pylintrc /opt/certbot/src/ | ||
|
||
# all above files are necessary for setup.py, however, package source | ||
# code directory has to be copied separately to a subdirectory... | ||
# https://docs.docker.com/reference/builder/#copy: "If <src> is a | ||
# directory, the entire contents of the directory are copied, | ||
# including filesystem metadata. Note: The directory itself is not | ||
# copied, just its contents." Order again matters, three files are far | ||
# more likely to be cached than the whole project directory | ||
|
||
COPY certbot /opt/certbot/src/certbot/ | ||
COPY acme /opt/certbot/src/acme/ | ||
COPY certbot-apache /opt/certbot/src/certbot-apache/ | ||
COPY certbot-nginx /opt/certbot/src/certbot-nginx/ | ||
COPY certbot-compatibility-test /opt/certbot/src/certbot-compatibility-test/ | ||
|
||
RUN virtualenv --no-site-packages -p python2 /opt/certbot/venv && \ | ||
/opt/certbot/venv/bin/pip install -U setuptools && \ | ||
/opt/certbot/venv/bin/pip install -U pip && \ | ||
/opt/certbot/venv/bin/pip install \ | ||
-e /opt/certbot/src/acme \ | ||
-e /opt/certbot/src \ | ||
-e /opt/certbot/src/certbot-apache \ | ||
-e /opt/certbot/src/certbot-nginx \ | ||
-e /opt/certbot/src/certbot-compatibility-test \ | ||
-e /opt/certbot/src[dev,docs] | ||
|
||
# install in editable mode (-e) to save space: it's not possible to | ||
# "rm -rf /opt/certbot/src" (it's stays in the underlaying image); | ||
# this might also help in debugging: you can "docker run --entrypoint | ||
# bash" and investigate, apply patches, etc. | ||
|
||
WORKDIR /opt/certbot/src/certbot-compatibility-test/certbot_compatibility_test/testdata | ||
|
||
ENV PATH /opt/certbot/venv/bin:$PATH |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
FROM certbot-compatibility-test | ||
MAINTAINER Brad Warren <[email protected]> | ||
|
||
RUN apt-get install apache2 -y | ||
|
||
ENTRYPOINT [ "certbot-compatibility-test", "-p", "apache" ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
FROM certbot-compatibility-test | ||
MAINTAINER Brad Warren <[email protected]> | ||
|
||
RUN apt-get install nginx -y | ||
|
||
ENTRYPOINT [ "certbot-compatibility-test", "-p", "nginx" ] |
20 changes: 0 additions & 20 deletions
20
certbot-compatibility-test/certbot_compatibility_test/configurators/apache/Dockerfile
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.