New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Narrative documentation for plugins #1137

Closed
bmw opened this Issue Oct 26, 2015 · 6 comments

Comments

Projects
None yet
3 participants
@bmw
Contributor

bmw commented Oct 26, 2015

While changes proposed in #1079 help, it is very hard to tell from the names manual, standalone, and webroot what our plugins actually do. We need to add narrative documentation for each plugin to help people understand the purpose of each plugin and when they should be used.

@bmw bmw added this to the 1.0 for launch milestone Oct 26, 2015

@bmw

This comment has been minimized.

Show comment
Hide comment
@bmw

bmw Oct 26, 2015

Contributor

@kuba, @pde: Do you feel this has been fixed enough by #1121 to either close this issue or kick it out of the "1.0 for launch" milestone?

Contributor

bmw commented Oct 26, 2015

@kuba, @pde: Do you feel this has been fixed enough by #1121 to either close this issue or kick it out of the "1.0 for launch" milestone?

@kuba

This comment has been minimized.

Show comment
Hide comment
@kuba

kuba Oct 27, 2015

Contributor

I think we should still work on improving docs (including narrative plugins explanation) before launch.

Contributor

kuba commented Oct 27, 2015

I think we should still work on improving docs (including narrative plugins explanation) before launch.

@kuba

This comment has been minimized.

Show comment
Hide comment
@kuba

kuba Oct 29, 2015

Contributor

#1190 is one of the examples why clear narrative docs is necessary.

Contributor

kuba commented Oct 29, 2015

#1190 is one of the examples why clear narrative docs is necessary.

@kuba kuba self-assigned this Oct 30, 2015

@kuba

This comment has been minimized.

Show comment
Hide comment
@kuba

kuba Oct 30, 2015

Contributor

Since I personally find it very high priority, I will work on this during weekend.

Contributor

kuba commented Oct 30, 2015

Since I personally find it very high priority, I will work on this during weekend.

@pde

This comment has been minimized.

Show comment
Hide comment
@pde

pde Nov 11, 2015

Member

From the latest Beta Program email:

How to use the client

The Let's Encrypt client supports a number of different "plugins" that can be used to obtain and/or install certificates. A few examples of the options are included below:

If you're running Apache on a recent Debian-based OS, you can try the Apache plugin, which automates both obtaining and installing certs:

./letsencrypt-auto --apache --server https://acme-v01.api.letsencrypt.org/directory --agree-dev-preview

To obtain a cert using a "standalone" webserver (you may need to temporarily stop your exising webserver) for example.com and www.example.com:

./letsencrypt-auto certonly -a standalone -d example.com -d www.example.com --server https://acme-v01.api.letsencrypt.org/directory --agree-dev-preview

To obtain a cert using the "webroot" plugin, which can work with the webroot of any webserver software:

./letsencrypt-auto certonly -a webroot --webroot-path /var/www/example -d example.com -d www.example.com -server https://acme-v01.api.letsencrypt.org/directory --agree-dev-preview

NB: curretly the webroot plugin can only obtain certs for several domains simultaneously if they share a webroot.

Member

pde commented Nov 11, 2015

From the latest Beta Program email:

How to use the client

The Let's Encrypt client supports a number of different "plugins" that can be used to obtain and/or install certificates. A few examples of the options are included below:

If you're running Apache on a recent Debian-based OS, you can try the Apache plugin, which automates both obtaining and installing certs:

./letsencrypt-auto --apache --server https://acme-v01.api.letsencrypt.org/directory --agree-dev-preview

To obtain a cert using a "standalone" webserver (you may need to temporarily stop your exising webserver) for example.com and www.example.com:

./letsencrypt-auto certonly -a standalone -d example.com -d www.example.com --server https://acme-v01.api.letsencrypt.org/directory --agree-dev-preview

To obtain a cert using the "webroot" plugin, which can work with the webroot of any webserver software:

./letsencrypt-auto certonly -a webroot --webroot-path /var/www/example -d example.com -d www.example.com -server https://acme-v01.api.letsencrypt.org/directory --agree-dev-preview

NB: curretly the webroot plugin can only obtain certs for several domains simultaneously if they share a webroot.

@bmw

This comment has been minimized.

Show comment
Hide comment
@bmw

bmw Nov 14, 2015

Contributor

@kuba, are you still working on this? If not, I'll take it over.

Contributor

bmw commented Nov 14, 2015

@kuba, are you still working on this? If not, I'll take it over.

@bmw bmw assigned bmw and unassigned kuba Nov 15, 2015

@pde pde closed this in c3e1f1c Nov 18, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment