Skip to content

docs: Provision a cert with the ACME DNS-01 challenge via Certbot + Cloudflare#2968

Merged
polarathene merged 5 commits intodocker-mailserver:masterfrom
ShiriNmi1520:docs/certbot-cloudflare
Jan 6, 2023
Merged

docs: Provision a cert with the ACME DNS-01 challenge via Certbot + Cloudflare#2968
polarathene merged 5 commits intodocker-mailserver:masterfrom
ShiriNmi1520:docs/certbot-cloudflare

Conversation

@ShiriNmi1520
Copy link
Copy Markdown
Contributor

Description

Add docs for implementing certbot-dns-cloudflare to generate a certificate for the mail server

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change that does improve existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@georglauterbach georglauterbach added area/documentation kind/improvement Improve an existing feature, configuration file or the documentation labels Dec 30, 2022
casperklein
casperklein previously approved these changes Dec 30, 2022
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for providing this contribution! 👍

I've provided some revisions to consider, you can batch commit them all if you like (or I could do it if you prefer).

Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
@polarathene polarathene added this to the v12.0.0 milestone Jan 4, 2023
@polarathene polarathene changed the title docs: Certbot cloudflare docs: Provision a cert with the ACME DNS-01 challenge via Certbot + Cloudflare Jan 4, 2023
polarathene
polarathene previously approved these changes Jan 4, 2023
polarathene
polarathene previously approved these changes Jan 5, 2023
Comment on lines +225 to +229
6. Run the service to provision a certificate:

```sh
docker-compose run certbot-cloudflare
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you've mentioned this only allows to provision the certificate and different steps are required for renewal. Would you like to inform the user about this and how to go about renewal?

Presently pairing the service in a compose config next to the DMS service would run that service and command each time the mail-server is brought up with a docker-compose up -d, is that going to be a concern? Should it be treated as a separate compose file?

I've not reviewed the other guides on this page, they may have a similar concern but not one you need to worry about 👍


I came across a very similar step-by-step guide that shows that renewal command is pretty much the same but includes renew instead of certonly, they also have a few extra options in their commands (also via a docker-compose file) that might be worthwhile.

It seems common to just setup a cron or systemd timer on the host to schedule renewals with Certbot?


I'm not blocking approval on this, but it would be appreciated if addressed 😅

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, it'd be better if we add that part about renewal, gonna working on this part later and expect to create a commit later today

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've completed add documentation for renewing certificate in 8560bdf, waiting for github-action to complete building preview

Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll apply these changes, thanks for the contribution! 😀

Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
Comment thread docs/content/config/security/ssl.md Outdated
ShiriNmi1520 and others added 5 commits January 7, 2023 11:55
Add docs for implement certbot-dns-cloudflare to generate certificate for mail server
Fix the docker-compose command according to the advice
Add docs for implementing renewing certificate with crontab
@polarathene polarathene force-pushed the docs/certbot-cloudflare branch from fa880c9 to ab8ef12 Compare January 6, 2023 22:55
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 6, 2023

Documentation preview for this PR is ready! 🎉

Built with commit: ab8ef12

@polarathene polarathene merged commit 8871597 into docker-mailserver:master Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants