Updated README.md

This commit is contained in:
Mehdi (OSX) 2023-11-23 09:07:07 +05:00
parent 48a6529960
commit 512e530bfc

View File

@ -2,8 +2,10 @@ ## Usage:
1. Create `ssl` folder to store certificates and this repository. 1. Create `ssl` folder to store certificates and this repository.
2. Clone this repository or use as submodule: 2. Clone this repository or use as submodule:
- `git submodule add ssh://git@git.w3goodies.com:17001/mehdi-mac/certbot-docker-script.git` - `git submodule add ssh://git@git.w3goodies.com:17001/mehdi-mac/certbot-docker-script.git`
3. Creat `certs` folder inside `ssl` folder. 3. Create `certs` folder inside `ssl` folder.
4. Put `config.sh` inside `ssl` folder. Copy contents from [config.sh.dummy](https://git.w3goodies.com/mehdi-mac/certbot-docker-script/src/branch/main/config.sh.dummy) 4. Put `config.sh` inside `ssl` folder.
- Copy contents from [config.sh.dummy](https://git.w3goodies.com/mehdi-mac/certbot-docker-script/src/branch/main/config.sh.dummy)
- Modify it to your needs.
5. The folder structure would be: 5. The folder structure would be:
``` ```
/your-project/ssl/ /your-project/ssl/
@ -33,7 +35,7 @@ ## Notes:
- Make sure to mount both `certs/live/test.com` and `certs/archive/test.com` directory, and use `live/test.com/*.pem` certificates in your nginx config. - Make sure to mount both `certs/live/test.com` and `certs/archive/test.com` directory, and use `live/test.com/*.pem` certificates in your nginx config.
- Because archive directory has actual files, but live directory has symlink to archive. In archive, certs are stored like this fullchain1.pem, cert1.pem and number is increased based on renewals. But live folder has direct certificates without number like cert.pem, fullchain.pem - Because archive directory has actual files, but live directory has symlink to archive. In archive, certs are stored like this fullchain1.pem, cert1.pem and number is increased based on renewals. But live folder has direct certificates without number like cert.pem, fullchain.pem
- Also use certbot nginx options file in your nginx config: https://github.com/certbot/certbot/blob/master/certbot-nginx/certbot_nginx/_internal/tls_configs/options-ssl-nginx.conf - Also use certbot nginx options file in your nginx config: https://github.com/certbot/certbot/blob/master/certbot-nginx/certbot_nginx/_internal/tls_configs/options-ssl-nginx.conf
- Since we `chdir` inside the script, therefore you can keep using `config.sh` with relative path in the command and also `certs_dir` in config.sh
--- ---
## Example nginx config: ## Example nginx config: