Commit graph

628 commits

Author SHA1 Message Date
Zach Shepherd
c1cb762b32 docs: clarify when venv needs to be re-setup
When dependencies change or a new plugin is introduced, the venv needs
to be re-created.

Partially addresses issue #4368.
2017-04-03 14:33:41 -07:00
Noah Swartz
ca16dfb593 Merge branch 'master' into docs-add-gentoo-packages 2017-03-29 17:42:23 -07:00
Jacob Hoffman-Andrews
e73c29374a Change to source. 2017-03-29 14:32:02 -07:00
Jacob Hoffman-Andrews
db0a4f9039 Document tests/integration/_common.sh.
This makes it much easier to run certbot during development.
2017-03-28 16:15:09 -07:00
Noah Swartz
272a81b400 Merge pull request #4304 from certbot/package-guide
Improve packaging guide.
2017-03-27 08:53:26 -07:00
Jacob Hoffman-Andrews
2e102ec9f7 Review feedback. 2017-03-25 11:39:19 -07:00
Osiris Inferi
b81f029614
Add Gentoo to list of official packages 2017-03-18 00:51:59 +01:00
Piotr Kasprzyk
fd789b4e4b Fix choose, remove spaces (#4364) 2017-03-17 14:11:52 -07:00
Jacob Hoffman-Andrews
b23a1377e0 Clarify documentation for low-memory machines. (#4305)
* Clarify documentation for low-memory machines.

* Restore py26/py27 requirement.
2017-03-17 13:17:08 -07:00
Jacob Hoffman-Andrews
672f206309 Improve plugin-writing docs. (#4329)
Move "Writing your own plugin" under Code components and layout, with the other
plugin docs.

Include instructions on how to install a plugin into a virtualenv and how to check
for its presence.

Document that users can install third-party plugins systemwide, but not with
certbot-auto.

Remove obsolete information from Authenticators section and make the section
more informative.

Remove IDisplay sub-section since it repeats information in the main "Plugin
architecture" section.
2017-03-17 13:13:45 -07:00
Brad Warren
da1459df0d use docker hub in install guide 2017-03-14 16:36:39 -07:00
Noah Swartz
25bda6177e Merge branch 'master' into docs-update-standalone-manual-plugins 2017-03-13 13:48:48 -07:00
Brad Warren
91f4b2b571 Improve macOS contributor instructions (#4327)
* remove instructions about removed Vagrantfile

* rewrite docker instructions

* say where docker-compose can be run

* give better intro for macOS devs

* prompt people for permission to install OS packages

* reword awkward sentence

* Change WORKDIR to /opt/certbot/src

This change is OK because all paths used in Dockerfile-dev are absolute paths.

* remove 'cd src' instructions for Dockerfile-dev

* Improve docker-compose testing instructions
2017-03-10 17:27:09 -08:00
陈三
6669b95a4e Updated the deprecated arguments (#4306) 2017-03-07 11:19:55 -08:00
Jacob Hoffman-Andrews
ee4e7c4f71 Improve packaging guide.
Correct tagging format.
Add request for random offsets for renewal.
Make all bulleted lists consistent.
Remove obsolete `letsencrypt` package for Fedora.
Remove discouraged letshelp-certbot package.
2017-03-06 18:36:37 -08:00
Brad Warren
4a2582dda4 Remove broken known issues link (#4294) 2017-03-06 17:31:28 -08:00
Shiloh Heurich
2862ade0b1 docs(ciphers): newer keylength.com recommendations (#4266) 2017-03-03 10:44:12 -08:00
Jacob Hoffman-Andrews
ea578870da ipdb can now be run without pip installing. (#4257) 2017-03-03 10:37:31 -08:00
yonjah
1507b6b731 Added documentation about renew exit status #Fixes #4090 (#4234)
* Added documentation about renew exit status #Fixes #4090

* recommend using post-hook instead of renew-hook
2017-03-03 08:34:30 -08:00
yomna
93908a33bc [#3451] small changes to the standalone documentation (#4247) 2017-03-02 17:28:45 -08:00
Erica Portnoy
5e671682ca Candidate 0.12.0 (#4286)
* Release 0.12.0

* Bump version to 0.13.0
2017-03-02 15:26:24 -08:00
Osiris Inferi
bb35126a2c
Deprecated standalone-preferred-challenges 2017-02-27 20:39:42 +01:00
Jacob Hoffman-Andrews
ebf5170d12 Update testing docs. (#4211)
Recommend faster-running commands with clearer output first, building up to
slow, noisy, `tox` last.

Remove outdated Boulder testing advice, and outdated Boulder testing scripts
(Vagrantfile, mac-bootstrap.sh, boulder-start.sh). Update Boulder testing
section.

Fill out "directory structure" section of contributing guide a little better.
2017-02-16 12:39:17 -08:00
Erica Portnoy
3b9db79fd3 Merge pull request #4092 from certbot/managing-docs
Add information about cert management to the docs
2017-02-10 17:41:13 -08:00
Erica Portnoy
b316a13f22 oxford comma 2017-02-09 14:40:02 -08:00
Erica Portnoy
08a546fa8d remove trailing whitespace 2017-02-09 14:38:38 -08:00
Erica Portnoy
8b5c87f983 revert factual errors 2017-02-09 13:13:33 -08:00
Erica Portnoy
92816275a6 plaintextify 2017-02-09 12:59:06 -08:00
Brad Warren
99818bc6b7 Release 0.11.1
(cherry picked from commit 426a804561)
2017-02-01 20:56:23 -08:00
Brad Warren
30bc68ccde
Release 0.11.0 2017-02-01 09:50:42 -08:00
Josh Soref
6a39a42f45 Spelling (#4101)
* spelling: action

* spelling: artifacts

* spelling: asymmetric

* spelling: attempts

* spelling: bizarre

* spelling: certbot

* spelling: certificate

* spelling: certainly

* spelling: challenge

* spelling: client

* spelling: collated

* spelling: correct

* spelling: considered

* spelling: custom

* spelling: distinguish

* spelling: encoding

* spelling: enhancement

* spelling: equivalent

* spelling: execution

* spelling: existence

* spelling: failed

* spelling: handshake

* spelling: hyphen

* spelling: initialized

* spelling: initialization

* spelling: interpretation

* spelling: letsencrypt

* spelling: multiline

* spelling: multipart

* spelling: necessary

* spelling: otherwise

* spelling: output

* spelling: overridden

* spelling: positives

* spelling: preferable

* spelling: progress

* spelling: recommended

* spelling: referring

* spelling: relativity

* spelling: request

* spelling: requiring

* spelling: separate

* spelling: source

* spelling: specified

* spelling: standard

* spelling: successfully

* spelling: unparseable

* spelling: useful
2017-01-26 16:21:54 -08:00
Peter Conrad
bf7ce31302 Restructuring and editing using.rst to incorporate new command docs better. 2017-01-26 15:53:48 -08:00
Brad Warren
4e297b0248 Release 0.10.2 (#4120)
* Release 0.10.2

(cherry picked from commit 535b04be23)

* Bump version to 0.11.0

(cherry picked from commit 01f84df0641a98bb57b4b7be7980c3c1afe375d5)
2017-01-26 12:03:12 -08:00
Erica Portnoy
a1702e766d Add information about cert management to the docs 2017-01-20 11:35:40 -08:00
Peter Eckersley
169b30aa90 Fix reference to letsencrypt-auto (#4085) 2017-01-19 13:50:07 -08:00
Brad Warren
bb669528b3 Remove old references to pep8 in our code (#4073) 2017-01-19 11:21:25 -08:00
Noah Swartz
fdaae6b005 Merge pull request #4042 from pconrad-fb/master
"Polishing" pass over using.rst
2017-01-17 18:03:38 -08:00
Juho Juopperi
2797a0377d Fix misspelling "recieved" (#4059) 2017-01-17 13:43:43 -08:00
Brad Warren
7f3109f185 Candidate 0.10.1 to master (#4057)
* Release 0.10.1

(cherry picked from commit 0ead110658)

* Bump version to 0.11.0

(cherry picked from commit 5052c64dc9d790b8bd5ef3cf19b9ed3727cfc21f)
2017-01-13 17:15:50 -08:00
Peter Conrad
ad65b6317d Edits to using.rst 2017-01-12 17:27:59 -08:00
Brad Warren
364a6d8a2d Release 0.10.0 (#4022)
* Release 0.10.0

* Bump version to 0.11.0
2017-01-11 12:01:33 -08:00
Guillaume Boudreau
c1e106baf9 Added Heroku to the list of third-party plugins (#4020) 2017-01-11 09:58:47 -08:00
Lipis
bba5d7d950 Rename OS X -> macOS (#3965)
* Rename OS X -> macOS

* Revert *-auto
2017-01-10 12:24:15 -08:00
Noah Swartz
30acc5cf47 added basic manual instructions (#3975)
* added basic manual instructions

* take peter's edits
2017-01-09 19:01:15 -08:00
Nick Fong
b0e4054b53 Add information on updating [certbot|letsencrypt]-auto (#3983)
* Add information on updating [certbot|letsencrypt]-auto

See #3703

* Add more information about when [le|cb]-auto is updated
2017-01-07 16:45:44 -08:00
Erica Portnoy
3b233df2b1 Update docs/contributing.rst to match display behavior during release. (#3674) 2017-01-04 14:42:52 -05:00
Spencer Bliven
1946af289f Minor typo fix (#3966) 2017-01-03 12:09:37 -05:00
Tan Jay Jun
44d5886429 Add missing comma to documentation for 'renew' subcommand (#3945) 2016-12-21 14:21:52 -08:00
Lior Sabag
acc501d3a1 Fix typo (#3932) 2016-12-19 12:49:27 -08:00
Maarten
dc81c291b4 Change link of haproxy plugin to new version (#3904)
Greenhost has rewritten their HAProxy plugin and it's hosted on a different location. The original URL also points to this new location: https://code.greenhost.net/open/letsencrypt-haproxy
2016-12-13 13:13:55 -08:00
Timothy Guan-tin Chien
3dbf5c9fcb certbot-auto: Print link to doc on debugging pip install error [revision requested] (#3473)
* certbot-auto: Print link to doc on debugging pip install error

Also, update the doc to teach the user to workaround problem on a low
memory system.

* Correct formatting

* grep the PIP_OUT and print useful info if the problem is about memory allocation

* Fix logic on string to grep
2016-12-05 18:49:38 -08:00
Peter Eckersley
0956e61c7c Remove the sphinxcontrib.programout [docs]dependency (#3830)
- By making a static text file at release time, and including that
   instead.
2016-11-30 10:47:10 -08:00
Henri Salo
9aef15d09e Fix typo (#3790) 2016-11-14 10:58:14 -08:00
Martey Dodoo
a7bfefc6d0 Change all "cerbot" references to "certbot" (#3770) 2016-11-08 11:09:20 -08:00
Brad Warren
d197b5aa05 Fix OS Documentation (#3747)
* Update various package names in using.rst from "letsencrypt" to "certbot"

* Update using.rst

Change package name
2016-11-07 14:53:15 -08:00
Brad Warren
2564fb785b I restructured Installation and Using a bit (#3725)
* Fixing a weird out-of-place paragraph in the Getting Certbot section

* De-duping and clarifying installation information, separating it from Using.

* Responding to feedback at https://github.com/certbot/certbot/pull/3675#pullrequestreview-5757007
2016-11-01 14:25:26 -07:00
Brad Warren
6ad08f4f64 Fix link to Docker's user guide (#3651)
* Fix link to Docker's user guide

* Update link to the Docker installation guide
2016-10-25 18:51:01 -07:00
Patrick Figel
1dafaec5a9 Update CLI usage docs for --csr (#3677)
With #2403 and #3046, certbot gained the ability to parse CSRs
encoded as PEM and without a SAN extension. Update the CLI usage
docs to reflect this change.
2016-10-25 13:56:38 -07:00
benbankes
b9adb7cbaf Fix typo (#3659) 2016-10-19 08:53:46 -07:00
Brad Warren
82ac89b850 Release 0.9.3 Option 2 (see #3634) (#3635)
* Release 0.9.3

(cherry picked from commit ce4e00569e)

* Bump version to 0.10.0

(cherry picked from commit 5234172b81)
2016-10-15 10:10:01 -07:00
Peter Conrad
747a17d1fa Fixing a weird out-of-place paragraph in the Getting Certbot section (#3624) 2016-10-13 16:13:17 -07:00
Jacob Hoffman-Andrews
2415092a78 Update Where Are My Certs section. (#3419)
* Update Where Are My Certs section.

This combines the `cert.pem` and `chain.pem` sections into a single paragraph,
making it clearer that they are closely connected. It also adds text indicating
that they are less common and moves them below the section for `fullchain.pem`.

* Update "Getting Help" section.

* Add link to document missing intermediate.

* Remove incorrect line about ordering.

Also remove "(as the filename suggests)," and clarify file ordering in the
fullchain.pem section.
2016-10-10 18:36:58 -07:00
Peter Eckersley
d755db4702 Document the Nginx plugin release (#3588)
* Document the Nginx plugin release

* Tweak

* Remove mrueg nginx instructions for now?

* Shipped -> included

* keep order of plugin descriptions consistent with the table
2016-10-07 00:18:05 -07:00
Brad Warren
ff57c71802 Release 0.9.1 (#3595)
* fix requirements.txt surgery in response to shipping certbot-nginx (#3585)

* Make --quiet reduce the logging level (#3593)

* reduce logging level and ignore verbose flags in quiet mode

* Simplify setup_logging parameters

The extra parameters were there in the past when the letsencrypt-renewer was a
separate executable that also used this function. This is cruft that can be
removed.

* Add basic tests for setup_logging

* Release 0.9.1

* Bump version to 0.10.0
2016-10-06 16:58:50 -07:00
Brad Warren
76a92d4cde Release Certbot 0.9.0 (#3583)
* Release 0.9.0

* Bump version to 0.10.0
2016-10-05 10:13:28 -07:00
Peter Eckersley
1584ee8ac6 Merge pull request #3466 from certbot/all-together-now
DNS challenge support in the manual plugin and general purpose --preferred-challenges flag
2016-09-22 14:15:25 -07:00
Peter Eckersley
107a3e6aa9 Allow & document --preferred-challenges dns,http 2016-09-21 16:17:31 -07:00
Peter Eckersley
6c066ef10c Better section link 2016-09-21 15:24:15 -07:00
Peter Eckersley
9219617b0c Nicer table formatting 2016-09-21 15:20:06 -07:00
Peter Eckersley
a18a8f051d Improve documentation for --preferred-challenges 2016-09-21 15:01:01 -07:00
Brad Warren
122e05a2ff Remove duplication in resources.rst 2016-08-24 14:37:47 -07:00
Jeroen Pluimers
5500004dd6 Fix the links for #3416 and align README.rst & docs/resources.rst
Fix the links for #3416 and align content of in README.rst and docs/resources.rst so it's easier to later de-dupe

(I've not done this now as in README.rst does too much tag: fiddling and I'm not sure how that will work out if the fiddling is not aware of .. include::.
2016-08-18 10:38:47 +02:00
Noah Swartz
44cf40472e add allow subset 2016-08-17 15:43:35 -07:00
Noah Swartz
0c0603b9ea copy peter's OS update below 2016-08-17 14:58:14 -07:00
Noah Swartz
c946589dab fix merge 2016-08-17 14:55:30 -07:00
Peter Eckersley
015d103f8d Unbreak using.html#plugins links
Fixes: #3422
2016-08-16 18:46:19 -07:00
Peter
3036419975 Fixing merge conflicts. 2016-08-11 15:14:08 -07:00
Noah Swartz
65605f7373 fix merge conflict 2016-08-10 13:19:47 -07:00
Peter Eckersley
262eb778fe Update Apache plugin supported OSes 2016-08-08 15:29:23 -07:00
Jacob Hoffman-Andrews
e49a41be34 Change "hacking" to "getting started" in the docs 2016-08-08 12:17:42 -07:00
Brad Warren
c6eeb6cec8 Merge pull request #3294 from certbot/docs-structure
New docs structure and introduction
2016-07-29 13:52:14 -07:00
Peter
9ebda1879c Restructured installation docs. Mainly put everything together in a sensible order in using.rst and pointed to it from README.rst. 2016-07-28 15:43:57 -07:00
Brad Warren
a0efc2c27c Convert ciphers.rst markdown to rst 2016-07-25 13:13:54 -07:00
Brad Warren
6830bb01f8 Change ciphersuite link from wiki to rst file 2016-07-25 13:01:47 -07:00
Brad Warren
7a0d4d48a0 Remove broken known issues link 2016-07-25 12:54:14 -07:00
Brad Warren
fb399a844b Fix Feedback link 2016-07-25 12:51:33 -07:00
Brad Warren
68e09aad0f Merge pull request #2952 from certbot/wiki-migration
Wiki migration
2016-07-21 15:31:14 -07:00
Noah Swartz
4a7a9b7d5d remove webhosting, fold ciphersuite 2016-07-21 08:53:10 -07:00
Brad Warren
0c68a8cd6e Fix broken links 2016-07-20 15:19:21 -07:00
Brad Warren
6c07f39093 Merge branch 'master' into docs-structure 2016-07-20 15:14:42 -07:00
Brad Warren
4eb9ea7b72 Remove current_features.rst 2016-07-20 15:02:10 -07:00
Brad Warren
b919859181 Include README for current_features in using.rst. 2016-07-20 15:01:55 -07:00
Brad Warren
642d67b3eb Remove intro_common.rst 2016-07-20 15:00:33 -07:00
Brad Warren
e671444344 Make intro.rst include README 2016-07-20 14:59:50 -07:00
Peter
69d3e56f1b Final quick fixes in response to Brad's comments at https://github.com/certbot/certbot/pull/3258 2016-07-15 16:43:41 -07:00
Peter
640bb88d4f Fixes in response to Brad's comments at https://github.com/certbot/certbot/pull/3258 2016-07-15 14:56:03 -07:00
Brad Warren
37c8abf1e5 Fix interactive guide link 2016-07-15 09:36:44 -07:00
Brad Warren
8be5849a9e Flip README and intro 2016-07-15 09:35:42 -07:00
Brad Warren
fd308f8ce1 Make current features a subsection 2016-07-15 09:34:12 -07:00
Jason Grinblat
7b029afb10 Adds new introduction and refactors the old introduction 2016-07-14 16:11:01 -07:00
Noah Swartz
6367641992 add other files, brads comments 2016-07-14 15:28:18 -07:00
Brad Warren
129f78a7f5 Add resources page 2016-07-14 15:11:39 -07:00
Brad Warren
26ac17a4a1 Add quick install page 2016-07-14 15:07:32 -07:00
Brad Warren
9fe6836c01 remove coupling between README and docs introduction 2016-07-14 15:05:41 -07:00
Noah Swartz
7b3144c168 brads comments 2016-07-14 11:53:36 -07:00
Noah Swartz
19f6b79bcc fix merge 2016-07-14 11:36:04 -07:00
Peter
c92a1cd182 Clarifications to Docker, certbot-auto content reflecting first three questions in my comment https://github.com/certbot/certbot/pull/3232#issuecomment-231154320 2016-07-07 17:24:58 -07:00
Brad Warren
2cd4f6f008 update FreeBSD package name 2016-07-05 14:14:31 -07:00
Noah Swartz
f391570566 seth and noah updated some confusing things 2016-06-30 19:01:02 -07:00
Brad Warren
a70cf6fcf8 Use correct port name 2016-06-29 15:22:19 -07:00
Viktor Szakats
3178a9f0f3 cli-help: fix spelling 2016-06-24 00:24:53 +02:00
bmw
950710bdce Merge pull request #3042 from TheNavigat/envlist
Limiting tox envlist to really needed tests
2016-06-17 12:37:17 -07:00
Amjad Mashaal
31d9fc7d86 Adding --skip-missing-interpreters to constributing.rst "Submitting a pull request" section 2016-06-17 04:13:44 +02:00
bmw
a95d2cf061 Merge pull request #3018 from mgedmin/patch-2
Remove dangling footnote
2016-06-16 16:38:51 -07:00
Brad Warren
4158656058
Release 0.8.1 2016-06-14 16:56:16 -07:00
Peter Eckersley
311a2db6ba Merge pull request #3110 from certbot/candidate-0.8.0
Update files in response to 0.8.0 release
2016-06-08 12:01:09 -07:00
Noah Swartz
092173c608 fix broken link in contributing.rst (#3130) 2016-06-06 17:05:51 -07:00
Felix Yan
091b6a5cdb Update Arch instructions for the new package name 2016-06-02 23:02:49 -05:00
Brad Warren
dcadcf8d42
Release 0.8.0 2016-06-02 13:50:30 -07:00
Leo Famulari
33e905c147 docs: Fix generation of manpage certbot(1).
* docs/man/certbot.rst: Fix path to resource file.
2016-05-31 20:37:05 -04:00
Amjad Mashaal
4a8f71277c Limiting tox envlist to really needed tests 2016-05-28 02:03:51 +02:00
Peter Eckersley
61e0e3cc83 Merge pull request #3073 from cowlicks/rename-le-util
Rename certbot.le_util to certbot.util
2016-05-27 14:37:36 -07:00
Brad Warren
46d8f6e18c
Release 0.7.0 2016-05-27 13:30:46 -07:00
Blake Griffith
b05258243a More le_util in docs and compatibility tests 2016-05-26 15:57:50 -05:00
Nick Le Mouton
fd899d2125 Fixing package names for Debian Jessie 2016-05-23 09:44:06 +12:00
Marius Gedminas
279cb35256 Oops, ReST syntax is weird 2016-05-18 11:05:23 +03:00
Marius Gedminas
f55ef8e286 Renewal hooks mean this note is outdated 2016-05-18 11:03:18 +03:00
Marius Gedminas
63c79f98ca Remove dangling footnote
This footnote has no references!
2016-05-18 10:59:58 +03:00
Noah Swartz
4b1d9e0af2 Merge pull request #2986 from certbot/doc-cleanup
Doc cleanup
2016-05-16 20:14:02 -07:00
John Reed
1aff941ad0 Updating broken link to Google Python Style guide
Old link: https://google-styleguide.googlecode.com/svn/trunk/pyguide.html
New link: https://google.github.io/styleguide/pyguide.html
2016-05-13 18:37:43 -05:00
Peter Eckersley
e85b387e42 Move 3rd party plugins back below others 2016-05-13 13:21:49 -07:00
Peter Eckersley
f16104e3cb Lots of doc cleanups 2016-05-13 12:22:55 -07:00
Peter Eckersley
3c279c4fad Create a man page for ourselves! 2016-05-13 12:22:19 -07:00
Peter Eckersley
a12405ace0 Merge remote-tracking branch 'origin/master' into plugin-docs 2016-05-12 19:20:23 -07:00
Peter Eckersley
2dc983db49 STLSE is a prototype Postfix plugin
- it partially uses IInstaller
 - it will also support Exim in the future
2016-05-12 19:17:19 -07:00
Peter Eckersley
b905cb4481 Missing link 2016-05-12 19:09:59 -07:00
Peter Eckersley
5b058fd18f Import third party plugin list from the wiki
And clean up the confusing section about third party plugins
2016-05-12 19:06:09 -07:00
Noah Swartz
f53f4dd491 fix docs copyright 2016-05-12 09:30:45 -07:00
Noah Swartz
4e704eba01 fix merge conflict 2016-05-09 18:33:35 -07:00
Brad Warren
3ce47282ea Make --quiet suggestion stronger 2016-05-09 18:14:02 -07:00
Brad Warren
6fa7eb576b Use -n when using certonly 2016-05-09 18:11:36 -07:00
Noah Swartz
bbcde8cec1 seth changes 2016-05-09 15:27:17 -07:00
Noah Swartz
9ddabc3e9a fix docs conf 2016-05-09 15:17:14 -07:00
Brad Warren
555513940c Explain *-hook and -q in renewal documentation 2016-05-09 14:57:01 -07:00
Noah Swartz
c4c1fa3a26 switch size of subheadings 2016-05-09 14:48:28 -07:00
Noah Swartz
505b8854f6 break sections correctly 2016-05-09 14:46:37 -07:00
Noah Swartz
05131da32e make code blocks code blocks 2016-05-09 14:44:26 -07:00
Noah Swartz
ecbff9e60d migrate packaging info 2016-05-09 14:40:03 -07:00
Noah Swartz
e04e9286f6 fix merge 2016-05-09 12:35:10 -07:00
Jeremy Gillula
127ba71c43 Adding the fact that we actually have backports for Debian Jessie to the docs 2016-05-05 11:17:47 -07:00