/
clients.yml.example
69 lines (66 loc) · 2.71 KB
/
clients.yml.example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# The "remap" dictionary is the central configuration store of client
# data in autodeflect. This data can be manually generated, machine
# generated or some combination of the two. Deflect uses a web
# interface for this data (https://dashboard.deflect.ca - open sourced
# code coming soon!).
# It's important that you sanitise this information extensively before
# allowing it into the clients.yml file. If you're allowing multi-line
# strings or similar into your configs, services may be disrupted.
remap:
site.example.com:
# Password used to retrieve information from awstats which is
# stored in the web interface cache. Doesn't get used by the user
# so can be randomly generated and long if used in combination
# with Dashboard. If not, make this a strong password to supply to
# users.
awstats_password: CHANGEME
# Password used to access the site's admin section. Can be empty
banjax_password: CHANGEME
# Path to be protected via Banjax auth page. If left empty no
# banjax rules will be written.
banjax_path: wp-admin
# How long to cache content by default
cache_time: 10
# Should we scrub logs for this site? If true, the logs will be
# written to a temporary file that is routinely removed. Logs will
# not be shipped offsite for centralisation.
disable_logging: false
dns_records:
# It's best to quote @s in this context.
'@':
- type: A
value: 192.168.2.1
- type: MX
value: [10, mail1.externalmail.example.com.]
- type: TXT
value: 'v=spf1 include:myspfstuff -all'
mail:
- type: MX
value: [20, mail1.externalmail.example.com.]
www:
- type: CNAME
value: site.example.com.
mobile:
- type: CNAME
value: site.example.com.
email: user@example.com
# hidden domain used to refer to origin in remaps on edge
# nodes. This will be obsolete in the next release of
# Autodeflect. The string should be random and long.
hidden: CHANGEME
# Use HTTPS? There are 4 options for "http_type". A certificate
# bundle must be present (probably uploaded by the client) for
# https options to work.
# - http_type: http <= plain http only
# - http_type: https <= both plain http and https
# - http_type: https_redirect <= return 301s for plain http to https
# - http_type: https_only <= disable plain http altogether
http_type: https_redirect
# The network to install the site on. Should be one of the dnets
# in site.yml.
network: mydnet
# IP address of the webserver actually serving the
# content. Ideally shouldn't be in the existing DNS records.
origin: 10.0.0.2
#site.example.edu:
# etc...