Commit dcc5595b authored by Paul Desplanque's avatar Paul Desplanque

Update documentation

parent 020776e5
......@@ -10,7 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Static folder Apache can serve directly
- Static folder Apache can serve directly (bind mount from host)
- Auto mount of web_static_* volumes at startup
## [1.3.0] - 2018-06-26
......
......@@ -64,7 +64,7 @@ Be sure you have no other program listening to the ports 80 and 443. To launch t
# ./start
```
By default all important data go to the SLARP installation directory. However you can adjust the values of these environment variables before starting: `VHOSTS_DIR`, `CERTS_DIR`, `APACHE_LOGS_DIR` and `CERTBOT_LOGS_DIR`.
Additionnally, you can use `STATIC_DIR` to define which path of your host will be mounted (read-only) into `/var/www/static` in the container. By default it uses the `static` directory in the SLARP installation directory. This option is useful if you want to define vhosts that serve static files of your host.
Additionnally, you can use `STATIC_DIR` to define which path of your host will be mounted (read-only) into `/var/www/static` in the container. By default it uses the `static` directory in the SLARP installation directory. This bind mount is useful if you want to define vhosts that serve static files of your host.
If a directory does not exist, the start command creates it. In particular, a first start without using these environment variables will create all directories in your SLARP location.
For example
......@@ -73,6 +73,8 @@ For example
```
runs the service with a customized location for the *vhosts* and the *certs*, but still keeps logs where SLARP is installed. Also, if you want to serve static contents, put your files into `/your-slarp-installation/static`.
If you have docker volumes whose name start with "web_static_*", the start command mounts them into `/var/www/static_*`. This feature is an alternative to the bind mount of the `static` folder, and is designed to serve directly the static data your backend containers are likely to share. For exemple, if you have a "web_static_searx" volume (let's say it's created as you start a "searx" container), this volume is mounted into `/var/www/static_searx` in the reverse proxy container.
Now a container named "slarp-reverse-proxy" is running, but for now it has nothing to forward.
### 5- Define your needs
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment