infrastructure/roles/static_websites/README.md

58 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2020-08-10 01:37:13 +02:00
static_websites
===============
This role provides the ability to deploy various static sites with out docker containers in a very easy way.
Requirements
------------
You will need to have docker, docker-compose and traefik installed or declared as dependencies with their respective roles.
**This role assumes that you have setup traefik with an endpoint called `websecure`.**
Role Variables
--------------
**Please look at the [defaults/main.yml](defaults/main.yml) for all available variables and their description.**
**Note: Lines that are commented out via `#` are usually still valid/used variables, but they are not defined by default, so they might enable a feature, when uncommenting/defining them!**
### Global variables, that are used:
- `proxy_network`: Defined by the local traefik installation, this is the shared proxy network used by traefik to reach the containers. (optional)
- `proxy_hiddenservice`: Defined by the local traefik installation, this is used to generate the alt-svc header for the alternative Tor domain. (optional)
### Example config:
```yaml
---
static_websites:
example:
image: docker.io/acme/example-site # docker image, can include a tag
domain: example.com # domain that is published by traefik
certresolver: letsencrypt_cf # specify traefik cert resolver (optional)
www: true # Add www. as alias (optional)
2020-08-10 01:37:13 +02:00
hsts: # HSTS advanced settings (optinal)
preloaded: true # enable preloaded header
subdomains: true # enable all subdomains header
nginx:
readonly: true
tmpfs:
"/tmp/nginx-cache": 1M
example2:
image: docker.io/acme/example-docs
domain: docs.example.com
```
Dependencies
------------
- docker
- docker-compose
- traefik
License
-------
GPL-3.0-only