-
Notifications
You must be signed in to change notification settings - Fork 280
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
mples/mautic-example-nginx-ssl/certbot/setup.sh can be used to #192
base: master
Are you sure you want to change the base?
Conversation
understand and deploy the mautic with letsencrypt docker"
Thank you for your contribution! We require all contributors to sign our Contributor License Agreement, and we do not have a record of your signature on file. In order for us to review and merge your code, please head over to https://www.mautic.org/contributor-agreement and complete the form. There may be a short delay while the team add you as a contributor - please be patient :). Any problems contact the Product Team on Slack (get an invite at https://mautic.org/slack). CLA has not been signed by @RaianHN. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi there @RaianHN and thanks so much for making this PR and welcome to the community! 🚀
Pinging @luizeof to review for technical accuracy.
I have made some suggestions - please bear in mind that I am no Docker expert so this is purely from the grammar and style perspective. There may be technical inaccuracies in what I have proposed so please do check and drop a comment if that is the case.
The basic areas of concern:
-
We should be using example.com in our documentation whenever we are referring to domain references - see the style guide here
-
Where we have the database config, let's make it abundantly clear that the user should be replacing them with secure credentials in case someone does not and leaves them with insecure credentials for a production site - you may wish to alert them in the readme to this and the need to replace the placeholders.
I hope this makes sense and just to reiterate, please double check my suggested changes for technical correctness!
@@ -0,0 +1,22 @@ | |||
This example shows how to configure nginx to act as a reverse proxy with ssl support for mautic container. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This example shows how to configure nginx to act as a reverse proxy with ssl support for mautic container. | |
This example shows how to configure NGINX to act as a reverse proxy with SSL support for the Mautic container. |
|
||
#### What is handled in this docker-compose.yml: | ||
|
||
* Setup of mysql and mautic containers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Setup of mysql and mautic containers | |
* Setup of MySQL and Mautic containers |
#### What is handled in this docker-compose.yml: | ||
|
||
* Setup of mysql and mautic containers | ||
* Setup of mysql db on managed or remote server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Setup of mysql db on managed or remote server | |
* Setup of MySQL database on a managed or remote server |
|
||
* Setup of mysql and mautic containers | ||
* Setup of mysql db on managed or remote server | ||
* Setup of a nginx container with custom vhost configuration (nginx.conf)and secure with letsencrypt certs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Setup of a nginx container with custom vhost configuration (nginx.conf)and secure with letsencrypt certs | |
* Setup of an NGINX container with custom vhost configuration (nginx.conf) and secure the instance with Let's Encrypt certificates |
|
||
#### How to use this example: | ||
|
||
1. run ```docker-compose up``` in this directory |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that we only require one backtick for an inline comment but if there is a reason to use three please feel free to disregard the suggestion!
1. run ```docker-compose up``` in this directory | |
1. Run `docker-compose up` in this directory |
location / { | ||
listen 443 ssl default_server; | ||
ssl_dhparam /etc/ssl/certs/dhparam-2048.pem; | ||
ssl_certificate /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/cert.pem; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ssl_certificate /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/cert.pem; | |
ssl_certificate /etc/letsencrypt/live/beta-mautic.example.com/cert.pem; |
listen 443 ssl default_server; | ||
ssl_dhparam /etc/ssl/certs/dhparam-2048.pem; | ||
ssl_certificate /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/cert.pem; | ||
ssl_certificate_key /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/privkey.pem; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ssl_certificate_key /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/privkey.pem; | |
ssl_certificate_key /etc/letsencrypt/live/beta-mautic.example.com/privkey.pem; |
ssl_certificate /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/cert.pem; | ||
ssl_certificate_key /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/privkey.pem; | ||
|
||
#ssl_certificate /etc/letsencrypt/archive/beta-mautic.thrivebrokers.com/cert1.pem; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is commented out, do we need to retain it?
#ssl_certificate /etc/letsencrypt/archive/beta-mautic.thrivebrokers.com/cert1.pem; | |
#ssl_certificate /etc/letsencrypt/archive/beta-mautic.example.com/cert1.pem; |
ssl_certificate_key /etc/letsencrypt/live/beta-mautic.thrivebrokers.com/privkey.pem; | ||
|
||
#ssl_certificate /etc/letsencrypt/archive/beta-mautic.thrivebrokers.com/cert1.pem; | ||
#ssl_certificate_key /etc/letsencrypt/archive/beta-mautic.thrivebrokers.com/privkey1.pem; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is commented out, do we need to retain it?
#ssl_certificate_key /etc/letsencrypt/archive/beta-mautic.thrivebrokers.com/privkey1.pem; | |
#ssl_certificate_key /etc/letsencrypt/archive/beta-mautic.example.com/privkey1.pem; |
proxy_redirect http:// https://; | ||
} | ||
} | ||
proxy_redirect http://beta-mautic.thrivebrokers.com https://beta-mautic.thrivebrokers.com; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
proxy_redirect http://beta-mautic.thrivebrokers.com https://beta-mautic.thrivebrokers.com; | |
proxy_redirect http://beta-mautic.example.com https://beta-mautic.example.com; |
generalized mautic hostname config TODO: 1. script to search and replace hostnames before initiating installation
Thank you for your contribution! We require all contributors to sign our Contributor License Agreement, and we do not have a record of your signature on file. In order for us to review and merge your code, please head over to https://www.mautic.org/contributor-agreement and complete the form. There may be a short delay while the team add you as a contributor - please be patient :). Any problems contact the Product Team on Slack (get an invite at https://mautic.org/slack). CLA has not been signed by @RaianHN. |
understand and deploy the mautic with letsencrypt docker"