mirror of
				https://github.com/spantaleev/matrix-docker-ansible-deploy.git
				synced 2025-10-29 22:37:56 +01:00 
			
		
		
		
	This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those.
		
			
				
	
	
		
			82 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			YAML
		
	
	
	
	
	
			
		
		
	
	
			82 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			YAML
		
	
	
	
	
	
| ---
 | |
| 
 | |
| # matrix-aux is a role that manages auxiliary files and directories on your Matrix server.
 | |
| #
 | |
| # Certain components (like matrix-synapse, etc.) may sometimes require additional templates (email templates, privacy policies, etc.).
 | |
| # This role allows such files to be managed by the playbook.
 | |
| #
 | |
| # Note that files and directories created via this role are not automatically made available for containers to use.
 | |
| # If you use this role to put files in a directory that's already mounted into a container,
 | |
| # you can access the files without additional work.
 | |
| # Otherwise, you'd need to mount the file/directory to the container that needs it.
 | |
| # Roles usually provide a `matrix_*_additional_volumes` or `matrix_*_container_extra_arguments` variable
 | |
| # that you can use to mount an additional volume.
 | |
| 
 | |
| # The default permission mode when creating directories using `matrix_aux_directory_definitions`
 | |
| matrix_aux_directory_default_mode: '0750'
 | |
| 
 | |
| # Holds a list of directories to create on the server.
 | |
| #
 | |
| # By default, directories are:
 | |
| # - created with permissions as specified in `matrix_aux_directory_default_mode`
 | |
| # - owned by the `matrix_user_username` user and `matrix_user_groupname` group (usually `matrix:matrix`)
 | |
| #
 | |
| # Example:
 | |
| #
 | |
| # matrix_aux_directory_definitions:
 | |
| #   - dest: /matrix/aux
 | |
| #
 | |
| #   - dest: /matrix/another
 | |
| #     mode: '0700'
 | |
| #     owner: 'some-user'
 | |
| #     group: 'some-group'
 | |
| matrix_aux_directory_definitions: []
 | |
| 
 | |
| # The default permission mode when creating directories using `matrix_aux_directory_definitions`
 | |
| matrix_aux_file_default_mode: '0640'
 | |
| 
 | |
| # Holds a list of files to create on the server.
 | |
| #
 | |
| # By default, files are:
 | |
| # - created with permissions as specified in `matrix_aux_file_default_mode`
 | |
| # - owned by the `matrix_user_username` user and `matrix_user_groupname` group (usually `matrix:matrix`)
 | |
| #
 | |
| # You can define the file content inline (in your `vars.yml` file) or as an external file (see the example below).
 | |
| # Defining the content inline in `vars.yml` has the benefit of not splitting your configuration into multiple files,
 | |
| # but rather keeping everything inside `vars.yml` (which also gets backed up on the server in `/matrix/vars.yml`).
 | |
| #
 | |
| # Note: parent paths for files must exist.
 | |
| # If you've defined a file with a destination of `/matrix/some/path/file.txt`,
 | |
| # then you likely need to add `/matrix/some/path` to `matrix_aux_directory_definitions` as well.
 | |
| # You don't need to do this for directories that the playbook already creates for you.
 | |
| #
 | |
| # Use a `content` key for text content and `src` with a location to a file for binary content.
 | |
| # The `content` key does not support binary content (see https://github.com/ansible/ansible/issues/11594).
 | |
| #
 | |
| # Example:
 | |
| #
 | |
| # matrix_aux_file_definitions:
 | |
| #   - dest: "{{ matrix_synapse_config_dir_path }}/something.html"
 | |
| #     content: |
 | |
| #       <!doctype html>
 | |
| #       <html><body>Something</body></html>
 | |
| #
 | |
| #   - dest: /matrix/aux/some-other-file.txt
 | |
| #     content: "Something"
 | |
| #     mode: '0600'
 | |
| #     owner: 'some-user'
 | |
| #     group: 'some-group'
 | |
| #
 | |
| #   - dest: /matrix/aux/yet-another-file.txt
 | |
| #     content: "{{ lookup('template', '/path/to/file.txt.j2') }}"
 | |
| #     mode: '0600'
 | |
| #     owner: 'some-user'
 | |
| #     group: 'some-group'
 | |
| #
 | |
| #   - dest: /matrix/aux/binary-file.dat
 | |
| #     src: "/path/to/binary.dat"
 | |
| #     mode: '0600'
 | |
| #     owner: 'some-user'
 | |
| #     group: 'some-group'
 | |
| matrix_aux_file_definitions: []
 |