📝 Update docs
parent
8ec630284a
commit
40d14922b9
|
@ -20,12 +20,12 @@ Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
nginx_sites:
|
nginx_sites:
|
||||||
# htpasswd on all site
|
# htpasswd on all site
|
||||||
- name: test.local
|
- name: test.local
|
||||||
htpasswd: 'hello'
|
htpasswd: 'hello'
|
||||||
template: '_base'
|
template: '_base'
|
||||||
|
|
||||||
# htpasswd only in /hello
|
# htpasswd only in /hello
|
||||||
- name: test-location.local
|
- name: test-location.local
|
||||||
template: '_base'
|
template: '_base'
|
||||||
location:
|
location:
|
||||||
|
|
10
doc/site.md
10
doc/site.md
|
@ -1,7 +1,7 @@
|
||||||
Site management
|
Site management
|
||||||
===============
|
===============
|
||||||
|
|
||||||
You can see many examples in: [tests/test.yml](../tests/test.yml).
|
You can see many examples in: [molecule/_shared/group_vars/all/main.yml](../molecule/_shared/group_vars/all/main.yml).
|
||||||
|
|
||||||
`nginx_sites`: List of dict. A site has few keys. See bellow.
|
`nginx_sites`: List of dict. A site has few keys. See bellow.
|
||||||
|
|
||||||
|
@ -34,7 +34,7 @@ Pre-built site config
|
||||||
- `redirect_to_code`: Redirect code (default: 302)
|
- `redirect_to_code`: Redirect code (default: 302)
|
||||||
- `redirect_https`: (O) Boolean. Redirect HTTP to HTTPS. If "true", you _MUST_ set `proto` to `['https']`.
|
- `redirect_https`: (O) Boolean. Redirect HTTP to HTTPS. If "true", you _MUST_ set `proto` to `['https']`.
|
||||||
- `location`: (O) Add new custom locations (it does not overwrite!)
|
- `location`: (O) Add new custom locations (it does not overwrite!)
|
||||||
- `location_order`: (O) Due to non preditive `location` order, you can provide the good order (see test-location.local in [tests/test.yml](../tests/test.yml)).
|
- `location_order`: (O) Due to non preditive `location` order, you can provide the good order (see test-location.local in [molecule/_shared/group_vars/all/main.yml](../molecule/_shared/group_vars/all/main.yml)).
|
||||||
- `location_before`: (O) Add new custom locations before generated location by template
|
- `location_before`: (O) Add new custom locations before generated location by template
|
||||||
- `location_order_before`: (O) Manages location order for `location_before`
|
- `location_order_before`: (O) Manages location order for `location_before`
|
||||||
- `more`: (O) Add more custom infos.
|
- `more`: (O) Add more custom infos.
|
||||||
|
@ -87,7 +87,7 @@ You can manage default site by setting domain name to these variables.
|
||||||
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- nginx_sites:
|
nginx_sites:
|
||||||
- name: 'mywebsite.com'
|
- name: 'mywebsite.com'
|
||||||
template: '_wordpress'
|
template: '_wordpress'
|
||||||
headers:
|
headers:
|
||||||
|
@ -108,7 +108,7 @@ You can add some extra infos if needed.
|
||||||
### Example:
|
### Example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- nginx_sites:
|
nginx_sites:
|
||||||
- name: 'mycustom-website.com'
|
- name: 'mycustom-website.com'
|
||||||
custom_template: 'my/template_dir/the-template.conf.j2'
|
custom_template: 'my/template_dir/the-template.conf.j2'
|
||||||
allow_admin: '192.168.0.0/24'
|
allow_admin: '192.168.0.0/24'
|
||||||
|
@ -137,5 +137,3 @@ server {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -32,7 +32,7 @@ You can use these variables if you use another task/role to manages your certifi
|
||||||
- `dest_cert`: remote path where certificate is located
|
- `dest_cert`: remote path where certificate is located
|
||||||
- `dest_key`: remote path where key is located
|
- `dest_key`: remote path where key is located
|
||||||
|
|
||||||
### Self signed
|
### Self-signed
|
||||||
|
|
||||||
Create a self-signed pair and deploy it. Do not use this feature in production.
|
Create a self-signed pair and deploy it. Do not use this feature in production.
|
||||||
|
|
||||||
|
@ -45,7 +45,7 @@ Uses acme.sh to create free certificates. It uses HTTP-01 challenge. Use this fe
|
||||||
|
|
||||||
- `acme`: set true to use this feature. It uses `name` (can be a string or string list).
|
- `acme`: set true to use this feature. It uses `name` (can be a string or string list).
|
||||||
|
|
||||||
Have a look to [acme configuration](acme.md configuration).
|
Have a look to [acme configuration](acme.md).
|
||||||
|
|
||||||
Tips
|
Tips
|
||||||
----
|
----
|
||||||
|
@ -61,7 +61,7 @@ Example
|
||||||
-------
|
-------
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
nginx_sites;
|
nginx_sites:
|
||||||
- name: 'test-ssl.local'
|
- name: 'test-ssl.local'
|
||||||
proto: ['http', 'https']
|
proto: ['http', 'https']
|
||||||
template: '_base'
|
template: '_base'
|
||||||
|
|
Loading…
Reference in New Issue