# HG changeset patch # User Luke Hoersten # Date 1593626971 18000 # Node ID 73eb2db468ecc3ffe9852892fc0197b2c391f96b # Parent b339d3c5150499d53d45c2692f09d14726deaea3# Parent 78a072bbf3c19e209d255d6d6031cd5e653f2405 merge diff -r 78a072bbf3c1 -r 73eb2db468ec .hgignore --- a/.hgignore Wed Jul 01 12:16:48 2020 -0500 +++ b/.hgignore Wed Jul 01 13:09:31 2020 -0500 @@ -1,9 +1,5 @@ syntax: regexp +~$ +\#.*\#$ +\.\# \.DS_Store$ -\.vagrant/ -\.tfstate\.backup$ -\.tfstate\.blank$ -\.terraform/ -TAGS$ -tags$ -^inventory/ diff -r 78a072bbf3c1 -r 73eb2db468ec adguard-home/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/adguard-home/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,12 @@ +--- + +adguard_home_arch: "arm" +adguard_home_tar: "https://static.adguard.com/adguardhome/release/AdGuardHome_linux_{{adguard_home_arch}}.tar.gz" +adguard_home_data_dir: "/var/lib/AdGuardHome" +adguard_home_filters: + - url: https://adguardteam.github.io/AdGuardSDNSFilter/Filters/filter.txt + name: AdGuard Simplified Domain Names filter + id: 1 + - url: https://abp.oisd.nl + name: oisd.nl + id: 2 diff -r 78a072bbf3c1 -r 73eb2db468ec adguard-home/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/adguard-home/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart adguard home + become: yes + systemd: name="AdGuardHome.service" enabled="yes" daemon_reload="yes" state="restarted" diff -r 78a072bbf3c1 -r 73eb2db468ec adguard-home/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/adguard-home/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,60 @@ +--- + +- name: unarchive adguard home + become: yes + unarchive: + remote_src: yes + src: "{{adguard_home_tar}}" + dest: "/tmp/" + creates: "/tmp/AdGuardHome/" + owner: "root" + group: "root" + +- name: install adguard home binary + become: yes + copy: + src: "/tmp/AdGuardHome/AdGuardHome" + dest: "/usr/local/bin/" + remote_src: yes + owner: "root" + group: "root" + mode: "0755" + notify: restart adguard home + +- name: create dirs + become: yes + file: + path: "{{item}}" + state: "directory" + owner: "root" + group: "root" + mode: "0755" + loop: + - "/etc/AdGuardHome" + - "{{adguard_home_data_dir}}" + notify: restart adguard home + +- name: configure adguard home service + become: yes + template: src="AdGuardHome.service.j2" dest="/etc/systemd/system/AdGuardHome.service" + notify: restart adguard home + +- name: configure adguard home + become: yes + template: src="AdGuardHome.yaml.j2" dest="/etc/AdGuardHome/AdGuardHome.yaml" + notify: restart adguard home + +- name: disable systemd-resolved service + become: yes + systemd: name="systemd-resolved.service" enabled="no" state="stopped" + +- name: replace systemd-resolved conf stub + become: yes + file: + src: "/run/systemd/resolve/resolv.conf" + dest: "/etc/resolv.conf" + state: "link" + +- name: ensure adguard home is started + become: yes + systemd: name="AdGuardHome.service" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec adguard-home/templates/AdGuardHome.service.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/adguard-home/templates/AdGuardHome.service.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,19 @@ +[Unit] +Description=AdGuard Home: Network-level blocker +After=syslog.target network-online.target + +[Service] +StartLimitInterval=5 +StartLimitBurst=10 +ExecStart=/usr/local/bin/AdGuardHome -c /etc/AdGuardHome/AdGuardHome.yaml -w {{adguard_home_data_dir}} + +WorkingDirectory={{adguard_home_data_dir}} + +StandardOutput=file:/var/log/AdGuardHome.out +StandardError=file:/var/log/AdGuardHome.err +Restart=always +RestartSec=10 +EnvironmentFile=-/etc/sysconfig/AdGuardHome + +[Install] +WantedBy=multi-user.target diff -r 78a072bbf3c1 -r 73eb2db468ec adguard-home/templates/AdGuardHome.yaml.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/adguard-home/templates/AdGuardHome.yaml.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,108 @@ +bind_host: 0.0.0.0 +bind_port: 80 +users: +- name: admin + password: $2a$10$Zs3krtMBhUxje0yHHIA/neADb56jsC/QlJHcjSxNVNtF72bBONJMW +http_proxy: "" +language: "" +rlimit_nofile: 0 +debug_pprof: false +web_session_ttl: 720 +dns: + bind_host: 0.0.0.0 + port: 53 + statistics_interval: 1 + querylog_enabled: true + querylog_interval: 90 + querylog_size_memory: 1000 + anonymize_client_ip: false + protection_enabled: true + blocking_mode: default + blocking_ipv4: "" + blocking_ipv6: "" + blocked_response_ttl: 10 + parental_block_host: family-block.dns.adguard.com + safebrowsing_block_host: standard-block.dns.adguard.com + ratelimit: 20 + ratelimit_whitelist: [] + refuse_any: true + upstream_dns: + - https://dns10.quad9.net/dns-query + bootstrap_dns: + - 9.9.9.10 + - 149.112.112.10 + - 2620:fe::10 + - 2620:fe::fe:10 + all_servers: false + fastest_addr: false + allowed_clients: [] + disallowed_clients: [] + blocked_hosts: [] + cache_size: 4194304 + cache_ttl_min: 0 + cache_ttl_max: 0 + bogus_nxdomain: [] + aaaa_disabled: false + enable_dnssec: false + edns_client_subnet: false + filtering_enabled: true + filters_update_interval: 24 + parental_enabled: false + safesearch_enabled: false + safebrowsing_enabled: false + safebrowsing_cache_size: 1048576 + safesearch_cache_size: 1048576 + parental_cache_size: 1048576 + cache_time: 30 + rewrites: [] + blocked_services: [] +tls: + enabled: false + server_name: "" + force_https: false + port_https: 443 + port_dns_over_tls: 853 + allow_unencrypted_doh: false + strict_sni_check: false + certificate_chain: "" + private_key: "" + certificate_path: "" + private_key_path: "" +filters: +{% for filter in adguard_home_filters %} +- enabled: true + url: {{filter.url}} + name: {{filter.name}} + id: {{filter.id}} +{% else %} [] +{% endfor %} +whitelist_filters: [] +user_rules: [] +dhcp: + enabled: false + interface_name: "" + gateway_ip: "" + subnet_mask: "" + range_start: "" + range_end: "" + lease_duration: 86400 + icmp_timeout_msec: 1000 +clients: +{% for client in adguard_home_clients %} +- name: {{client.name}} + tags: [] + ids: + - {{client.ip}} + use_global_settings: {{not client.bypass}} + filtering_enabled: false + parental_enabled: false + safesearch_enabled: false + safebrowsing_enabled: false + use_global_blocked_services: {{not client.bypass}} + blocked_services: [] + upstreams: [] +{% else %} [] +{% endfor %} +log_file: "" +verbose: false +schema_version: 6 diff -r 78a072bbf3c1 -r 73eb2db468ec apt-cacher/client/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/apt-cacher/client/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,3 @@ +--- + +apt_cacher_port: "3142" diff -r 78a072bbf3c1 -r 73eb2db468ec apt-cacher/client/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/apt-cacher/client/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,12 @@ +--- + +- name: check if running apt-cacher server + stat: path="/etc/apt-cacher-ng/acng.conf" + register: stat_server_conf + +- name: configure apt-cacher proxy + become: yes + template: + src: "02proxy.j2" + dest: "/etc/apt/apt.conf.d/02proxy" + when: not stat_server_conf.stat.exists diff -r 78a072bbf3c1 -r 73eb2db468ec apt-cacher/client/templates/02proxy.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/apt-cacher/client/templates/02proxy.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,1 @@ +Acquire::http::proxy "http://{{apt_cacher_host}}:{{apt_cacher_port}}"; diff -r 78a072bbf3c1 -r 73eb2db468ec apt-cacher/server/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/apt-cacher/server/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +apt_cacher_cache_dir: "/var/cache/apt-cacher-ng" +apt_cacher_log_dir: "/var/log/apt-cacher-ng" +apt_cacher_port: "3142" diff -r 78a072bbf3c1 -r 73eb2db468ec apt-cacher/server/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/apt-cacher/server/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,17 @@ +--- + +- name: install apt packages + become: yes + apt: name="apt-cacher-ng" + +- name: configure apt-cacher dirs + become: yes + lineinfile: + path: "/etc/apt-cacher-ng/acng.conf" + regexp: "^{{item.key}}:" + insertafter: "^# {{item.key}}:" + line: "{{item.key}}: {{item.val}}" + with_items: + - { key: "CacheDir", val: "{{apt_cacher_cache_dir}}" } + - { key: "LogDir", val: "{{apt_cacher_log_dir}}" } + - { key: "Port", val: "{{apt_cacher_port}}" } diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,6 @@ +--- + +aws_s3_backup_region: "us-east-1" +aws_s3_backup_pip_packages: + - "awscli" + - "boto3" diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/files/aws-s3-backup.target --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/files/aws-s3-backup.target Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,3 @@ +[Unit] +Description=AWS S3 backup target +StopWhenUnneeded=yes diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/files/aws-s3-backup.timer --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/files/aws-s3-backup.timer Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,10 @@ +[Unit] +Description=Daily AWS S3 backup + +[Timer] +OnCalendar=daily +Persistent=true +Unit=aws-s3-backup.target + +[Install] +WantedBy=timers.target diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,9 @@ +--- + +- name: reload timer + systemd: name="aws-s3-backup.timer" enabled="yes" daemon_reload="yes" + become: yes + +- name: reload target + systemd: name="aws-s3-backup.target" enabled="yes" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,38 @@ +--- + +- name: apt install pip + become: yes + apt: name="python3-pip" + +- name: pip install aws cli packages + become: yes + pip: name="{{aws_s3_backup_pip_packages}}" + +- name: create aws config dir for root + become: yes + file: path="/root/.aws/" state="directory" mode="0700" + +- name: configure aws credentials for root + become: yes + template: src="aws-{{item}}.j2" dest="/root/.aws/{{item}}" mode="0600" + with_items: + - "credentials" + - "config" + +- name: create systemd target + become: yes + copy: + src: "aws-s3-backup.target" + dest: "/lib/systemd/system/aws-s3-backup.target" + notify: reload target + +- name: create systemd timer + become: yes + copy: + src: "aws-s3-backup.timer" + dest: "/lib/systemd/system/aws-s3-backup.timer" + notify: reload timer + +- name: ensure timer is started + become: yes + systemd: name="aws-s3-backup.timer" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/templates/aws-config.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/templates/aws-config.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +# {{ansible_managed}} + +[default] +region={{aws_s3_backup_region}} +output=json diff -r 78a072bbf3c1 -r 73eb2db468ec aws-s3-backup/templates/aws-credentials.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/aws-s3-backup/templates/aws-credentials.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +# {{ansible_managed}} + +[default] +aws_access_key_id={{aws_access_key}} +aws_secret_access_key={{aws_secret_key}} diff -r 78a072bbf3c1 -r 73eb2db468ec block-device/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/block-device/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,7 @@ +--- + +block_device_user: "{{ansible_user}}" +block_device_group: "{{ansible_group}}" +block_device_mode: "0755" +block_device_umask: "0022" +block_device_opts: "defaults" diff -r 78a072bbf3c1 -r 73eb2db468ec block-device/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/block-device/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,17 @@ +--- + +- name: create mount point + become: yes + file: + path: "{{block_device_mount_point}}" + mode: "{{block_device_mode}}" + state: "directory" + +- name: mount block device + become: yes + mount: + path: "{{block_device_mount_point}}" + src: "{{block_device_uuid}}" + fstype: "{{block_device_fstype}}" + opts: "{{block_device_opts}}" + state: "mounted" diff -r 78a072bbf3c1 -r 73eb2db468ec homebridge/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/homebridge/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,9 @@ +--- + +homebridge_user: "homebridge" +homebridge_groups: "video" +homebridge_dir: "/home/{{homebridge_user}}" +homebridge_restart_sec: "10" + +homebridge_pin: "031-45-154" +homebridge_port: "51900" diff -r 78a072bbf3c1 -r 73eb2db468ec homebridge/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/homebridge/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart homebridge service + systemd: name="homebridge" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec homebridge/meta/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/homebridge/meta/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,4 @@ +--- + +dependencies: + - nodejs diff -r 78a072bbf3c1 -r 73eb2db468ec homebridge/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/homebridge/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,54 @@ +--- + +- name: create homebridge user + become: yes + user: + name: "{{homebridge_user}}" + comment: "Homebridge" + shell: "/bin/false" + home: "{{homebridge_dir}}" + groups: "{{homebridge_groups}}" + move_home: yes + notify: restart homebridge service + +- name: create homebridge directory + become: yes + file: + path: "{{homebridge_dir}}" + state: "directory" + owner: "{{homebridge_user}}" + group: "{{homebridge_user}}" + mode: "0755" + +- name: install homebridge apt deps + become: yes + apt: name="{{homebridge_apt_packages}}" + +- name: install homebridge + become: yes + npm: name="homebridge" global="yes" + notify: restart homebridge service + +- name: install platform accessories + become: yes + npm: name="{{item}}" global="yes" + with_items: "{{homebridge_npm_packages}}" + notify: restart homebridge service + +- name: configure homebridge + become: yes + template: + src: "{{homebridge_config_template}}" + dest: "{{homebridge_dir}}/config.json" + notify: restart homebridge service + +- name: configure systemd service + become: yes + template: + src: "homebridge.service.j2" + dest: "/lib/systemd/system/homebridge.service" + notify: restart homebridge service + +- name: ensure homebridge is started + become: yes + systemd: name="homebridge.service" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec homebridge/templates/homebridge.service.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/homebridge/templates/homebridge.service.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,16 @@ +# {{ansible_managed}} + +[Unit] +Description=Homebridge + +[Service] +User={{homebridge_user}} +Group={{homebridge_user}} +Restart=always +RestartSec={{homebridge_restart_sec}} + +WorkingDirectory={{homebridge_dir}} +ExecStart=/usr/bin/node /opt/{{nodejs_dir}}/bin/homebridge -U {{homebridge_dir}} + +[Install] +WantedBy=default.target diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,8 @@ +--- + +matrix_synapse_enable_registrations: "false" +matrix_synapse_sqlite_db: "/var/lib/matrix-synapse/homeserver.db" +matrix_synapse_media_store: "/var/lib/matrix-synapse/media" +matrix_synapse_pgsql_user: "synapse" +matrix_synapse_pgsql_db: "synapse" +matrix_synapse_pgsql_host: "localhost" diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart matrix synapse service + systemd: name="matrix-synapse.service" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,73 @@ +--- + +- name: add debian backports keys + become: yes + apt_key: + keyserver: "keyserver.ubuntu.com" + id: "{{item}}" + loop: + - "04EE7237B7D453EC" + - "648ACFD622F3D138" + +- name: add matrix repo + become: yes + apt_repository: repo="deb http://deb.debian.org/debian buster-backports main" + +- name: install matrix synapse + become: yes + apt: + name: "matrix-synapse" + state: "latest" + default_release: "buster-backports" + notify: restart matrix synapse service + +- name: create log file + become: yes + file: + path: "/var/log/matrix-synapse/homeserver.log" + owner: "matrix-synapse" + group: "root" + state: "touch" + mode: "0644" + changed_when: false + +- name: create media data dir + become: yes + file: + path: "{{matrix_synapse_media_store}}" + owner: "matrix-synapse" + group: "root" + state: "directory" + recurse: yes + mode: "0750" + +- name: configure matrix synapse + become: yes + template: + src: "{{item.src}}" + dest: "{{item.dest}}" + notify: restart matrix synapse service + loop: + - { src: "homeserver.yaml.j2", dest: "/etc/matrix-synapse/homeserver.yaml" } + - { src: "log.yaml.j2", dest: "/etc/matrix-synapse/log.yaml" } + - { src: "server_name.yaml.j2", dest: "/etc/matrix-synapse/conf.d/server_name.yaml" } + +- name: install db schema file + become: yes + template: + src: "setup_db.psql.j2" + dest: "/tmp/setup_db_{{matrix_synapse_pgsql_db}}.psql" + owner: "postgres" + group: "postgres" + mode: "0600" + changed_when: false + +- name: install psql + become: yes + become_user: "postgres" + command: "psql -f /tmp/setup_db_{{matrix_synapse_pgsql_db}}.psql" + changed_when: false + +- name: ensure matrix synapse is started + become: yes + systemd: name="matrix-synapse.service" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/templates/homeserver.yaml.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/templates/homeserver.yaml.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,2010 @@ +# Configuration file for Synapse. +# +# This is a YAML file: see [1] for a quick introduction. Note in particular +# that *indentation is important*: all the elements of a list or dictionary +# should have the same indentation. +# +# [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html + +## Server ## + +# The domain name of the server, with optional explicit port. +# This is used by remote servers to connect to this server, +# e.g. matrix.org, localhost:8080, etc. +# This is also the last part of your UserID. +# +server_name: "{{matrix_synapse_server_name}}" + +# When running as a daemon, the file to store the pid in +# +pid_file: "/var/run/matrix-synapse.pid" + +# The absolute URL to the web client which /_matrix/client will redirect +# to if 'webclient' is configured under the 'listeners' configuration. +# +# This option can be also set to the filesystem path to the web client +# which will be served at /_matrix/client/ if 'webclient' is configured +# under the 'listeners' configuration, however this is a security risk: +# https://github.com/matrix-org/synapse#security-note +# +#web_client_location: https://riot.example.com/ + +# The public-facing base URL that clients use to access this HS +# (not including _matrix/...). This is the same URL a user would +# enter into the 'custom HS URL' field on their client. If you +# use synapse with a reverse proxy, this should be the URL to reach +# synapse via the proxy. +# +#public_baseurl: https://example.com/ + +# Set the soft limit on the number of file descriptors synapse can use +# Zero is used to indicate synapse should set the soft limit to the +# hard limit. +# +#soft_file_limit: 0 + +# Set to false to disable presence tracking on this homeserver. +# +#use_presence: false + +# Whether to require authentication to retrieve profile data (avatars, +# display names) of other users through the client API. Defaults to +# 'false'. Note that profile data is also available via the federation +# API, so this setting is of limited value if federation is enabled on +# the server. +# +#require_auth_for_profile_requests: true + +# Uncomment to require a user to share a room with another user in order +# to retrieve their profile information. Only checked on Client-Server +# requests. Profile requests from other servers should be checked by the +# requesting server. Defaults to 'false'. +# +#limit_profile_requests_to_users_who_share_rooms: true + +# If set to 'true', removes the need for authentication to access the server's +# public rooms directory through the client API, meaning that anyone can +# query the room directory. Defaults to 'false'. +# +#allow_public_rooms_without_auth: true + +# If set to 'true', allows any other homeserver to fetch the server's public +# rooms directory via federation. Defaults to 'false'. +# +#allow_public_rooms_over_federation: true + +# The default room version for newly created rooms. +# +# Known room versions are listed here: +# https://matrix.org/docs/spec/#complete-list-of-room-versions +# +# For example, for room version 1, default_room_version should be set +# to "1". +# +#default_room_version: "5" + +# The GC threshold parameters to pass to `gc.set_threshold`, if defined +# +#gc_thresholds: [700, 10, 10] + +# Set the limit on the returned events in the timeline in the get +# and sync operations. The default value is -1, means no upper limit. +# +#filter_timeline_limit: 5000 + +# Whether room invites to users on this server should be blocked +# (except those sent by local server admins). The default is False. +# +#block_non_admin_invites: true + +# Room searching +# +# If disabled, new messages will not be indexed for searching and users +# will receive errors when searching for messages. Defaults to enabled. +# +#enable_search: false + +# Restrict federation to the following whitelist of domains. +# N.B. we recommend also firewalling your federation listener to limit +# inbound federation traffic as early as possible, rather than relying +# purely on this application-layer restriction. If not specified, the +# default is to whitelist everything. +# +#federation_domain_whitelist: +# - lon.example.com +# - nyc.example.com +# - syd.example.com + +# Prevent federation requests from being sent to the following +# blacklist IP address CIDR ranges. If this option is not specified, or +# specified with an empty list, no ip range blacklist will be enforced. +# +# As of Synapse v1.4.0 this option also affects any outbound requests to identity +# servers provided by user input. +# +# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly +# listed here, since they correspond to unroutable addresses.) +# +federation_ip_range_blacklist: + - '127.0.0.0/8' + - '10.0.0.0/8' + - '172.16.0.0/12' + - '192.168.0.0/16' + - '100.64.0.0/10' + - '169.254.0.0/16' + - '::1/128' + - 'fe80::/64' + - 'fc00::/7' + +# List of ports that Synapse should listen on, their purpose and their +# configuration. +# +# Options for each listener include: +# +# port: the TCP port to bind to +# +# bind_addresses: a list of local addresses to listen on. The default is +# 'all local interfaces'. +# +# type: the type of listener. Normally 'http', but other valid options are: +# 'manhole' (see docs/manhole.md), +# 'metrics' (see docs/metrics-howto.md), +# 'replication' (see docs/workers.md). +# +# tls: set to true to enable TLS for this listener. Will use the TLS +# key/cert specified in tls_private_key_path / tls_certificate_path. +# +# x_forwarded: Only valid for an 'http' listener. Set to true to use the +# X-Forwarded-For header as the client IP. Useful when Synapse is +# behind a reverse-proxy. +# +# resources: Only valid for an 'http' listener. A list of resources to host +# on this port. Options for each resource are: +# +# names: a list of names of HTTP resources. See below for a list of +# valid resource names. +# +# compress: set to true to enable HTTP comression for this resource. +# +# additional_resources: Only valid for an 'http' listener. A map of +# additional endpoints which should be loaded via dynamic modules. +# +# Valid resource names are: +# +# client: the client-server API (/_matrix/client), and the synapse admin +# API (/_synapse/admin). Also implies 'media' and 'static'. +# +# consent: user consent forms (/_matrix/consent). See +# docs/consent_tracking.md. +# +# federation: the server-server API (/_matrix/federation). Also implies +# 'media', 'keys', 'openid' +# +# keys: the key discovery API (/_matrix/keys). +# +# media: the media API (/_matrix/media). +# +# metrics: the metrics interface. See docs/metrics-howto.md. +# +# openid: OpenID authentication. +# +# replication: the HTTP replication API (/_synapse/replication). See +# docs/workers.md. +# +# static: static resources under synapse/static (/_matrix/static). (Mostly +# useful for 'fallback authentication'.) +# +# webclient: A web client. Requires web_client_location to be set. +# +listeners: + # TLS-enabled listener: for when matrix traffic is sent directly to synapse. + # + # Disabled by default. To enable it, uncomment the following. (Note that you + # will also need to give Synapse a TLS key and certificate: see the TLS section + # below.) + # + #- port: 8448 + # type: http + # tls: true + # resources: + # - names: [client, federation] + + # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy + # that unwraps TLS. + # + # If you plan to use a reverse proxy, please see + # https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md. + # + - port: 8008 + tls: false + type: http + x_forwarded: true + bind_addresses: ['::1', '127.0.0.1'] + + resources: + - names: [client, federation] + compress: false + + # example additional_resources: + # + #additional_resources: + # "/_matrix/my/custom/endpoint": + # module: my_module.CustomRequestHandler + # config: {} + + # Turn on the twisted ssh manhole service on localhost on the given + # port. + # + #- port: 9000 + # bind_addresses: ['::1', '127.0.0.1'] + # type: manhole + +# Forward extremities can build up in a room due to networking delays between +# homeservers. Once this happens in a large room, calculation of the state of +# that room can become quite expensive. To mitigate this, once the number of +# forward extremities reaches a given threshold, Synapse will send an +# org.matrix.dummy_event event, which will reduce the forward extremities +# in the room. +# +# This setting defines the threshold (i.e. number of forward extremities in the +# room) at which dummy events are sent. The default value is 10. +# +#dummy_events_threshold: 5 + + +## Homeserver blocking ## + +# How to reach the server admin, used in ResourceLimitError +# +#admin_contact: 'mailto:admin@server.com' + +# Global blocking +# +#hs_disabled: false +#hs_disabled_message: 'Human readable reason for why the HS is blocked' + +# Monthly Active User Blocking +# +# Used in cases where the admin or server owner wants to limit to the +# number of monthly active users. +# +# 'limit_usage_by_mau' disables/enables monthly active user blocking. When +# anabled and a limit is reached the server returns a 'ResourceLimitError' +# with error type Codes.RESOURCE_LIMIT_EXCEEDED +# +# 'max_mau_value' is the hard limit of monthly active users above which +# the server will start blocking user actions. +# +# 'mau_trial_days' is a means to add a grace period for active users. It +# means that users must be active for this number of days before they +# can be considered active and guards against the case where lots of users +# sign up in a short space of time never to return after their initial +# session. +# +# 'mau_limit_alerting' is a means of limiting client side alerting +# should the mau limit be reached. This is useful for small instances +# where the admin has 5 mau seats (say) for 5 specific people and no +# interest increasing the mau limit further. Defaults to True, which +# means that alerting is enabled +# +#limit_usage_by_mau: false +#max_mau_value: 50 +#mau_trial_days: 2 +#mau_limit_alerting: false + +# If enabled, the metrics for the number of monthly active users will +# be populated, however no one will be limited. If limit_usage_by_mau +# is true, this is implied to be true. +# +#mau_stats_only: false + +# Sometimes the server admin will want to ensure certain accounts are +# never blocked by mau checking. These accounts are specified here. +# +#mau_limit_reserved_threepids: +# - medium: 'email' +# address: 'reserved_user@example.com' + +# Used by phonehome stats to group together related servers. +#server_context: context + +# Resource-constrained homeserver Settings +# +# If limit_remote_rooms.enabled is True, the room complexity will be +# checked before a user joins a new remote room. If it is above +# limit_remote_rooms.complexity, it will disallow joining or +# instantly leave. +# +# limit_remote_rooms.complexity_error can be set to customise the text +# displayed to the user when a room above the complexity threshold has +# its join cancelled. +# +# Uncomment the below lines to enable: +#limit_remote_rooms: +# enabled: true +# complexity: 1.0 +# complexity_error: "This room is too complex." + +# Whether to require a user to be in the room to add an alias to it. +# Defaults to 'true'. +# +#require_membership_for_aliases: false + +# Whether to allow per-room membership profiles through the send of membership +# events with profile information that differ from the target's global profile. +# Defaults to 'true'. +# +#allow_per_room_profiles: false + +# How long to keep redacted events in unredacted form in the database. After +# this period redacted events get replaced with their redacted form in the DB. +# +# Defaults to `7d`. Set to `null` to disable. +# +#redaction_retention_period: 28d + +# How long to track users' last seen time and IPs in the database. +# +# Defaults to `28d`. Set to `null` to disable clearing out of old rows. +# +#user_ips_max_age: 14d + +# Message retention policy at the server level. +# +# Room admins and mods can define a retention period for their rooms using the +# 'm.room.retention' state event, and server admins can cap this period by setting +# the 'allowed_lifetime_min' and 'allowed_lifetime_max' config options. +# +# If this feature is enabled, Synapse will regularly look for and purge events +# which are older than the room's maximum retention period. Synapse will also +# filter events received over federation so that events that should have been +# purged are ignored and not stored again. +# +retention: + # The message retention policies feature is disabled by default. Uncomment the + # following line to enable it. + # + #enabled: true + + # Default retention policy. If set, Synapse will apply it to rooms that lack the + # 'm.room.retention' state event. Currently, the value of 'min_lifetime' doesn't + # matter much because Synapse doesn't take it into account yet. + # + #default_policy: + # min_lifetime: 1d + # max_lifetime: 1y + + # Retention policy limits. If set, a user won't be able to send a + # 'm.room.retention' event which features a 'min_lifetime' or a 'max_lifetime' + # that's not within this range. This is especially useful in closed federations, + # in which server admins can make sure every federating server applies the same + # rules. + # + #allowed_lifetime_min: 1d + #allowed_lifetime_max: 1y + + # Server admins can define the settings of the background jobs purging the + # events which lifetime has expired under the 'purge_jobs' section. + # + # If no configuration is provided, a single job will be set up to delete expired + # events in every room daily. + # + # Each job's configuration defines which range of message lifetimes the job + # takes care of. For example, if 'shortest_max_lifetime' is '2d' and + # 'longest_max_lifetime' is '3d', the job will handle purging expired events in + # rooms whose state defines a 'max_lifetime' that's both higher than 2 days, and + # lower than or equal to 3 days. Both the minimum and the maximum value of a + # range are optional, e.g. a job with no 'shortest_max_lifetime' and a + # 'longest_max_lifetime' of '3d' will handle every room with a retention policy + # which 'max_lifetime' is lower than or equal to three days. + # + # The rationale for this per-job configuration is that some rooms might have a + # retention policy with a low 'max_lifetime', where history needs to be purged + # of outdated messages on a more frequent basis than for the rest of the rooms + # (e.g. every 12h), but not want that purge to be performed by a job that's + # iterating over every room it knows, which could be heavy on the server. + # + #purge_jobs: + # - shortest_max_lifetime: 1d + # longest_max_lifetime: 3d + # interval: 12h + # - shortest_max_lifetime: 3d + # longest_max_lifetime: 1y + # interval: 1d + +# Inhibits the /requestToken endpoints from returning an error that might leak +# information about whether an e-mail address is in use or not on this +# homeserver. +# Note that for some endpoints the error situation is the e-mail already being +# used, and for others the error is entering the e-mail being unused. +# If this option is enabled, instead of returning an error, these endpoints will +# act as if no error happened and return a fake session ID ('sid') to clients. +# +#request_token_inhibit_3pid_errors: true + + +## TLS ## + +# PEM-encoded X509 certificate for TLS. +# This certificate, as of Synapse 1.0, will need to be a valid and verifiable +# certificate, signed by a recognised Certificate Authority. +# +# See 'ACME support' below to enable auto-provisioning this certificate via +# Let's Encrypt. +# +# If supplying your own, be sure to use a `.pem` file that includes the +# full certificate chain including any intermediate certificates (for +# instance, if using certbot, use `fullchain.pem` as your certificate, +# not `cert.pem`). +# +#tls_certificate_path: "path/to/homeserver.tls.crt" + +# PEM-encoded private key for TLS +# +#tls_private_key_path: "path/to/homeserver.tls.key" + +# Whether to verify TLS server certificates for outbound federation requests. +# +# Defaults to `true`. To disable certificate verification, uncomment the +# following line. +# +#federation_verify_certificates: false + +# The minimum TLS version that will be used for outbound federation requests. +# +# Defaults to `1`. Configurable to `1`, `1.1`, `1.2`, or `1.3`. Note +# that setting this value higher than `1.2` will prevent federation to most +# of the public Matrix network: only configure it to `1.3` if you have an +# entirely private federation setup and you can ensure TLS 1.3 support. +# +#federation_client_minimum_tls_version: 1.2 + +# Skip federation certificate verification on the following whitelist +# of domains. +# +# This setting should only be used in very specific cases, such as +# federation over Tor hidden services and similar. For private networks +# of homeservers, you likely want to use a private CA instead. +# +# Only effective if federation_verify_certicates is `true`. +# +#federation_certificate_verification_whitelist: +# - lon.example.com +# - *.domain.com +# - *.onion + +# List of custom certificate authorities for federation traffic. +# +# This setting should only normally be used within a private network of +# homeservers. +# +# Note that this list will replace those that are provided by your +# operating environment. Certificates must be in PEM format. +# +#federation_custom_ca_list: +# - myCA1.pem +# - myCA2.pem +# - myCA3.pem + +# ACME support: This will configure Synapse to request a valid TLS certificate +# for your configured `server_name` via Let's Encrypt. +# +# Note that ACME v1 is now deprecated, and Synapse currently doesn't support +# ACME v2. This means that this feature currently won't work with installs set +# up after November 2019. For more info, and alternative solutions, see +# https://github.com/matrix-org/synapse/blob/master/docs/ACME.md#deprecation-of-acme-v1 +# +# Note that provisioning a certificate in this way requires port 80 to be +# routed to Synapse so that it can complete the http-01 ACME challenge. +# By default, if you enable ACME support, Synapse will attempt to listen on +# port 80 for incoming http-01 challenges - however, this will likely fail +# with 'Permission denied' or a similar error. +# +# There are a couple of potential solutions to this: +# +# * If you already have an Apache, Nginx, or similar listening on port 80, +# you can configure Synapse to use an alternate port, and have your web +# server forward the requests. For example, assuming you set 'port: 8009' +# below, on Apache, you would write: +# +# ProxyPass /.well-known/acme-challenge http://localhost:8009/.well-known/acme-challenge +# +# * Alternatively, you can use something like `authbind` to give Synapse +# permission to listen on port 80. +# +acme: + # ACME support is disabled by default. Set this to `true` and uncomment + # tls_certificate_path and tls_private_key_path above to enable it. + # + enabled: false + + # Endpoint to use to request certificates. If you only want to test, + # use Let's Encrypt's staging url: + # https://acme-staging.api.letsencrypt.org/directory + # + #url: https://acme-v01.api.letsencrypt.org/directory + + # Port number to listen on for the HTTP-01 challenge. Change this if + # you are forwarding connections through Apache/Nginx/etc. + # + port: 80 + + # Local addresses to listen on for incoming connections. + # Again, you may want to change this if you are forwarding connections + # through Apache/Nginx/etc. + # + bind_addresses: ['::', '0.0.0.0'] + + # How many days remaining on a certificate before it is renewed. + # + reprovision_threshold: 30 + + # The domain that the certificate should be for. Normally this + # should be the same as your Matrix domain (i.e., 'server_name'), but, + # by putting a file at 'https:///.well-known/matrix/server', + # you can delegate incoming traffic to another server. If you do that, + # you should give the target of the delegation here. + # + # For example: if your 'server_name' is 'example.com', but + # 'https://example.com/.well-known/matrix/server' delegates to + # 'matrix.example.com', you should put 'matrix.example.com' here. + # + # If not set, defaults to your 'server_name'. + # + domain: matrix.example.com + + # file to use for the account key. This will be generated if it doesn't + # exist. + # + # If unspecified, we will use CONFDIR/client.key. + # + account_key_file: path/to/homeserver/acme_account.key + +# List of allowed TLS fingerprints for this server to publish along +# with the signing keys for this server. Other matrix servers that +# make HTTPS requests to this server will check that the TLS +# certificates returned by this server match one of the fingerprints. +# +# Synapse automatically adds the fingerprint of its own certificate +# to the list. So if federation traffic is handled directly by synapse +# then no modification to the list is required. +# +# If synapse is run behind a load balancer that handles the TLS then it +# will be necessary to add the fingerprints of the certificates used by +# the loadbalancers to this list if they are different to the one +# synapse is using. +# +# Homeservers are permitted to cache the list of TLS fingerprints +# returned in the key responses up to the "valid_until_ts" returned in +# key. It may be necessary to publish the fingerprints of a new +# certificate and wait until the "valid_until_ts" of the previous key +# responses have passed before deploying it. +# +# You can calculate a fingerprint from a given TLS listener via: +# openssl s_client -connect $host:$port < /dev/null 2> /dev/null | +# openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '=' +# or by checking matrix.org/federationtester/api/report?server_name=$host +# +#tls_fingerprints: [{"sha256": ""}] + + + +## Database ## + +# The 'database' setting defines the database that synapse uses to store all of +# its data. +# +# 'name' gives the database engine to use: either 'sqlite3' (for SQLite) or +# 'psycopg2' (for PostgreSQL). +# +# 'args' gives options which are passed through to the database engine, +# except for options starting 'cp_', which are used to configure the Twisted +# connection pool. For a reference to valid arguments, see: +# * for sqlite: https://docs.python.org/3/library/sqlite3.html#sqlite3.connect +# * for postgres: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS +# * for the connection pool: https://twistedmatrix.com/documents/current/api/twisted.enterprise.adbapi.ConnectionPool.html#__init__ +# +# +# Example SQLite configuration: +# +#database: +# name: sqlite3 +# args: +# database: /path/to/homeserver.db +# +# +# Example Postgres configuration: +# +#database: +# name: psycopg2 +# args: +# user: synapse +# password: secretpassword +# database: synapse +# host: localhost +# cp_min: 5 +# cp_max: 10 +# +# For more information on using Synapse with Postgres, see `docs/postgres.md`. +# +# database: +# name: sqlite3 +# args: +# database: "{{matrix_synapse_sqlite_db}}" + +database: + name: psycopg2 + args: + user: "{{matrix_synapse_pgsql_user}}" + password: "{{matrix_synapse_pgsql_pass}}" + database: "{{matrix_synapse_pgsql_db}}" + host: "{{matrix_synapse_pgsql_host}}" + cp_min: 5 + cp_max: 10 + +# Number of events to cache in memory. +# +#event_cache_size: 10K + + +## Logging ## + +# A yaml python logging config file as described by +# https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema +# +log_config: "/etc/matrix-synapse/log.yaml" + + +## Ratelimiting ## + +# Ratelimiting settings for client actions (registration, login, messaging). +# +# Each ratelimiting configuration is made of two parameters: +# - per_second: number of requests a client can send per second. +# - burst_count: number of requests a client can send before being throttled. +# +# Synapse currently uses the following configurations: +# - one for messages that ratelimits sending based on the account the client +# is using +# - one for registration that ratelimits registration requests based on the +# client's IP address. +# - one for login that ratelimits login requests based on the client's IP +# address. +# - one for login that ratelimits login requests based on the account the +# client is attempting to log into. +# - one for login that ratelimits login requests based on the account the +# client is attempting to log into, based on the amount of failed login +# attempts for this account. +# - one for ratelimiting redactions by room admins. If this is not explicitly +# set then it uses the same ratelimiting as per rc_message. This is useful +# to allow room admins to deal with abuse quickly. +# +# The defaults are as shown below. +# +#rc_message: +# per_second: 0.2 +# burst_count: 10 +# +#rc_registration: +# per_second: 0.17 +# burst_count: 3 +# +#rc_login: +# address: +# per_second: 0.17 +# burst_count: 3 +# account: +# per_second: 0.17 +# burst_count: 3 +# failed_attempts: +# per_second: 0.17 +# burst_count: 3 +# +#rc_admin_redaction: +# per_second: 1 +# burst_count: 50 + + +# Ratelimiting settings for incoming federation +# +# The rc_federation configuration is made up of the following settings: +# - window_size: window size in milliseconds +# - sleep_limit: number of federation requests from a single server in +# a window before the server will delay processing the request. +# - sleep_delay: duration in milliseconds to delay processing events +# from remote servers by if they go over the sleep limit. +# - reject_limit: maximum number of concurrent federation requests +# allowed from a single server +# - concurrent: number of federation requests to concurrently process +# from a single server +# +# The defaults are as shown below. +# +#rc_federation: +# window_size: 1000 +# sleep_limit: 10 +# sleep_delay: 500 +# reject_limit: 50 +# concurrent: 3 + +# Target outgoing federation transaction frequency for sending read-receipts, +# per-room. +# +# If we end up trying to send out more read-receipts, they will get buffered up +# into fewer transactions. +# +#federation_rr_transactions_per_room_per_second: 50 + + + +## Media Store ## + +# Enable the media store service in the Synapse master. Uncomment the +# following if you are using a separate media store worker. +# +#enable_media_repo: false + +# Directory where uploaded images and attachments are stored. +# +media_store_path: "{{matrix_synapse_media_store}}" + +# Media storage providers allow media to be stored in different +# locations. +# +#media_storage_providers: +# - module: file_system +# # Whether to store newly uploaded local files +# store_local: false +# # Whether to store newly downloaded remote files +# store_remote: false +# # Whether to wait for successful storage for local uploads +# store_synchronous: false +# config: +# directory: /mnt/some/other/directory + +# The largest allowed upload size in bytes +# +#max_upload_size: 10M + +# Maximum number of pixels that will be thumbnailed +# +#max_image_pixels: 32M + +# Whether to generate new thumbnails on the fly to precisely match +# the resolution requested by the client. If true then whenever +# a new resolution is requested by the client the server will +# generate a new thumbnail. If false the server will pick a thumbnail +# from a precalculated list. +# +#dynamic_thumbnails: false + +# List of thumbnails to precalculate when an image is uploaded. +# +#thumbnail_sizes: +# - width: 32 +# height: 32 +# method: crop +# - width: 96 +# height: 96 +# method: crop +# - width: 320 +# height: 240 +# method: scale +# - width: 640 +# height: 480 +# method: scale +# - width: 800 +# height: 600 +# method: scale + +# Is the preview URL API enabled? +# +# 'false' by default: uncomment the following to enable it (and specify a +# url_preview_ip_range_blacklist blacklist). +# +#url_preview_enabled: true + +# List of IP address CIDR ranges that the URL preview spider is denied +# from accessing. There are no defaults: you must explicitly +# specify a list for URL previewing to work. You should specify any +# internal services in your network that you do not want synapse to try +# to connect to, otherwise anyone in any Matrix room could cause your +# synapse to issue arbitrary GET requests to your internal services, +# causing serious security issues. +# +# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly +# listed here, since they correspond to unroutable addresses.) +# +# This must be specified if url_preview_enabled is set. It is recommended that +# you uncomment the following list as a starting point. +# +#url_preview_ip_range_blacklist: +# - '127.0.0.0/8' +# - '10.0.0.0/8' +# - '172.16.0.0/12' +# - '192.168.0.0/16' +# - '100.64.0.0/10' +# - '169.254.0.0/16' +# - '::1/128' +# - 'fe80::/64' +# - 'fc00::/7' + +# List of IP address CIDR ranges that the URL preview spider is allowed +# to access even if they are specified in url_preview_ip_range_blacklist. +# This is useful for specifying exceptions to wide-ranging blacklisted +# target IP ranges - e.g. for enabling URL previews for a specific private +# website only visible in your network. +# +#url_preview_ip_range_whitelist: +# - '192.168.1.1' + +# Optional list of URL matches that the URL preview spider is +# denied from accessing. You should use url_preview_ip_range_blacklist +# in preference to this, otherwise someone could define a public DNS +# entry that points to a private IP address and circumvent the blacklist. +# This is more useful if you know there is an entire shape of URL that +# you know that will never want synapse to try to spider. +# +# Each list entry is a dictionary of url component attributes as returned +# by urlparse.urlsplit as applied to the absolute form of the URL. See +# https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit +# The values of the dictionary are treated as an filename match pattern +# applied to that component of URLs, unless they start with a ^ in which +# case they are treated as a regular expression match. If all the +# specified component matches for a given list item succeed, the URL is +# blacklisted. +# +#url_preview_url_blacklist: +# # blacklist any URL with a username in its URI +# - username: '*' +# +# # blacklist all *.google.com URLs +# - netloc: 'google.com' +# - netloc: '*.google.com' +# +# # blacklist all plain HTTP URLs +# - scheme: 'http' +# +# # blacklist http(s)://www.acme.com/foo +# - netloc: 'www.acme.com' +# path: '/foo' +# +# # blacklist any URL with a literal IPv4 address +# - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$' + +# The largest allowed URL preview spidering size in bytes +# +#max_spider_size: 10M + +# A list of values for the Accept-Language HTTP header used when +# downloading webpages during URL preview generation. This allows +# Synapse to specify the preferred languages that URL previews should +# be in when communicating with remote servers. +# +# Each value is a IETF language tag; a 2-3 letter identifier for a +# language, optionally followed by subtags separated by '-', specifying +# a country or region variant. +# +# Multiple values can be provided, and a weight can be added to each by +# using quality value syntax (;q=). '*' translates to any language. +# +# Defaults to "en". +# +# Example: +# +# url_preview_accept_language: +# - en-UK +# - en-US;q=0.9 +# - fr;q=0.8 +# - *;q=0.7 +# +url_preview_accept_language: +# - en + + +## Captcha ## +# See docs/CAPTCHA_SETUP for full details of configuring this. + +# This homeserver's ReCAPTCHA public key. +# +#recaptcha_public_key: "YOUR_PUBLIC_KEY" + +# This homeserver's ReCAPTCHA private key. +# +#recaptcha_private_key: "YOUR_PRIVATE_KEY" + +# Enables ReCaptcha checks when registering, preventing signup +# unless a captcha is answered. Requires a valid ReCaptcha +# public/private key. +# +#enable_registration_captcha: false + +# The API endpoint to use for verifying m.login.recaptcha responses. +# +#recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify" + + +## TURN ## + +# The public URIs of the TURN server to give to clients +# +#turn_uris: [] + +# The shared secret used to compute passwords for the TURN server +# +#turn_shared_secret: "YOUR_SHARED_SECRET" + +# The Username and password if the TURN server needs them and +# does not use a token +# +#turn_username: "TURNSERVER_USERNAME" +#turn_password: "TURNSERVER_PASSWORD" + +# How long generated TURN credentials last +# +#turn_user_lifetime: 1h + +# Whether guests should be allowed to use the TURN server. +# This defaults to True, otherwise VoIP will be unreliable for guests. +# However, it does introduce a slight security risk as it allows users to +# connect to arbitrary endpoints without having first signed up for a +# valid account (e.g. by passing a CAPTCHA). +# +#turn_allow_guests: true + + +## Registration ## +# +# Registration can be rate-limited using the parameters in the "Ratelimiting" +# section of this file. + +# Enable registration for new users. +# +enable_registration: {{matrix_synapse_enable_registrations}} + +# Optional account validity configuration. This allows for accounts to be denied +# any request after a given period. +# +# Once this feature is enabled, Synapse will look for registered users without an +# expiration date at startup and will add one to every account it found using the +# current settings at that time. +# This means that, if a validity period is set, and Synapse is restarted (it will +# then derive an expiration date from the current validity period), and some time +# after that the validity period changes and Synapse is restarted, the users' +# expiration dates won't be updated unless their account is manually renewed. This +# date will be randomly selected within a range [now + period - d ; now + period], +# where d is equal to 10% of the validity period. +# +account_validity: + # The account validity feature is disabled by default. Uncomment the + # following line to enable it. + # + #enabled: true + + # The period after which an account is valid after its registration. When + # renewing the account, its validity period will be extended by this amount + # of time. This parameter is required when using the account validity + # feature. + # + #period: 6w + + # The amount of time before an account's expiry date at which Synapse will + # send an email to the account's email address with a renewal link. By + # default, no such emails are sent. + # + # If you enable this setting, you will also need to fill out the 'email' and + # 'public_baseurl' configuration sections. + # + #renew_at: 1w + + # The subject of the email sent out with the renewal link. '%(app)s' can be + # used as a placeholder for the 'app_name' parameter from the 'email' + # section. + # + # Note that the placeholder must be written '%(app)s', including the + # trailing 's'. + # + # If this is not set, a default value is used. + # + #renew_email_subject: "Renew your %(app)s account" + + # Directory in which Synapse will try to find templates for the HTML files to + # serve to the user when trying to renew an account. If not set, default + # templates from within the Synapse package will be used. + # + #template_dir: "res/templates" + + # File within 'template_dir' giving the HTML to be displayed to the user after + # they successfully renewed their account. If not set, default text is used. + # + #account_renewed_html_path: "account_renewed.html" + + # File within 'template_dir' giving the HTML to be displayed when the user + # tries to renew an account with an invalid renewal token. If not set, + # default text is used. + # + #invalid_token_html_path: "invalid_token.html" + +# Time that a user's session remains valid for, after they log in. +# +# Note that this is not currently compatible with guest logins. +# +# Note also that this is calculated at login time: changes are not applied +# retrospectively to users who have already logged in. +# +# By default, this is infinite. +# +#session_lifetime: 24h + +# The user must provide all of the below types of 3PID when registering. +# +#registrations_require_3pid: +# - email +# - msisdn + +# Explicitly disable asking for MSISDNs from the registration +# flow (overrides registrations_require_3pid if MSISDNs are set as required) +# +#disable_msisdn_registration: true + +# Mandate that users are only allowed to associate certain formats of +# 3PIDs with accounts on this server. +# +#allowed_local_3pids: +# - medium: email +# pattern: '.*@matrix\.org' +# - medium: email +# pattern: '.*@vector\.im' +# - medium: msisdn +# pattern: '\+44' + +# Enable 3PIDs lookup requests to identity servers from this server. +# +#enable_3pid_lookup: true + +# If set, allows registration of standard or admin accounts by anyone who +# has the shared secret, even if registration is otherwise disabled. +# +registration_shared_secret: "UgG6FB~1cV1Z5:v+_6m*1tE4m143m6xM*fiBp:T+ZhF+sNdeH*" + +# Set the number of bcrypt rounds used to generate password hash. +# Larger numbers increase the work factor needed to generate the hash. +# The default number is 12 (which equates to 2^12 rounds). +# N.B. that increasing this will exponentially increase the time required +# to register or login - e.g. 24 => 2^24 rounds which will take >20 mins. +# +#bcrypt_rounds: 12 + +# Allows users to register as guests without a password/email/etc, and +# participate in rooms hosted on this server which have been made +# accessible to anonymous users. +# +#allow_guest_access: false + +# The identity server which we suggest that clients should use when users log +# in on this server. +# +# (By default, no suggestion is made, so it is left up to the client. +# This setting is ignored unless public_baseurl is also set.) +# +#default_identity_server: https://matrix.org + +# The list of identity servers trusted to verify third party +# identifiers by this server. +# +# Also defines the ID server which will be called when an account is +# deactivated (one will be picked arbitrarily). +# +# Note: This option is deprecated. Since v0.99.4, Synapse has tracked which identity +# server a 3PID has been bound to. For 3PIDs bound before then, Synapse runs a +# background migration script, informing itself that the identity server all of its +# 3PIDs have been bound to is likely one of the below. +# +# As of Synapse v1.4.0, all other functionality of this option has been deprecated, and +# it is now solely used for the purposes of the background migration script, and can be +# removed once it has run. +#trusted_third_party_id_servers: +# - matrix.org +# - vector.im + +# Handle threepid (email/phone etc) registration and password resets through a set of +# *trusted* identity servers. Note that this allows the configured identity server to +# reset passwords for accounts! +# +# Be aware that if `email` is not set, and SMTP options have not been +# configured in the email config block, registration and user password resets via +# email will be globally disabled. +# +# Additionally, if `msisdn` is not set, registration and password resets via msisdn +# will be disabled regardless. This is due to Synapse currently not supporting any +# method of sending SMS messages on its own. +# +# To enable using an identity server for operations regarding a particular third-party +# identifier type, set the value to the URL of that identity server as shown in the +# examples below. +# +# Servers handling the these requests must answer the `/requestToken` endpoints defined +# by the Matrix Identity Service API specification: +# https://matrix.org/docs/spec/identity_service/latest +# +# If a delegate is specified, the config option public_baseurl must also be filled out. +# +account_threepid_delegates: + #email: https://example.com # Delegate email sending to example.com + #msisdn: http://localhost:8090 # Delegate SMS sending to this local process + +# Whether users are allowed to change their displayname after it has +# been initially set. Useful when provisioning users based on the +# contents of a third-party directory. +# +# Does not apply to server administrators. Defaults to 'true' +# +#enable_set_displayname: false + +# Whether users are allowed to change their avatar after it has been +# initially set. Useful when provisioning users based on the contents +# of a third-party directory. +# +# Does not apply to server administrators. Defaults to 'true' +# +#enable_set_avatar_url: false + +# Whether users can change the 3PIDs associated with their accounts +# (email address and msisdn). +# +# Defaults to 'true' +# +#enable_3pid_changes: false + +# Users who register on this homeserver will automatically be joined +# to these rooms +# +#auto_join_rooms: +# - "#example:example.com" + +# Where auto_join_rooms are specified, setting this flag ensures that the +# the rooms exist by creating them when the first user on the +# homeserver registers. +# Setting to false means that if the rooms are not manually created, +# users cannot be auto-joined since they do not exist. +# +#autocreate_auto_join_rooms: true + + +## Metrics ### + +# Enable collection and rendering of performance metrics +# +#enable_metrics: false + +# Enable sentry integration +# NOTE: While attempts are made to ensure that the logs don't contain +# any sensitive information, this cannot be guaranteed. By enabling +# this option the sentry server may therefore receive sensitive +# information, and it in turn may then diseminate sensitive information +# through insecure notification channels if so configured. +# +#sentry: +# dsn: "..." + +# Flags to enable Prometheus metrics which are not suitable to be +# enabled by default, either for performance reasons or limited use. +# +metrics_flags: + # Publish synapse_federation_known_servers, a gauge of the number of + # servers this homeserver knows about, including itself. May cause + # performance problems on large homeservers. + # + #known_servers: true + +# Whether or not to report anonymized homeserver usage statistics. +report_stats: false + +# The endpoint to report the anonymized homeserver usage statistics to. +# Defaults to https://matrix.org/report-usage-stats/push +# +#report_stats_endpoint: https://example.com/report-usage-stats/push + + +## API Configuration ## + +# A list of event types that will be included in the room_invite_state +# +#room_invite_state_types: +# - "m.room.join_rules" +# - "m.room.canonical_alias" +# - "m.room.avatar" +# - "m.room.encryption" +# - "m.room.name" + + +# A list of application service config files to use +# +#app_service_config_files: +# - app_service_1.yaml +# - app_service_2.yaml + +# Uncomment to enable tracking of application service IP addresses. Implicitly +# enables MAU tracking for application service users. +# +#track_appservice_user_ips: true + + +# a secret which is used to sign access tokens. If none is specified, +# the registration_shared_secret is used, if one is given; otherwise, +# a secret key is derived from the signing key. +# +macaroon_secret_key: "yENyX9gJV:JDVK-yH.2Dls8dLE*PfEAD6ebKlDfA;e0#CYjNE:" + +# a secret which is used to calculate HMACs for form values, to stop +# falsification of values. Must be specified for the User Consent +# forms to work. +# +form_secret: "xko,ABwYOV*SqSfu3PGyLq#ZdHe5tU9nwHE+rcKYmV0Q~@Hg#D" + +## Signing Keys ## + +# Path to the signing key to sign messages with +# +signing_key_path: "/etc/matrix-synapse/homeserver.signing.key" + +# The keys that the server used to sign messages with but won't use +# to sign new messages. +# +old_signing_keys: + # For each key, `key` should be the base64-encoded public key, and + # `expired_ts`should be the time (in milliseconds since the unix epoch) that + # it was last used. + # + # It is possible to build an entry from an old signing.key file using the + # `export_signing_key` script which is provided with synapse. + # + # For example: + # + #"ed25519:id": { key: "base64string", expired_ts: 123456789123 } + +# How long key response published by this server is valid for. +# Used to set the valid_until_ts in /key/v2 APIs. +# Determines how quickly servers will query to check which keys +# are still valid. +# +#key_refresh_interval: 1d + +# The trusted servers to download signing keys from. +# +# When we need to fetch a signing key, each server is tried in parallel. +# +# Normally, the connection to the key server is validated via TLS certificates. +# Additional security can be provided by configuring a `verify key`, which +# will make synapse check that the response is signed by that key. +# +# This setting supercedes an older setting named `perspectives`. The old format +# is still supported for backwards-compatibility, but it is deprecated. +# +# 'trusted_key_servers' defaults to matrix.org, but using it will generate a +# warning on start-up. To suppress this warning, set +# 'suppress_key_server_warning' to true. +# +# Options for each entry in the list include: +# +# server_name: the name of the server. required. +# +# verify_keys: an optional map from key id to base64-encoded public key. +# If specified, we will check that the response is signed by at least +# one of the given keys. +# +# accept_keys_insecurely: a boolean. Normally, if `verify_keys` is unset, +# and federation_verify_certificates is not `true`, synapse will refuse +# to start, because this would allow anyone who can spoof DNS responses +# to masquerade as the trusted key server. If you know what you are doing +# and are sure that your network environment provides a secure connection +# to the key server, you can set this to `true` to override this +# behaviour. +# +# An example configuration might look like: +# +#trusted_key_servers: +# - server_name: "my_trusted_server.example.com" +# verify_keys: +# "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr" +# - server_name: "my_other_trusted_server.example.com" +# +trusted_key_servers: + - server_name: "matrix.org" + +# Uncomment the following to disable the warning that is emitted when the +# trusted_key_servers include 'matrix.org'. See above. +# +suppress_key_server_warning: true + +# The signing keys to use when acting as a trusted key server. If not specified +# defaults to the server signing key. +# +# Can contain multiple keys, one per line. +# +#key_server_signing_keys_path: "key_server_signing_keys.key" + + +# Enable SAML2 for registration and login. Uses pysaml2. +# +# At least one of `sp_config` or `config_path` must be set in this section to +# enable SAML login. +# +# (You will probably also want to set the following options to `false` to +# disable the regular login/registration flows: +# * enable_registration +# * password_config.enabled +# +# Once SAML support is enabled, a metadata file will be exposed at +# https://:/_matrix/saml2/metadata.xml, which you may be able to +# use to configure your SAML IdP with. Alternatively, you can manually configure +# the IdP to use an ACS location of +# https://:/_matrix/saml2/authn_response. +# +saml2_config: + # `sp_config` is the configuration for the pysaml2 Service Provider. + # See pysaml2 docs for format of config. + # + # Default values will be used for the 'entityid' and 'service' settings, + # so it is not normally necessary to specify them unless you need to + # override them. + # + #sp_config: + # # point this to the IdP's metadata. You can use either a local file or + # # (preferably) a URL. + # metadata: + # #local: ["saml2/idp.xml"] + # remote: + # - url: https://our_idp/metadata.xml + # + # # By default, the user has to go to our login page first. If you'd like + # # to allow IdP-initiated login, set 'allow_unsolicited: true' in a + # # 'service.sp' section: + # # + # #service: + # # sp: + # # allow_unsolicited: true + # + # # The examples below are just used to generate our metadata xml, and you + # # may well not need them, depending on your setup. Alternatively you + # # may need a whole lot more detail - see the pysaml2 docs! + # + # description: ["My awesome SP", "en"] + # name: ["Test SP", "en"] + # + # organization: + # name: Example com + # display_name: + # - ["Example co", "en"] + # url: "http://example.com" + # + # contact_person: + # - given_name: Bob + # sur_name: "the Sysadmin" + # email_address": ["admin@example.com"] + # contact_type": technical + + # Instead of putting the config inline as above, you can specify a + # separate pysaml2 configuration file: + # + #config_path: "path/to/homeserver/sp_conf.py" + + # The lifetime of a SAML session. This defines how long a user has to + # complete the authentication process, if allow_unsolicited is unset. + # The default is 5 minutes. + # + #saml_session_lifetime: 5m + + # An external module can be provided here as a custom solution to + # mapping attributes returned from a saml provider onto a matrix user. + # + user_mapping_provider: + # The custom module's class. Uncomment to use a custom module. + # + #module: mapping_provider.SamlMappingProvider + + # Custom configuration values for the module. Below options are + # intended for the built-in provider, they should be changed if + # using a custom module. This section will be passed as a Python + # dictionary to the module's `parse_config` method. + # + config: + # The SAML attribute (after mapping via the attribute maps) to use + # to derive the Matrix ID from. 'uid' by default. + # + # Note: This used to be configured by the + # saml2_config.mxid_source_attribute option. If that is still + # defined, its value will be used instead. + # + #mxid_source_attribute: displayName + + # The mapping system to use for mapping the saml attribute onto a + # matrix ID. + # + # Options include: + # * 'hexencode' (which maps unpermitted characters to '=xx') + # * 'dotreplace' (which replaces unpermitted characters with + # '.'). + # The default is 'hexencode'. + # + # Note: This used to be configured by the + # saml2_config.mxid_mapping option. If that is still defined, its + # value will be used instead. + # + #mxid_mapping: dotreplace + + # In previous versions of synapse, the mapping from SAML attribute to + # MXID was always calculated dynamically rather than stored in a + # table. For backwards- compatibility, we will look for user_ids + # matching such a pattern before creating a new account. + # + # This setting controls the SAML attribute which will be used for this + # backwards-compatibility lookup. Typically it should be 'uid', but if + # the attribute maps are changed, it may be necessary to change it. + # + # The default is 'uid'. + # + #grandfathered_mxid_source_attribute: upn + + # Directory in which Synapse will try to find the template files below. + # If not set, default templates from within the Synapse package will be used. + # + # DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates. + # If you *do* uncomment it, you will need to make sure that all the templates + # below are in the directory. + # + # Synapse will look for the following templates in this directory: + # + # * HTML page to display to users if something goes wrong during the + # authentication process: 'saml_error.html'. + # + # This template doesn't currently need any variable to render. + # + # You can see the default templates at: + # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates + # + #template_dir: "res/templates" + + + +# Enable CAS for registration and login. +# +#cas_config: +# enabled: true +# server_url: "https://cas-server.com" +# service_url: "https://homeserver.domain.com:8448" +# #displayname_attribute: name +# #required_attributes: +# # name: value + + +# Additional settings to use with single-sign on systems such as SAML2 and CAS. +# +sso: + # A list of client URLs which are whitelisted so that the user does not + # have to confirm giving access to their account to the URL. Any client + # whose URL starts with an entry in the following list will not be subject + # to an additional confirmation step after the SSO login is completed. + # + # WARNING: An entry such as "https://my.client" is insecure, because it + # will also match "https://my.client.evil.site", exposing your users to + # phishing attacks from evil.site. To avoid this, include a slash after the + # hostname: "https://my.client/". + # + # If public_baseurl is set, then the login fallback page (used by clients + # that don't natively support the required login flows) is whitelisted in + # addition to any URLs in this list. + # + # By default, this list is empty. + # + #client_whitelist: + # - https://riot.im/develop + # - https://my.custom.client/ + + # Directory in which Synapse will try to find the template files below. + # If not set, default templates from within the Synapse package will be used. + # + # DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates. + # If you *do* uncomment it, you will need to make sure that all the templates + # below are in the directory. + # + # Synapse will look for the following templates in this directory: + # + # * HTML page for a confirmation step before redirecting back to the client + # with the login token: 'sso_redirect_confirm.html'. + # + # When rendering, this template is given three variables: + # * redirect_url: the URL the user is about to be redirected to. Needs + # manual escaping (see + # https://jinja.palletsprojects.com/en/2.11.x/templates/#html-escaping). + # + # * display_url: the same as `redirect_url`, but with the query + # parameters stripped. The intention is to have a + # human-readable URL to show to users, not to use it as + # the final address to redirect to. Needs manual escaping + # (see https://jinja.palletsprojects.com/en/2.11.x/templates/#html-escaping). + # + # * server_name: the homeserver's name. + # + # * HTML page which notifies the user that they are authenticating to confirm + # an operation on their account during the user interactive authentication + # process: 'sso_auth_confirm.html'. + # + # When rendering, this template is given the following variables: + # * redirect_url: the URL the user is about to be redirected to. Needs + # manual escaping (see + # https://jinja.palletsprojects.com/en/2.11.x/templates/#html-escaping). + # + # * description: the operation which the user is being asked to confirm + # + # * HTML page shown after a successful user interactive authentication session: + # 'sso_auth_success.html'. + # + # Note that this page must include the JavaScript which notifies of a successful authentication + # (see https://matrix.org/docs/spec/client_server/r0.6.0#fallback). + # + # This template has no additional variables. + # + # * HTML page shown during single sign-on if a deactivated user (according to Synapse's database) + # attempts to login: 'sso_account_deactivated.html'. + # + # This template has no additional variables. + # + # You can see the default templates at: + # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates + # + #template_dir: "res/templates" + + +# The JWT needs to contain a globally unique "sub" (subject) claim. +# +#jwt_config: +# enabled: true +# secret: "a secret" +# algorithm: "HS256" + + +password_config: + # Uncomment to disable password login + # + #enabled: false + + # Uncomment to disable authentication against the local password + # database. This is ignored if `enabled` is false, and is only useful + # if you have other password_providers. + # + #localdb_enabled: false + + # Uncomment and change to a secret random string for extra security. + # DO NOT CHANGE THIS AFTER INITIAL SETUP! + # + #pepper: "EVEN_MORE_SECRET" + + # Define and enforce a password policy. Each parameter is optional. + # This is an implementation of MSC2000. + # + policy: + # Whether to enforce the password policy. + # Defaults to 'false'. + # + #enabled: true + + # Minimum accepted length for a password. + # Defaults to 0. + # + #minimum_length: 15 + + # Whether a password must contain at least one digit. + # Defaults to 'false'. + # + #require_digit: true + + # Whether a password must contain at least one symbol. + # A symbol is any character that's not a number or a letter. + # Defaults to 'false'. + # + #require_symbol: true + + # Whether a password must contain at least one lowercase letter. + # Defaults to 'false'. + # + #require_lowercase: true + + # Whether a password must contain at least one lowercase letter. + # Defaults to 'false'. + # + #require_uppercase: true + + +# Configuration for sending emails from Synapse. +# +email: + # The hostname of the outgoing SMTP server to use. Defaults to 'localhost'. + # + #smtp_host: mail.server + + # The port on the mail server for outgoing SMTP. Defaults to 25. + # + #smtp_port: 587 + + # Username/password for authentication to the SMTP server. By default, no + # authentication is attempted. + # + # smtp_user: "exampleusername" + # smtp_pass: "examplepassword" + + # Uncomment the following to require TLS transport security for SMTP. + # By default, Synapse will connect over plain text, and will then switch to + # TLS via STARTTLS *if the SMTP server supports it*. If this option is set, + # Synapse will refuse to connect unless the server supports STARTTLS. + # + #require_transport_security: true + + # notif_from defines the "From" address to use when sending emails. + # It must be set if email sending is enabled. + # + # The placeholder '%(app)s' will be replaced by the application name, + # which is normally 'app_name' (below), but may be overridden by the + # Matrix client application. + # + # Note that the placeholder must be written '%(app)s', including the + # trailing 's'. + # + #notif_from: "Your Friendly %(app)s homeserver " + + # app_name defines the default value for '%(app)s' in notif_from. It + # defaults to 'Matrix'. + # + #app_name: my_branded_matrix_server + + # Uncomment the following to enable sending emails for messages that the user + # has missed. Disabled by default. + # + #enable_notifs: true + + # Uncomment the following to disable automatic subscription to email + # notifications for new users. Enabled by default. + # + #notif_for_new_users: false + + # Custom URL for client links within the email notifications. By default + # links will be based on "https://matrix.to". + # + # (This setting used to be called riot_base_url; the old name is still + # supported for backwards-compatibility but is now deprecated.) + # + #client_base_url: "http://localhost/riot" + + # Configure the time that a validation email will expire after sending. + # Defaults to 1h. + # + #validation_token_lifetime: 15m + + # Directory in which Synapse will try to find the template files below. + # If not set, default templates from within the Synapse package will be used. + # + # DO NOT UNCOMMENT THIS SETTING unless you want to customise the templates. + # If you *do* uncomment it, you will need to make sure that all the templates + # below are in the directory. + # + # Synapse will look for the following templates in this directory: + # + # * The contents of email notifications of missed events: 'notif_mail.html' and + # 'notif_mail.txt'. + # + # * The contents of account expiry notice emails: 'notice_expiry.html' and + # 'notice_expiry.txt'. + # + # * The contents of password reset emails sent by the homeserver: + # 'password_reset.html' and 'password_reset.txt' + # + # * HTML pages for success and failure that a user will see when they follow + # the link in the password reset email: 'password_reset_success.html' and + # 'password_reset_failure.html' + # + # * The contents of address verification emails sent during registration: + # 'registration.html' and 'registration.txt' + # + # * HTML pages for success and failure that a user will see when they follow + # the link in an address verification email sent during registration: + # 'registration_success.html' and 'registration_failure.html' + # + # * The contents of address verification emails sent when an address is added + # to a Matrix account: 'add_threepid.html' and 'add_threepid.txt' + # + # * HTML pages for success and failure that a user will see when they follow + # the link in an address verification email sent when an address is added + # to a Matrix account: 'add_threepid_success.html' and + # 'add_threepid_failure.html' + # + # You can see the default templates at: + # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates + # + #template_dir: "res/templates" + + +# Password providers allow homeserver administrators to integrate +# their Synapse installation with existing authentication methods +# ex. LDAP, external tokens, etc. +# +# For more information and known implementations, please see +# https://github.com/matrix-org/synapse/blob/master/docs/password_auth_providers.md +# +# Note: instances wishing to use SAML or CAS authentication should +# instead use the `saml2_config` or `cas_config` options, +# respectively. +# +password_providers: +# # Example config for an LDAP auth provider +# - module: "ldap_auth_provider.LdapAuthProvider" +# config: +# enabled: true +# uri: "ldap://ldap.example.com:389" +# start_tls: true +# base: "ou=users,dc=example,dc=com" +# attributes: +# uid: "cn" +# mail: "email" +# name: "givenName" +# #bind_dn: +# #bind_password: +# #filter: "(objectClass=posixAccount)" + + + +# Clients requesting push notifications can either have the body of +# the message sent in the notification poke along with other details +# like the sender, or just the event ID and room ID (`event_id_only`). +# If clients choose the former, this option controls whether the +# notification request includes the content of the event (other details +# like the sender are still included). For `event_id_only` push, it +# has no effect. +# +# For modern android devices the notification content will still appear +# because it is loaded by the app. iPhone, however will send a +# notification saying only that a message arrived and who it came from. +# +#push: +# include_content: true + + +#spam_checker: +# module: "my_custom_project.SuperSpamChecker" +# config: +# example_option: 'things' + + +# Uncomment to allow non-server-admin users to create groups on this server +# +#enable_group_creation: true + +# If enabled, non server admins can only create groups with local parts +# starting with this prefix +# +#group_creation_prefix: "unofficial/" + + + +# User Directory configuration +# +# 'enabled' defines whether users can search the user directory. If +# false then empty responses are returned to all queries. Defaults to +# true. +# +# 'search_all_users' defines whether to search all users visible to your HS +# when searching the user directory, rather than limiting to users visible +# in public rooms. Defaults to false. If you set it True, you'll have to +# rebuild the user_directory search indexes, see +# https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md +# +#user_directory: +# enabled: true +# search_all_users: false + + +# User Consent configuration +# +# for detailed instructions, see +# https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md +# +# Parts of this section are required if enabling the 'consent' resource under +# 'listeners', in particular 'template_dir' and 'version'. +# +# 'template_dir' gives the location of the templates for the HTML forms. +# This directory should contain one subdirectory per language (eg, 'en', 'fr'), +# and each language directory should contain the policy document (named as +# '.html') and a success page (success.html). +# +# 'version' specifies the 'current' version of the policy document. It defines +# the version to be served by the consent resource if there is no 'v' +# parameter. +# +# 'server_notice_content', if enabled, will send a user a "Server Notice" +# asking them to consent to the privacy policy. The 'server_notices' section +# must also be configured for this to work. Notices will *not* be sent to +# guest users unless 'send_server_notice_to_guests' is set to true. +# +# 'block_events_error', if set, will block any attempts to send events +# until the user consents to the privacy policy. The value of the setting is +# used as the text of the error. +# +# 'require_at_registration', if enabled, will add a step to the registration +# process, similar to how captcha works. Users will be required to accept the +# policy before their account is created. +# +# 'policy_name' is the display name of the policy users will see when registering +# for an account. Has no effect unless `require_at_registration` is enabled. +# Defaults to "Privacy Policy". +# +#user_consent: +# template_dir: res/templates/privacy +# version: 1.0 +# server_notice_content: +# msgtype: m.text +# body: >- +# To continue using this homeserver you must review and agree to the +# terms and conditions at %(consent_uri)s +# send_server_notice_to_guests: true +# block_events_error: >- +# To continue using this homeserver you must review and agree to the +# terms and conditions at %(consent_uri)s +# require_at_registration: false +# policy_name: Privacy Policy +# + + + +# Local statistics collection. Used in populating the room directory. +# +# 'bucket_size' controls how large each statistics timeslice is. It can +# be defined in a human readable short form -- e.g. "1d", "1y". +# +# 'retention' controls how long historical statistics will be kept for. +# It can be defined in a human readable short form -- e.g. "1d", "1y". +# +# +#stats: +# enabled: true +# bucket_size: 1d +# retention: 1y + + +# Server Notices room configuration +# +# Uncomment this section to enable a room which can be used to send notices +# from the server to users. It is a special room which cannot be left; notices +# come from a special "notices" user id. +# +# If you uncomment this section, you *must* define the system_mxid_localpart +# setting, which defines the id of the user which will be used to send the +# notices. +# +# It's also possible to override the room name, the display name of the +# "notices" user, and the avatar for the user. +# +#server_notices: +# system_mxid_localpart: notices +# system_mxid_display_name: "Server Notices" +# system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ" +# room_name: "Server Notices" + + + +# Uncomment to disable searching the public room list. When disabled +# blocks searching local and remote room lists for local and remote +# users by always returning an empty list for all queries. +# +#enable_room_list_search: false + +# The `alias_creation` option controls who's allowed to create aliases +# on this server. +# +# The format of this option is a list of rules that contain globs that +# match against user_id, room_id and the new alias (fully qualified with +# server name). The action in the first rule that matches is taken, +# which can currently either be "allow" or "deny". +# +# Missing user_id/room_id/alias fields default to "*". +# +# If no rules match the request is denied. An empty list means no one +# can create aliases. +# +# Options for the rules include: +# +# user_id: Matches against the creator of the alias +# alias: Matches against the alias being created +# room_id: Matches against the room ID the alias is being pointed at +# action: Whether to "allow" or "deny" the request if the rule matches +# +# The default is: +# +#alias_creation_rules: +# - user_id: "*" +# alias: "*" +# room_id: "*" +# action: allow + +# The `room_list_publication_rules` option controls who can publish and +# which rooms can be published in the public room list. +# +# The format of this option is the same as that for +# `alias_creation_rules`. +# +# If the room has one or more aliases associated with it, only one of +# the aliases needs to match the alias rule. If there are no aliases +# then only rules with `alias: *` match. +# +# If no rules match the request is denied. An empty list means no one +# can publish rooms. +# +# Options for the rules include: +# +# user_id: Matches agaisnt the creator of the alias +# room_id: Matches against the room ID being published +# alias: Matches against any current local or canonical aliases +# associated with the room +# action: Whether to "allow" or "deny" the request if the rule matches +# +# The default is: +# +#room_list_publication_rules: +# - user_id: "*" +# alias: "*" +# room_id: "*" +# action: allow + + +# Server admins can define a Python module that implements extra rules for +# allowing or denying incoming events. In order to work, this module needs to +# override the methods defined in synapse/events/third_party_rules.py. +# +# This feature is designed to be used in closed federations only, where each +# participating server enforces the same rules. +# +#third_party_event_rules: +# module: "my_custom_project.SuperRulesSet" +# config: +# example_option: 'things' + + +## Opentracing ## + +# These settings enable opentracing, which implements distributed tracing. +# This allows you to observe the causal chains of events across servers +# including requests, key lookups etc., across any server running +# synapse or any other other services which supports opentracing +# (specifically those implemented with Jaeger). +# +opentracing: + # tracing is disabled by default. Uncomment the following line to enable it. + # + #enabled: true + + # The list of homeservers we wish to send and receive span contexts and span baggage. + # See docs/opentracing.rst + # This is a list of regexes which are matched against the server_name of the + # homeserver. + # + # By defult, it is empty, so no servers are matched. + # + #homeserver_whitelist: + # - ".*" + + # Jaeger can be configured to sample traces at different rates. + # All configuration options provided by Jaeger can be set here. + # Jaeger's configuration mostly related to trace sampling which + # is documented here: + # https://www.jaegertracing.io/docs/1.13/sampling/. + # + #jaeger_config: + # sampler: + # type: const + # param: 1 + + # Logging whether spans were started and reported + # + # logging: + # false + + +# vim:ft=yaml diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/templates/log.yaml.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/templates/log.yaml.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,56 @@ + +version: 1 + +formatters: + precise: + format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s- %(message)s' + journal_fmt: + format: '%(name)s: [%(request)s] %(message)s' + +filters: + context: + (): synapse.util.logcontext.LoggingContextFilter + request: "" + +handlers: + file: + class: logging.handlers.WatchedFileHandler + formatter: precise + filename: /var/log/matrix-synapse/homeserver.log + filters: [context] + level: ERROR + encoding: utf8 + console: + class: logging.StreamHandler + formatter: precise + level: ERROR + journal: + class: systemd.journal.JournalHandler + formatter: journal_fmt + filters: [context] + SYSLOG_IDENTIFIER: synapse + +loggers: + twisted: + level: ERROR + + synapse: + level: ERROR + + # the following levels are more verbose than most users want + # set them to INFO if you need more logging + synapse.metrics: + level: ERROR + + synapse.http.federation.well_known_resolver: + level: ERROR + + synapse.storage.TIME: + level: ERROR + + synapse.http.matrixfederationclient: + level: ERROR + +root: + level: ERROR + handlers: [journal] diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/templates/server_name.yaml.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/templates/server_name.yaml.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,1 @@ +server_name: {{matrix_synapse_server_name}} diff -r 78a072bbf3c1 -r 73eb2db468ec matrix-synapse/templates/setup_db.psql.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/matrix-synapse/templates/setup_db.psql.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,2 @@ +CREATE USER {{matrix_synapse_pgsql_user}} WITH ENCRYPTED PASSWORD '{{matrix_synapse_pgsql_pass}}'; +CREATE DATABASE {{matrix_synapse_pgsql_db}} ENCODING 'UTF8' LC_COLLATE='C.UTF-8' LC_CTYPE='C.UTF-8' template=template0 OWNER {{matrix_synapse_pgsql_user}}; diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/aws-s3-backup/files/mercurial-s3-backup.sh --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/aws-s3-backup/files/mercurial-s3-backup.sh Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,10 @@ +#!/bin/bash + +BUCKET=$1 +DATE=`date --iso-8601` +BACKUP_DIR=$2 +BACKUP_TAR="/tmp/$BUCKET-$DATE.tgz" + +tar -zc -f $BACKUP_TAR $BACKUP_DIR +aws s3 mb "s3://$BUCKET/" +aws s3 cp $BACKUP_TAR "s3://$BUCKET/" diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/aws-s3-backup/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/aws-s3-backup/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: reload s3 backup service + systemd: name="mercurial-s3-backup@{{mercurial_s3_backup_bucket}}.service" enabled="yes" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/aws-s3-backup/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/aws-s3-backup/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,19 @@ +--- + +- name: create mercurial s3 backup shell script + become: yes + copy: + src: "mercurial-s3-backup.sh" + dest: "/usr/local/bin/mercurial-s3-backup.sh" + mode: "0755" + +- name: configure mercurial s3 backup systemd service + become: yes + template: + src: "mercurial-s3-backup@.service.j2" + dest: "/lib/systemd/system/mercurial-s3-backup@{{mercurial_s3_backup_bucket}}.service" + notify: reload s3 backup service + +- name: ensure mercurial s3 backup service is started + become: yes + systemd: name="mercurial-s3-backup@{{mercurial_s3_backup_bucket}}.service" enabled="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/aws-s3-backup/templates/mercurial-s3-backup@.service.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/aws-s3-backup/templates/mercurial-s3-backup@.service.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,9 @@ +[Unit] +Description=Mercurial s3 backup for "%I" + +[Service] +Type=oneshot +ExecStart=/usr/local/bin/mercurial-s3-backup.sh %i "{{mercurial_s3_backup_dir}}" + +[Install] +WantedBy=aws-s3-backup.target diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/web/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/web/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart uwsgi + systemd: name="uwsgi.service" enabled="yes" daemon_reload="yes" state="restarted" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/web/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/web/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,39 @@ +--- + +- name: pip install mercurial + become: yes + pip: name="mercurial" executable="pip3" + +- name: apt install uwsgi + become: yes + apt: name="{{item}}" + loop: + - "uwsgi" + - "uwsgi-plugin-python3" + - "python3-pygments" + notify: restart uwsgi + +- name: configure hgweb + become: yes + template: src="{{item}}.j2" dest="{{mercurial_uwsgi_root}}/{{item}}" + loop: + - "hgweb.config" + - "hgweb.wsgi" + notify: restart uwsgi + +- name: install uwsgi site + become: yes + template: src="hgweb.ini.j2" dest="/etc/uwsgi/apps-available/hgweb.ini" + notify: restart uwsgi + +- name: enable uwsgi site + become: yes + file: + src: "/etc/uwsgi/apps-available/hgweb.ini" + dest: "/etc/uwsgi/apps-enabled/hgweb.ini" + state: "link" + notify: restart uwsgi + +- name: ensure uwsgi service is started + become: yes + systemd: name="uwsgi.service" enabled="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/web/templates/hgweb.config.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/web/templates/hgweb.config.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,11 @@ +[paths] +/ = {{mercurial_uwsgi_repos}} + +[web] +deny_push = * +allow_archive = gz bz2 zip +encoding = UTF-8 +style = gitweb + +[extensions] +hgext.highlight = diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/web/templates/hgweb.ini.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/web/templates/hgweb.ini.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,8 @@ +[uwsgi] +processes = 2 +socket = unix:/run/uwsgi/app/hgweb/socket +chdir = {{mercurial_uwsgi_root}} +wsgi-file = hgweb.wsgi +uid = www-data +gid = www-data +plugins = python3 diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/web/templates/hgweb.nginx.conf.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/web/templates/hgweb.nginx.conf.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,33 @@ +server { + listen 80; + listen [::]:80; + server_name {{nginx_server_name}}; + return 301 https://$host$request_uri; +} + +server { + listen 443 ssl http2; +# listen [::]:443 ssl ipv6only=on; + server_name {{nginx_server_name}}; + + ssl_certificate {{nginx_ssl_cert}}; + ssl_certificate_key {{nginx_ssl_privkey}}; + include /etc/letsencrypt/options-ssl-nginx.conf; + ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; + + ssl_ecdh_curve X25519:prime256v1:secp384r1:secp521r1; + ssl_stapling on; + ssl_stapling_verify on; + + location / { + include uwsgi_params; + uwsgi_param REMOTE_PORT $remote_port; + uwsgi_param SERVER_PORT $server_port; + uwsgi_param SERVER_PROTOCOL $server_protocol; + uwsgi_param UWSGI_SCHEME $scheme; + uwsgi_param SCRIPT_NAME /; + uwsgi_param AUTH_USER $remote_user; + uwsgi_param REMOTE_USER $remote_user; + uwsgi_pass unix:/run/uwsgi/app/hgweb/socket; + } +} diff -r 78a072bbf3c1 -r 73eb2db468ec mercurial/web/templates/hgweb.wsgi.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/web/templates/hgweb.wsgi.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,18 @@ +# An example WSGI for use with mod_wsgi, edit as necessary +# See https://mercurial-scm.org/wiki/modwsgi for more information + +# Path to repo or hgweb config to serve (see 'hg help hgweb') +config = "{{mercurial_uwsgi_root}}/hgweb.config" + +# Uncomment and adjust if Mercurial is not installed system-wide +# (consult "installed modules" path from 'hg debuginstall'): +#import sys; sys.path.insert(0, "/path/to/python/lib") + +# Uncomment to send python tracebacks to the browser if an error occurs: +#import cgitb; cgitb.enable() + +# enable demandloading to reduce startup time +from mercurial import demandimport; demandimport.enable() + +from mercurial.hgweb import hgweb +application = hgweb(config.encode()) diff -r 78a072bbf3c1 -r 73eb2db468ec nginx/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/nginx/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,7 @@ +--- + +nginx_conf_src: "files/{{nginx_server_name}}/nginx.conf.j2" +nginx_root_src: "files/{{nginx_server_name}}/root/" +nginx_root_dest: "/var/www/{{nginx_server_name}}" +nginx_server_type: "site" +nginx_root: false diff -r 78a072bbf3c1 -r 73eb2db468ec nginx/files/nginx.conf --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/nginx/files/nginx.conf Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,91 @@ +user www-data; +worker_processes auto; +pid /run/nginx.pid; +include /etc/nginx/modules-enabled/*.conf; + +events { + worker_connections 768; + # multi_accept on; +} + +http { + + ## + # Basic Settings + ## + + sendfile on; + tcp_nopush on; + tcp_nodelay on; + keepalive_timeout 65; + types_hash_max_size 2048; + # server_tokens off; + + # server_names_hash_bucket_size 64; + # server_name_in_redirect off; + + include /etc/nginx/mime.types; + default_type application/octet-stream; + + ## + # SSL Settings + ## + + ssl_protocols TLSv1.2 TLSv1.3; # Dropping SSLv3, ref: POODLE + ssl_prefer_server_ciphers on; + + ## + # Logging Settings + ## + + access_log /var/log/nginx/access.log; + error_log /var/log/nginx/error.log; + + ## + # Gzip Settings + ## + + gzip on; + + gzip_vary on; + gzip_proxied any; + gzip_comp_level 6; + gzip_buffers 16 8k; + gzip_http_version 1.1; + gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; + + ## + # Virtual Host Configs + ## + + include /etc/nginx/conf.d/*.conf; + include /etc/nginx/sites-enabled/*; +} + +stream { + ssl_protocols TLSv1.2 TLSv1.3; # Dropping SSLv3, ref: POODLE + ssl_prefer_server_ciphers on; + + include /etc/nginx/streams-enabled/*; +} + +#mail { +# # See sample authentication script at: +# # http://wiki.nginx.org/ImapAuthenticateWithApachePhpScript +# +# # auth_http localhost/auth.php; +# # pop3_capabilities "TOP" "USER"; +# # imap_capabilities "IMAP4rev1" "UIDPLUS"; +# +# server { +# listen localhost:110; +# protocol pop3; +# proxy on; +# } +# +# server { +# listen localhost:143; +# protocol imap; +# proxy on; +# } +#} diff -r 78a072bbf3c1 -r 73eb2db468ec nginx/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/nginx/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart nginx + become: yes + systemd: name="nginx" state="restarted" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec nginx/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/nginx/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,44 @@ +--- + +- name: apt install nginx + become: yes + apt: name="nginx" + +- name: disable default site + become: yes + file: path="/etc/nginx/sites-enabled/default" state="absent" + +- name: install base config + become: yes + copy: src="nginx.conf" dest="/etc/nginx/nginx.conf" + notify: restart nginx + +- name: make stream dirs + become: yes + file: path="/etc/nginx/streams-{{item}}" state="directory" + loop: ["available", "enabled"] + +- name: make config available + become: yes + template: + src: "{{nginx_conf_src}}" + dest: "/etc/nginx/{{nginx_server_type}}s-available/{{nginx_server_name}}.conf" + notify: restart nginx + +- name: enable config + become: yes + file: + src: "/etc/nginx/{{nginx_server_type}}s-available/{{nginx_server_name}}.conf" + dest: "/etc/nginx/{{nginx_server_type}}s-enabled/{{nginx_server_name}}.conf" + state: "link" + notify: restart nginx + +- name: copy root files + become: yes + copy: src="{{nginx_root_src}}" dest="{{nginx_root_dest}}/" + when: nginx_root + notify: restart nginx + +- name: enable nginx service + become: yes + systemd: name="nginx" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec ngircd/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ngircd/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart ngircd + become: yes + systemd: name="ngircd" state="restarted" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec ngircd/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ngircd/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,43 @@ +--- + +- name: apt install ngircd + become: yes + apt: name="ngircd" + notify: restart ngircd + +- name: config server name + become: yes + lineinfile: + path: "/etc/ngircd/ngircd.conf" + regexp: '^ Name =' + line: " Name = {{ngircd_name}}" + notify: restart ngircd + +- name: config server local listen + become: yes + lineinfile: + path: "/etc/ngircd/ngircd.conf" + regexp: '^ Listen =' + line: " Listen = 127.0.0.1" + insertafter: "^ ;Listen =" + notify: restart ngircd + +- name: config motd + become: yes + lineinfile: + path: "/etc/ngircd/ngircd.conf" + regexp: '^ Info =' + line: " Info = {{ngircd_motd}}" + notify: restart ngircd + +- name: copy motd file + become: yes + copy: + src: "{{ngircd_motd_src}}" + dest: "/etc/ngircd/ngircd.motd" + mode: "0644" + notify: restart ngircd + +- name: start ngircd service + become: yes + systemd: name="ngircd" state="started" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec nodejs/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/nodejs/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,6 @@ +--- + +nodejs_version: "v14.3.0" +nodejs_arch: "{{ansible_architecture}}" +nodejs_dir: "node-{{nodejs_version}}-{{ansible_system | lower}}-{{nodejs_arch}}" +nodejs_src: "https://nodejs.org/dist/{{nodejs_version}}/{{nodejs_dir}}.tar.xz" diff -r 78a072bbf3c1 -r 73eb2db468ec nodejs/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/nodejs/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,23 @@ +--- + +- name: download and unarchive nodejs + become: yes + unarchive: + src: "{{nodejs_src}}" + dest: "/opt/" + remote_src: yes + creates: "/opt/{{nodejs_dir}}" + owner: "root" + group: "root" + +# sudo update-alternatives --install "/usr/bin/node" "node" "/opt/node/bin/node" 1 +- name: update node alterantives + become: yes + alternatives: + link: "/usr/bin/{{item}}" + name: "{{item}}" + path: "/opt/{{nodejs_dir}}/bin/{{item}}" + priority: "1" + with_items: + - "node" + - "npm" diff -r 78a072bbf3c1 -r 73eb2db468ec papermc/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/papermc/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,10 @@ +--- + +papermc_user: "papermc" +papermc_version: "1.15.2" +papermc_build: "327" +papermc_url: "https://papermc.io/api/v1/paper/{{papermc_version}}/{{papermc_build}}/download" +papermc_dir: "/opt/papermc" +papermc_motd: "A Minecraft Server" +papermc_mem: "2G" +papermc_world_dir: "{{papermc_dir}}" diff -r 78a072bbf3c1 -r 73eb2db468ec papermc/files/eula.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/papermc/files/eula.txt Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,1 @@ +eula=true diff -r 78a072bbf3c1 -r 73eb2db468ec papermc/files/ops.json --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/papermc/files/ops.json Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,8 @@ +[ + { + "uuid": "98827ef9-601c-49fd-b575-abc8de019854", + "name": "Lukemute", + "level": 4, + "bypassesPlayerLimit": true + } +] \ No newline at end of file diff -r 78a072bbf3c1 -r 73eb2db468ec papermc/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/papermc/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart papermc + become: yes + systemd: name="papermc.service" state="restarted" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec papermc/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/papermc/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,66 @@ +--- + +- name: add papermc user + become: yes + user: name="{{papermc_user}}" home="{{papermc_dir}}" + +- name: install jre + become: yes + apt: name="default-jre-headless" + +- name: download papermc + become: yes + get_url: + url: "{{papermc_url}}" + dest: "{{papermc_dir}}/server.jar" + mode: "0755" + notify: restart papermc + +- name: configure eula and ops + become: yes + copy: + src: "{{item}}" + dest: "{{papermc_dir}}/{{item}}" + owner: "{{papermc_user}}" + group: "{{papermc_user}}" + loop: + - "eula.txt" + - "ops.json" + notify: restart papermc + +- name: set motd + become: yes + lineinfile: + path: "{{papermc_dir}}/server.properties" + regexp: "^motd=" + line: "motd={{papermc_motd}}" + notify: restart papermc + +- name: create world file directory + become: yes + file: + path: "{{papermc_world_dir}}" + state: "directory" + owner: "{{papermc_user}}" + group: "{{papermc_user}}" + mode: "0755" + +- name: set world files + become: yes + lineinfile: + path: "{{papermc_dir}}/bukkit.yml" + regexp: "^ world-container:" + line: " world-container: {{papermc_world_dir}}" + insertbefore: "^ permissions-file:" + notify: restart papermc + +- name: install systemd service + become: yes + template: + src: "papermc.service.j2" + dest: "/lib/systemd/system/papermc.service" + notify: restart papermc + +- name: ensure service is started + become: yes + systemd: name="papermc.service" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec papermc/templates/papermc.service.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/papermc/templates/papermc.service.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,22 @@ +[Unit] +Description=PaperMC Server +Documentation=https://paper.readthedocs.io/en/latest/server/getting-started.html + +Wants=network.target +After=network.target + +[Service] +User={{papermc_user}} +Group={{papermc_user}} +WorkingDirectory={{papermc_dir}} +Restart=on-failure +RestartSec=20 5 +ExecStart=/usr/bin/java -Xms{{papermc_mem}} -Xmx{{papermc_mem}} -jar server.jar + +PrivateTmp=true +ProtectSystem=full +NoNewPrivileges=true +PrivateDevices=true + +[Install] +WantedBy=multi-user.target diff -r 78a072bbf3c1 -r 73eb2db468ec pihole/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/pihole/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart pihole-ftl + systemd: name="pihole-FTL.service" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec pihole/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/pihole/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,13 @@ +--- + +- name: install custom DNS names + become: yes + copy: + src: "{{pihole_custom_dns_list}}" + dest: "/etc/pihole/custom.list" + mode: "0644" + notify: restart pihole-ftl + +- name: update pihole + command: "pihole -up" + changed_when: false diff -r 78a072bbf3c1 -r 73eb2db468ec plex/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plex/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart plex service + become: yes + systemd: name="plexmediaserver" state="restarted" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec plex/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plex/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,25 @@ +--- + +# https://forums.plex.tv/t/read-me-first-about-server-armv7-and-armv8-ubuntu-debian/226567 + +- name: add plex apt key + become: yes + apt_key: url="https://downloads.plex.tv/plex-keys/PlexSign.key" + +- name: add plex apt repo + become: yes + apt_repository: repo="deb http://downloads.plex.tv/repo/deb public main" + notify: restart plex service + +- name: update apt package cache + become: yes + apt: upgrade="dist" update_cache="yes" cache_valid_time="3600" + +- name: install plex server + become: yes + apt: name="plexmediaserver" + notify: restart plex service + +- name: ensure plex service is running + become: yes + systemd: name="plexmediaserver.service" state="started" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec postgresql/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/postgresql/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,10 @@ +--- + +postgresql_version: "12" +postgresql_config_path: "/etc/postgresql/{{postgresql_version}}/main/postgresql.conf" +postgresql_data_dir: "/var/lib/postgresql/{{postgresql_version}}/main" +postgresql_apt_packages: + - "postgresql-{{postgresql_version}}" + - "pgcli" + - "postgresql-client" + - "postgresql-common" diff -r 78a072bbf3c1 -r 73eb2db468ec postgresql/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/postgresql/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart postgres + become: yes + systemd: name="postgresql" state="restarted" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec postgresql/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/postgresql/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,27 @@ +--- + +- name: install postgresql + become: yes + apt: name="{{postgresql_apt_packages}}" + +- name: configure postgresql data dir + become: yes + lineinfile: + path: "{{postgresql_config_path}}" + regexp: "^data_directory = " + line: "data_directory = '{{postgresql_data_dir}}'" + notify: restart postgres + +- name: create postgresql data dir + become: yes + file: + path: "{{postgresql_data_dir}}" + state: "directory" + mode: "0700" + owner: "postgres" + group: "postgres" + notify: restart postgres + +- name: ensure postgresql is started + become: yes + systemd: name="postgresql" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/client/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/client/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,6 @@ +--- + +prometheus_client_apt_packages: + - "prometheus-node-exporter" + # - "prometheus-postgres-exporter" + # - "prometheus-nginx-exporter" diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/client/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/client/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,29 @@ +--- + +- name: install prometheus node exporter + become: yes + apt: name="prometheus-node-exporter" + +- name: ensure prometheus node exporter is started + become: yes + systemd: name="prometheus-node-exporter.service" enabled="yes" state="started" + +# # Nginx +# - name: check if running nginx +# stat: path="/etc/nginx/" +# register: stat_nginx_conf + +# - name: install prometheus-nginx-exporter +# become: yes +# apt: name="prometheus-nginx-exporter" +# when: stat_nginx_conf.stat.exists + +# # PostgreSQL +# - name: check if running postgresql +# stat: path="/etc/postgresql/" +# register: stat_postgresql_conf + +# - name: install prometheus-postgresql-exporter +# become: yes +# apt: name="prometheus-postgres-exporter" +# when: stat_postgresql_conf.stat.exists diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/rpi-client/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/rpi-client/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,9 @@ +--- + +prometheus_client_rpi_exporter_version: "0.6.0" +prometheus_client_arch: "{{ansible_architecture}}" + +prometheus_client_rpi_src: "https://github.com/lukasmalkmus/rpi_exporter/releases/download/v{{prometheus_client_rpi_exporter_version}}/rpi_exporter-{{prometheus_client_rpi_exporter_version}}.linux-{{prometheus_client_arch}}.tar.gz" +prometheus_client_rpi_dest: "rpi_exporter-{{prometheus_client_rpi_exporter_version}}.linux-{{prometheus_client_arch}}" + +prometheus_client_rpi_collect_gpu_temp: true diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/rpi-client/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/rpi-client/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart rpi_exporter + systemd: name="rpi_exporter.service" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/rpi-client/meta/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/rpi-client/meta/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,4 @@ +--- + +dependencies: + - role: "prometheus/client" diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/rpi-client/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/rpi-client/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,43 @@ +--- + +- name: add prometheus user to video group for rpi GPU stats + become: yes + user: name="prometheus" groups="video" append="yes" + +- name: install prometheus rpi-exporter + unarchive: + src: "{{prometheus_client_rpi_src}}" + remote_src: yes + dest: "/tmp" + creates: "/tmp/{{prometheus_client_rpi_dest}}" + notify: restart rpi_exporter + +- name: disable GPU temp scraping + become: yes + lineinfile: + path: "/tmp/{{prometheus_client_rpi_dest}}/rpi_exporter.service" + regexp: "^ExecStart=/usr/local/bin/rpi_exporter" + line: "ExecStart=/usr/local/bin/rpi_exporter --no-collector.gpu" + when: not prometheus_client_rpi_collect_gpu_temp + changed_when: false + +- name: install systemd service for rpi-exporter + become: yes + copy: + src: "/tmp/{{prometheus_client_rpi_dest}}/rpi_exporter.service" + remote_src: yes + dest: "/lib/systemd/system/rpi_exporter.service" + notify: restart rpi_exporter + +- name: install rpi-exporter binary + become: yes + copy: + src: "/tmp/{{prometheus_client_rpi_dest}}/rpi_exporter" + remote_src: yes + dest: "/usr/local/bin/rpi_exporter" + mode: "0755" + notify: restart rpi_exporter + +- name: ensure systemd service is started + become: yes + systemd: name="rpi_exporter.service" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/server/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/server/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,9 @@ +--- + +prometheus_server_conf: "prometheus.yml.j2" +prometheus_server_apt_packages: + - "prometheus" + - "grafana" + +prometheus_server_grafana_plugins: + - "flant-statusmap-panel" diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/server/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/server/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,9 @@ +--- + +- name: restart prometheus service + systemd: name="prometheus.service" state="restarted" daemon_reload="yes" + become: yes + +- name: restart grafana service + systemd: name="grafana-server.service" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/server/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/server/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,56 @@ +--- + +- name: add grafana apt key + become: yes + apt_key: url="https://packages.grafana.com/gpg.key" + +- name: add grafana apt repo + become: yes + apt_repository: repo="deb https://packages.grafana.com/oss/deb stable main" + +- name: install prometheus and grafana + become: yes + apt: name="{{prometheus_server_apt_packages}}" state="latest" + +- name: configure prometheus + become: yes + template: + src: "{{prometheus_server_conf}}" + dest: "/etc/prometheus/prometheus.yml" + notify: + - restart prometheus service + - restart grafana service + +- name: ensure grafana is started + become: yes + systemd: name="grafana-server.service" enabled="yes" state="started" + +- name: install grafana prometheus data source + become: yes + grafana_datasource: + name: "Prometheus" + ds_type: "prometheus" + ds_url: "http://localhost:9090" + grafana_url: "http://localhost:3000" + is_default: yes + changed_when: false + +- name: install grafana plugins + become: yes + grafana_plugin: name="{{item}}" + loop: "{{prometheus_server_grafana_plugins}}" + +- name: copy dashboards to target + become: yes + copy: + src: "{{prometheus_server_grafana_dashboard_src}}/{{item}}" + dest: "/tmp/" + mode: "0640" + loop: "{{prometheus_server_grafana_dashboards}}" + +# - name: install grafana dashboards +# become: yes +# grafana_dashboard: +# grafana_url: "http://localhost:3000" +# path: "/tmp/{{item}}" +# loop: "{{prometheus_server_grafana_dashboards}}" diff -r 78a072bbf3c1 -r 73eb2db468ec prometheus/server/templates/prometheus.yml.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prometheus/server/templates/prometheus.yml.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,42 @@ +global: + scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute. + evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute. + # scrape_timeout is set to the global default (10s). + + # Attach these labels to any time series or alerts when communicating with + # external systems (federation, remote storage, Alertmanager). + external_labels: + monitor: 'example' + +# Alertmanager configuration +# alerting: +# alertmanagers: +# - static_configs: +# - targets: ['localhost:9093'] + +# Load rules once and periodically evaluate them according to the global 'evaluation_interval'. +# rule_files: + # - "first_rules.yml" + # - "second_rules.yml" + +# A scrape configuration containing exactly one endpoint to scrape: +# Here it's Prometheus itself. +scrape_configs: + # The job name is added as a label `job=` to any timeseries scraped from this config. + - job_name: 'prometheus' + # server stats + static_configs: + - targets: + - 'localhost:9090' + + - job_name: node + # If prometheus-node-exporter is installed, grab stats about the local machine by default. + static_configs: + - targets: + - 'localhost:9100' + + - job_name: rpi + # rpi_exporter + static_configs: + - targets: + - 'localhost:9243' diff -r 78a072bbf3c1 -r 73eb2db468ec prosody/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prosody/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,6 @@ +--- + +prosody_ssl_dir: "/etc/prosody/certs/{{prosody_vhost}}" + +prosody_db: "prosody_{{prosody_instance}}" +prosody_db_port: "5432" diff -r 78a072bbf3c1 -r 73eb2db468ec prosody/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prosody/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart prosody + become: yes + systemd: name="prosody.service" enabled="yes" daemon_reload="yes" diff -r 78a072bbf3c1 -r 73eb2db468ec prosody/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prosody/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,59 @@ +--- + +- name: install prosody + become: yes + apt: name="{{item}}" + notify: restart prosody + loop: + - "prosody" + - "lua-dbi-postgresql" + +- name: configure prosody + become: yes + template: + src: "prosody.cfg.lua.j2" + dest: "/etc/prosody/conf.avail/{{prosody_vhost}}.cfg.lua" + notify: restart prosody + +- name: install prosody site + become: yes + template: src="prosody.cfg.lua.j2" dest="/etc/prosody/conf.avail/{{prosody_vhost}}.cfg.lua" + notify: restart prosody + +- name: copy ssl keys + become: yes + copy: + src: "{{item}}" + dest: "{{prosody_ssl_dir}}/" + remote_src: yes + mode: "0640" + owner: "root" + group: "prosody" + notify: restart prosody + loop: + - "{{prosody_ssl_privkey_src}}" + - "{{prosody_ssl_cert_src}}" + +- name: install db schema file + become: yes + template: + src: "setup_db.psql.j2" + dest: "/tmp/setup_db_{{prosody_db}}.psql" + owner: "postgres" + group: "postgres" + mode: "0600" + changed_when: false + +- name: install psql + become: yes + become_user: "postgres" + command: "psql -f /tmp/setup_db_{{prosody_db}}.psql" + changed_when: false + +- name: enable prosody site + become: yes + file: + src: "/etc/prosody/conf.avail/{{prosody_vhost}}.cfg.lua" + dest: "/etc/prosody/conf.d/{{prosody_vhost}}.cfg.lua" + state: "link" + notify: restart prosody diff -r 78a072bbf3c1 -r 73eb2db468ec prosody/templates/prosody.cfg.lua.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prosody/templates/prosody.cfg.lua.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,31 @@ +VirtualHost "{{prosody_vhost}}" + +ssl = { + key = "{{prosody_ssl_privkey}}"; + certificate = "{{prosody_ssl_cert}}"; +} + +storage = "sql" +sql = { + driver = "PostgreSQL"; + database = "{{prosody_db}}"; + host = "localhost"; + port = {{prosody_db_port}}; + username = "{{prosody_db}}"; + password = "{{prosody_db_pass}}"; +} + +------ Components ------ +-- You can specify components to add hosts that provide special services, +-- like multi-user conferences, and transports. +-- For more information on components, see http://prosody.im/doc/components + +-- Set up a MUC (multi-user chat) room server on conference.example.com: +--Component "conference.example.com" "muc" + +-- Set up a SOCKS5 bytestream proxy for server-proxied file transfers: +--Component "proxy.example.com" "proxy65" + +---Set up an external component (default component port is 5347) +--Component "gateway.example.com" +-- component_secret = "password" diff -r 78a072bbf3c1 -r 73eb2db468ec prosody/templates/setup_db.psql.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/prosody/templates/setup_db.psql.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,2 @@ +CREATE USER {{prosody_db}} WITH ENCRYPTED PASSWORD '{{prosody_db_pass}}'; +CREATE DATABASE {{prosody_db}} ENCODING 'UTF8' LC_COLLATE='C.UTF-8' LC_CTYPE='C.UTF-8' template=template0 OWNER {{prosody_db}}; diff -r 78a072bbf3c1 -r 73eb2db468ec rpi-base/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rpi-base/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,17 @@ +--- + +rpi_base_enable_wifi: True +rpi_base_timezone: "America/Chicago" +rpi_base_log_size: "100M" +rpi_base_apt_packages: + - "avahi-daemon" + - "log2ram" + - "fail2ban" + - "unattended-upgrades" + - "emacs-nox" + - "htop" + - "jq" + - "tree" + - "iperf3" + - "python3-pip" + - "unzip" diff -r 78a072bbf3c1 -r 73eb2db468ec rpi-base/files/jail.local --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rpi-base/files/jail.local Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,10 @@ +[ssh] + +enabled = true +port = ssh +filter = sshd +logpath = /var/log/auth.log +bantime = 900 +banaction = iptables-allports +findtime = 900 +maxretry = 3 diff -r 78a072bbf3c1 -r 73eb2db468ec rpi-base/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rpi-base/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart log2ram service + systemd: name="log2ram" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec rpi-base/tasks/main.yml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rpi-base/tasks/main.yml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,77 @@ +--- + +- name: turn swap off + become: yes + command: "swapoff -a" + changed_when: false + +- name: remove swap apt package + become: yes + apt: state="absent" name="dphys-swapfile" + +- name: add log2ram apt key + become: yes + apt_key: url="https://azlux.fr/repo.gpg.key" + +- name: add log2ram apt repo + become: yes + apt_repository: repo="deb http://packages.azlux.fr/debian/ buster main" + +- name: set timezone + become: yes + timezone: name="{{rpi_base_timezone}}" + +- name: setup wifi + become: yes + template: src="wpa_supplicant.conf.j2" dest="/etc/wpa_supplicant/wpa_supplicant.conf" mode="0600" + +- name: update apt package cache + become: yes + apt: upgrade="dist" autoremove="yes" autoclean="yes" update_cache="yes" cache_valid_time="3600" + +- name: install extra apt packages + become: yes + apt: name="{{rpi_base_apt_packages}}" state="latest" + +- name: configure log2ram disk size + become: yes + lineinfile: + path: "/etc/log2ram.conf" + regexp: "^SIZE=" + line: "SIZE={{rpi_base_log_size}}" + notify: restart log2ram service + +- name: configure fail2ban + become: yes + copy: src="jail.local" dest="/etc/fail2ban/jail.local" + +- name: add users + become: yes + user: + name: "{{admin_user_name}}" + password: "{{admin_user_password}}" + groups: "sudo,users" + shell: "/bin/bash" + append: yes + +- name: authorize admin ssh keys + become: yes + authorized_key: user="{{admin_user_name}}" key="https://github.com/{{github_user}}.keys" + +- name: authorize ssh keys + become: yes + authorized_key: user="{{ansible_user}}" key="https://github.com/{{github_user}}.keys" + +- name: nopasswd sudo for admin user + become: yes + template: + src: "010_admin-nopasswd" + dest: "/etc/sudoers.d/010_admin-nopasswd" + +- name: disable ssh password login + become: yes + lineinfile: + path: "/etc/ssh/sshd_config" + regexp: "^PasswordAuthentication" + insertafter: "^#PasswordAuthentication" + line: "PasswordAuthentication no" diff -r 78a072bbf3c1 -r 73eb2db468ec rpi-base/templates/010_admin-nopasswd --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rpi-base/templates/010_admin-nopasswd Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,1 @@ +{{admin_user_name}} ALL=(ALL) NOPASSWD: ALL diff -r 78a072bbf3c1 -r 73eb2db468ec rpi-base/templates/wpa_supplicant.conf.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/rpi-base/templates/wpa_supplicant.conf.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,14 @@ +# {{ansible_managed}} + +country=US +ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev +update_config=1 +{% for network in wpa_networks %} + +network={ + ssid="{{network.ssid}}" + psk="{{network.psk}}" + disabled={% if rpi_base_enable_wifi %}0{% else %}1{% endif %} + +} +{% endfor %} diff -r 78a072bbf3c1 -r 73eb2db468ec transmission/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/transmission/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,7 @@ +--- + +transmission_config: "/etc/transmission-daemon/settings.json" +transmission_port: "9091" +transmission_passwd: "transmission" +transmission_download_dir: "/var/lib/transmission-daemon/downloads" +transmission_user: "debian-transmission" diff -r 78a072bbf3c1 -r 73eb2db468ec transmission/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/transmission/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,5 @@ +--- + +- name: restart transmission service + systemd: name="transmission-daemon" state="restarted" daemon_reload="yes" + become: yes diff -r 78a072bbf3c1 -r 73eb2db468ec transmission/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/transmission/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,90 @@ +--- + +- name: install transmission + become: yes + apt: name="transmission-daemon" + notify: restart transmission service + +- name: create data dir + become: yes + file: + path: "{{transmission_download_dir}}" + state: "directory" + owner: "{{transmission_user}}" + group: "{{transmission_user}}" + mode: "0755" + recurse: "yes" + +- name: stop transmission service + systemd: name="transmission-daemon" state="stopped" daemon_reload="yes" + become: yes + changed_when: false + +- name: config ip whitelist + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "rpc-whitelist":' + line: ' "rpc-whitelist": "127.0.0.1,192.168.*.*",' + insertafter: ",$" + notify: restart transmission service + +- name: config umask + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "umask":' + line: ' "umask": 2,' + insertafter: ",$" + notify: restart transmission service + +- name: config port + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "rpc-port":' + line: " \"rpc-port\": {{transmission_port}}," + insertafter: ",$" + notify: restart transmission service + +# the password is hashed at start of server so this always changes +- name: config password + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "rpc-password":' + line: " \"rpc-password\": \"{{transmission_passwd}}\"," + insertafter: ",$" + changed_when: false + +- name: config download dir + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "download-dir":' + line: " \"download-dir\": \"{{transmission_download_dir}}\"," + insertafter: ",$" + notify: restart transmission service + +- name: config disable seeding + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "idle-seeding-limit":' + line: " \"idle-seeding-limit\": 0," + insertafter: ",$" + notify: restart transmission service + +- name: config disable seeding + become: yes + lineinfile: + path: "{{transmission_config}}" + regexp: '^ "idle-seeding-limit-enabled":' + line: " \"idle-seeding-limit-enabled\": true," + insertafter: ",$" + notify: restart transmission service + +- name: start transmission service + become: yes + systemd: name="transmission-daemon" state="started" daemon_reload="yes" + changed_when: false diff -r 78a072bbf3c1 -r 73eb2db468ec writefreely/defaults/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/writefreely/defaults/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,11 @@ +--- + +writefreely_user: "writefreely" +writefreely_arch: "arm7" +writefreely_version: "0.12.0" +writefreely_tar: "https://github.com/writeas/writefreely/releases/download/v{{writefreely_version}}/writefreely_{{writefreely_version}}_linux_{{writefreely_arch}}.tar.gz" + +writefreely_dir: "/var/writefreely" +writefreely_port: "8080" +writefreely_url: "https://{{writefreely_instance}}" +writefreely_site_name: "{{writefreely_instance}}" diff -r 78a072bbf3c1 -r 73eb2db468ec writefreely/handlers/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/writefreely/handlers/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,12 @@ +--- + +- name: reload service + become: yes + systemd: name="writefreely@{{writefreely_instance}}.service" enabled="yes" daemon_reload="yes" + +- name: migrate db + become: yes + become_user: "{{writefreely_user}}" + command: "writefreely db migrate" + args: + chdir: "{{writefreely_dir}}/{{writefreely_instance}}/" diff -r 78a072bbf3c1 -r 73eb2db468ec writefreely/tasks/main.yaml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/writefreely/tasks/main.yaml Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,103 @@ +--- + +- name: add writefreely user + become: yes + user: name="{{writefreely_user}}" + +- name: unarchive writefreely + become: yes + unarchive: + remote_src: yes + src: "{{writefreely_tar}}" + dest: "/tmp/" + creates: "/tmp/writefreely/" + owner: "root" + group: "root" + +- name: install writefreely binary + become: yes + copy: + src: "/tmp/writefreely/writefreely" + dest: "/usr/local/bin/" + remote_src: yes + owner: "{{writefreely_user}}" + group: "{{writefreely_user}}" + mode: "0755" + notify: migrate db + +- name: create instance dir + become: yes + file: + path: "{{item}}" + state: "directory" + owner: "{{writefreely_user}}" + group: "{{writefreely_user}}" + mode: "0755" + notify: reload service + loop: + - "{{writefreely_dir}}" + - "{{writefreely_dir}}/{{writefreely_instance}}" + +- name: install static content + become: yes + copy: + src: "/tmp/writefreely/" + remote_src: yes + dest: "{{writefreely_dir}}/{{writefreely_instance}}/" + owner: "{{writefreely_user}}" + group: "{{writefreely_user}}" + mode: "0755" + +- name: configure + become: yes + template: + src: "config.ini.j2" + dest: "{{writefreely_dir}}/{{writefreely_instance}}/config.ini" + mode: "0644" + owner: "{{writefreely_user}}" + group: "{{writefreely_user}}" + notify: reload service + +- name: check if keys exists + stat: + path: "{{writefreely_dir}}/{{writefreely_instance}}/keys/cookies_auth.aes256" + register: keys_file + +- name: generate keys + become: yes + become_user: "{{writefreely_user}}" + command: "writefreely keys gen" + args: + chdir: "{{writefreely_dir}}/{{writefreely_instance}}/" + when: not keys_file.stat.exists + +- name: check if db exists + stat: + path: "{{writefreely_dir}}/{{writefreely_instance}}/writefreely.db" + register: db_file + +- name: create db + become: yes + become_user: "{{writefreely_user}}" + command: "writefreely db init" + args: + chdir: "{{writefreely_dir}}/{{writefreely_instance}}/" + when: not db_file.stat.exists + +- name: create admin + become: yes + become_user: "{{writefreely_user}}" + command: "writefreely --create-admin admin:admin" + args: + chdir: "{{writefreely_dir}}/{{writefreely_instance}}/" + when: not db_file.stat.exists + +- name: install systemd service + become: yes + template: + src: "writefreely@.service.j2" + dest: "/lib/systemd/system/writefreely@.service" + +- name: ensure service is started + become: yes + systemd: name="writefreely@{{writefreely_instance}}.service" enabled="yes" state="started" diff -r 78a072bbf3c1 -r 73eb2db468ec writefreely/templates/config.ini.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/writefreely/templates/config.ini.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,71 @@ +[server] +hidden_host = +port = {{writefreely_port}} +bind = localhost +tls_cert_path = +tls_key_path = +autocert = false +templates_parent_dir = +static_parent_dir = +pages_parent_dir = +keys_parent_dir = +hash_seed = + +[database] +type = sqlite3 +filename = writefreely.db +username = +password = +database = writefreely +host = localhost +port = 3306 + +[app] +site_name = {{writefreely_site_name}} +site_description = +host = {{writefreely_url}} +theme = write +editor = +disable_js = false +webfonts = true +landing = /read +simple_nav = false +wf_modesty = false +chorus = false +forest = false +disable_drafts = false +single_user = false +open_registration = false +min_username_len = 3 +max_blogs = 1 +federation = true +public_stats = true +private = false +local_timeline = true +user_invites = admin +default_visibility = public +update_checks = false + +[oauth.slack] +client_id = +client_secret = +team_id = +callback_proxy = +callback_proxy_api = + +[oauth.writeas] +client_id = +client_secret = +auth_location = +token_location = +inspect_location = +callback_proxy = +callback_proxy_api = + +[oauth.gitlab] +client_id = +client_secret = +host = +display_name = +callback_proxy = +callback_proxy_api = diff -r 78a072bbf3c1 -r 73eb2db468ec writefreely/templates/writefreely@.service.j2 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/writefreely/templates/writefreely@.service.j2 Wed Jul 01 13:09:31 2020 -0500 @@ -0,0 +1,12 @@ +[Unit] +Description=WriteFreely %I Instance +After=syslog.target network.target + +[Service] +WorkingDirectory={{writefreely_dir}}/%i/ +ExecStart=/usr/local/bin/writefreely +Restart=always +User={{writefreely_user}} + +[Install] +WantedBy=multi-user.target