Add more notes.

This commit is contained in:
Hyperling 2023-07-06 06:50:58 -07:00
parent 81f8817e96
commit 95714bc385

View File

@ -1,14 +1,16 @@
# Initial Setup Instructions
How to first begin using this subproject.
1. Move to this directory.
1. Move to the directory of this README.
```
$ cd $DOCKER_HOME/Config/ReverseProxy
```
1. Add configuration files to `./config/conf.d/` which are named based on the domains and subdomains they point to.
1. Run the placeholder certificate program.
```
# create_placeholder_certs.sh
# ./create_placeholder_certs.sh
```
1. Build the project. This also needs done any time `./config/conf.d/*` changes.
1. Make any personal changes to `./config/nginx.conf`.
1. Build the project.
```
# docker compose build
```
@ -18,18 +20,20 @@ How to first begin using this subproject.
```
1. Verify it started correctly, no configuration file errors.
```
# docker compose logs reverseproxy-app-1
# docker compose logs reverseproxy-certbot-1
# docker logs reverseproxy-app-1
# docker logs reverseproxy-certbot-1
```
# Other Commands
Tasks which will also likely come up while using this subproject.
## Stop
If you need to halt the system you may use either stop or down.
```
# docker compose stop
# docker compose down
```
## Upgrade
Upgrading the containers should be as easy as this:
```
@ -38,3 +42,17 @@ Upgrading the containers should be as easy as this:
# docker compose build
# docker compose up -d
```
## Update Config
Replace the configuration based on any new, updated, or removed files.
This may be possible to do when the system is up, buyt the best results have come from going down and back up.
This is essentially an upgrade but there is no pull.
```
# docker compose down
# docker compose build
# docker compose up -d
```
If you'd like it as a one command:
```
# docker compose down && docker compose build && docker compose up -d
```