Merge branch 'patch-2' of https://github.com/sakkiii/matrix-docker-ansible-deploy into patch-2
sakkiii
3 years ago
commit
01a5f521cd
@ -0,0 +1,59 @@
|
|||||||
|
# Setting up Beeper Linkedin (optional)
|
||||||
|
|
||||||
|
The playbook can install and configure [beeper-linkedin](https://gitlab.com/beeper/linkedin) for you, for bridging to [LinkedIn](https://www.linkedin.com/) Messaging. This bridge is based on the mautrix-python framework and can be configured in a similar way to the other mautrix bridges
|
||||||
|
|
||||||
|
See the project's [documentation](https://gitlab.com/beeper/linkedin/-/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_beeper_linkedin_enabled: true
|
||||||
|
```
|
||||||
|
|
||||||
|
There are some additional things you may wish to configure about the bridge before you continue.
|
||||||
|
|
||||||
|
Encryption support is off by default. If you would like to enable encryption, add the following to your `vars.yml` file:
|
||||||
|
```yaml
|
||||||
|
matrix_beeper_linkedin_configuration_extension_yaml: |
|
||||||
|
bridge:
|
||||||
|
encryption:
|
||||||
|
allow: true
|
||||||
|
default: true
|
||||||
|
```
|
||||||
|
|
||||||
|
If you would like to be able to administrate the bridge from your account it can be configured like this:
|
||||||
|
```yaml
|
||||||
|
matrix_beeper_linkedin_configuration_extension_yaml: |
|
||||||
|
bridge:
|
||||||
|
permissions:
|
||||||
|
'@YOUR_USERNAME:YOUR_DOMAIN': admin
|
||||||
|
```
|
||||||
|
|
||||||
|
You may wish to look at `roles/matrix-bridge-beeper-linkedin/templates/config.yaml.j2` to find other things you would like to configure.
|
||||||
|
|
||||||
|
|
||||||
|
## Set up Double Puppeting
|
||||||
|
|
||||||
|
If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
|
||||||
|
|
||||||
|
### Method 1: automatically, by enabling Shared Secret Auth
|
||||||
|
|
||||||
|
The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook.
|
||||||
|
|
||||||
|
This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future.
|
||||||
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
You then need to start a chat with `@linkedinbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain).
|
||||||
|
|
||||||
|
Send `login YOUR_LINKEDIN_EMAIL_ADDRESS` to the bridge bot to enable bridging for your LinkedIn account.
|
||||||
|
|
||||||
|
If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.
|
||||||
|
|
||||||
|
After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so.
|
||||||
|
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Bridge asking for 2FA even if you don't have 2FA enabled
|
||||||
|
|
||||||
|
If you don't have 2FA enabled and are logging in from a strange IP for the first time, LinkedIn will send an email with a one-time code. You can use this code to authorize the bridge session. In my experience, once the IP is authorized, you will not be asked again.
|
||||||
@ -0,0 +1,100 @@
|
|||||||
|
# beeper-linkedin is a Matrix <-> LinkedIn bridge
|
||||||
|
# See: https://gitlab.com/beeper/linkedin
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_enabled: true
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_version: v0.5.0
|
||||||
|
# See: https://gitlab.com/beeper/linkedin/container_registry
|
||||||
|
matrix_beeper_linkedin_docker_image: "registry.gitlab.com/beeper/linkedin:{{ matrix_beeper_linkedin_version }}-amd64"
|
||||||
|
matrix_beeper_linkedin_docker_image_force_pull: "{{ matrix_beeper_linkedin_docker_image.endswith(':latest-amd64') }}"
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_base_path: "{{ matrix_base_data_path }}/beeper-linkedin"
|
||||||
|
matrix_beeper_linkedin_config_path: "{{ matrix_beeper_linkedin_base_path }}/config"
|
||||||
|
matrix_beeper_linkedin_data_path: "{{ matrix_beeper_linkedin_base_path }}/data"
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_homeserver_address: "{{ matrix_homeserver_container_url }}"
|
||||||
|
matrix_beeper_linkedin_homeserver_domain: "{{ matrix_domain }}"
|
||||||
|
matrix_beeper_linkedin_appservice_address: "http://matrix-beeper-linkedin:29319"
|
||||||
|
|
||||||
|
# A list of extra arguments to pass to the container
|
||||||
|
matrix_beeper_linkedin_container_extra_arguments: []
|
||||||
|
|
||||||
|
# List of systemd services that matrix-beeper-linkedin.service depends on.
|
||||||
|
matrix_beeper_linkedin_systemd_required_services_list: ['docker.service']
|
||||||
|
|
||||||
|
# List of systemd services that matrix-beeper-linkedin.service wants
|
||||||
|
matrix_beeper_linkedin_systemd_wanted_services_list: []
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_appservice_token: ""
|
||||||
|
matrix_beeper_linkedin_homeserver_token: ""
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_appservice_bot_username: linkedinbot
|
||||||
|
|
||||||
|
|
||||||
|
# Database-related configuration fields.
|
||||||
|
# Only Postgres is supported.
|
||||||
|
matrix_beeper_linkedin_database_engine: "postgres"
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_database_username: 'matrix_beeper_linkedin'
|
||||||
|
matrix_beeper_linkedin_database_password: ""
|
||||||
|
matrix_beeper_linkedin_database_hostname: 'matrix-postgres'
|
||||||
|
matrix_beeper_linkedin_database_port: 5432
|
||||||
|
matrix_beeper_linkedin_database_name: 'matrix_beeper_linkedin'
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_database_connection_string: 'postgresql://{{ matrix_beeper_linkedin_database_username }}:{{ matrix_beeper_linkedin_database_password }}@{{ matrix_beeper_linkedin_database_hostname }}:{{ matrix_beeper_linkedin_database_port }}/{{ matrix_beeper_linkedin_database_name }}?sslmode=disable'
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_appservice_database_type: "{{
|
||||||
|
{
|
||||||
|
'postgres':'postgres',
|
||||||
|
}[matrix_beeper_linkedin_database_engine]
|
||||||
|
}}"
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_appservice_database_uri: "{{
|
||||||
|
{
|
||||||
|
'postgres': matrix_beeper_linkedin_database_connection_string,
|
||||||
|
}[matrix_beeper_linkedin_database_engine]
|
||||||
|
}}"
|
||||||
|
|
||||||
|
|
||||||
|
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
|
||||||
|
matrix_beeper_linkedin_login_shared_secret: ''
|
||||||
|
|
||||||
|
# Default beeper-linkedin configuration template which covers the generic use case.
|
||||||
|
# You can customize it by controlling the various variables inside it.
|
||||||
|
#
|
||||||
|
# For a more advanced customization, you can extend the default (see `matrix_beeper_linkedin_configuration_extension_yaml`)
|
||||||
|
# or completely replace this variable with your own template.
|
||||||
|
matrix_beeper_linkedin_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_configuration_extension_yaml: |
|
||||||
|
# Your custom YAML configuration goes here.
|
||||||
|
# This configuration extends the default starting configuration (`matrix_beeper_linkedin_configuration_yaml`).
|
||||||
|
#
|
||||||
|
# You can override individual variables from the default configuration, or introduce new ones.
|
||||||
|
#
|
||||||
|
# If you need something more special, you can take full control by
|
||||||
|
# completely redefining `matrix_beeper_linkedin_configuration_yaml`.
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_configuration_extension: "{{ matrix_beeper_linkedin_configuration_extension_yaml|from_yaml if matrix_beeper_linkedin_configuration_extension_yaml|from_yaml is mapping else {} }}"
|
||||||
|
|
||||||
|
# Holds the final configuration (a combination of the default and its extension).
|
||||||
|
# You most likely don't need to touch this variable. Instead, see `matrix_beeper_linkedin_configuration_yaml`.
|
||||||
|
matrix_beeper_linkedin_configuration: "{{ matrix_beeper_linkedin_configuration_yaml|from_yaml|combine(matrix_beeper_linkedin_configuration_extension, recursive=True) }}"
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_registration_yaml: |
|
||||||
|
id: linkedin
|
||||||
|
url: {{ matrix_beeper_linkedin_appservice_address }}
|
||||||
|
as_token: "{{ matrix_beeper_linkedin_appservice_token }}"
|
||||||
|
hs_token: "{{ matrix_beeper_linkedin_homeserver_token }}"
|
||||||
|
|
||||||
|
sender_localpart: _bot_{{ matrix_beeper_linkedin_appservice_bot_username }}
|
||||||
|
rate_limited: false
|
||||||
|
namespaces:
|
||||||
|
users:
|
||||||
|
- regex: '^@linkedin_.+:{{ matrix_beeper_linkedin_homeserver_domain|regex_escape }}$'
|
||||||
|
exclusive: true
|
||||||
|
- exclusive: true
|
||||||
|
regex: '^@{{ matrix_beeper_linkedin_appservice_bot_username|regex_escape }}:{{ matrix_beeper_linkedin_homeserver_domain|regex_escape }}$'
|
||||||
|
de.sorunome.msc2409.push_ephemeral: true
|
||||||
|
|
||||||
|
matrix_beeper_linkedin_registration: "{{ matrix_beeper_linkedin_registration_yaml|from_yaml }}"
|
||||||
@ -0,0 +1,16 @@
|
|||||||
|
- set_fact:
|
||||||
|
matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-beeper-linkedin.service'] }}"
|
||||||
|
when: matrix_beeper_linkedin_enabled|bool
|
||||||
|
|
||||||
|
# If the matrix-synapse role is not used, these variables may not exist.
|
||||||
|
- set_fact:
|
||||||
|
matrix_synapse_container_extra_arguments: >
|
||||||
|
{{ matrix_synapse_container_extra_arguments|default([]) }}
|
||||||
|
+
|
||||||
|
["--mount type=bind,src={{ matrix_beeper_linkedin_config_path }}/registration.yaml,dst=/matrix-beeper-linkedin-registration.yaml,ro"]
|
||||||
|
|
||||||
|
matrix_synapse_app_service_config_files: >
|
||||||
|
{{ matrix_synapse_app_service_config_files|default([]) }}
|
||||||
|
+
|
||||||
|
{{ ["/matrix-beeper-linkedin-registration.yaml"] }}
|
||||||
|
when: matrix_beeper_linkedin_enabled|bool
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
- import_tasks: "{{ role_path }}/tasks/init.yml"
|
||||||
|
tags:
|
||||||
|
- always
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
|
||||||
|
when: "run_setup|bool and matrix_beeper_linkedin_enabled|bool"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-beeper-linkedin
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
|
||||||
|
when: "run_setup and matrix_beeper_linkedin_enabled"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-beeper-linkedin
|
||||||
|
|
||||||
|
- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
|
||||||
|
when: "run_setup and not matrix_beeper_linkedin_enabled"
|
||||||
|
tags:
|
||||||
|
- setup-all
|
||||||
|
- setup-beeper-linkedin
|
||||||
@ -0,0 +1,56 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
# If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
|
||||||
|
# We don't want to fail in such cases.
|
||||||
|
- name: Fail if matrix-synapse role already executed
|
||||||
|
fail:
|
||||||
|
msg: >-
|
||||||
|
The matrix-bridge-beeper-linkedin role needs to execute before the matrix-synapse role.
|
||||||
|
when: "matrix_synapse_role_executed|default(False)"
|
||||||
|
|
||||||
|
- name: Ensure Beeper LinkedIn image is pulled
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_beeper_linkedin_docker_image }}"
|
||||||
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||||
|
force_source: "{{ matrix_beeper_linkedin_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||||
|
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_beeper_linkedin_docker_image_force_pull }}"
|
||||||
|
|
||||||
|
- name: Ensure Beeper LinkedIn paths exists
|
||||||
|
file:
|
||||||
|
path: "{{ item }}"
|
||||||
|
state: directory
|
||||||
|
mode: 0750
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
with_items:
|
||||||
|
- "{{ matrix_beeper_linkedin_base_path }}"
|
||||||
|
- "{{ matrix_beeper_linkedin_config_path }}"
|
||||||
|
- "{{ matrix_beeper_linkedin_data_path }}"
|
||||||
|
|
||||||
|
- name: Ensure beeper-linkedin config.yaml installed
|
||||||
|
copy:
|
||||||
|
content: "{{ matrix_beeper_linkedin_configuration|to_nice_yaml }}"
|
||||||
|
dest: "{{ matrix_beeper_linkedin_config_path }}/config.yaml"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
|
||||||
|
- name: Ensure beeper-linkedin registration.yaml installed
|
||||||
|
copy:
|
||||||
|
content: "{{ matrix_beeper_linkedin_registration|to_nice_yaml }}"
|
||||||
|
dest: "{{ matrix_beeper_linkedin_config_path }}/registration.yaml"
|
||||||
|
mode: 0644
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
|
||||||
|
- name: Ensure matrix-beeper-linkedin.service installed
|
||||||
|
template:
|
||||||
|
src: "{{ role_path }}/templates/systemd/matrix-beeper-linkedin.service.j2"
|
||||||
|
dest: "{{ matrix_systemd_path }}/matrix-beeper-linkedin.service"
|
||||||
|
mode: 0644
|
||||||
|
register: matrix_beeper_linkedin_systemd_service_result
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-beeper-linkedin.service installation
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_beeper_linkedin_systemd_service_result.changed"
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Check existence of matrix-beeper-linkedin service
|
||||||
|
stat:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-beeper-linkedin.service"
|
||||||
|
register: matrix_beeper_linkedin_service_stat
|
||||||
|
|
||||||
|
- name: Ensure matrix-beeper-linkedin is stopped
|
||||||
|
service:
|
||||||
|
name: matrix-beeper-linkedin
|
||||||
|
state: stopped
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_beeper_linkedin_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure matrix-beeper-linkedin.service doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-beeper-linkedin.service"
|
||||||
|
state: absent
|
||||||
|
when: "matrix_beeper_linkedin_service_stat.stat.exists"
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-beeper-linkedin.service removal
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_beeper_linkedin_service_stat.stat.exists"
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Fail if required settings not defined
|
||||||
|
fail:
|
||||||
|
msg: >-
|
||||||
|
You need to define a required configuration setting (`{{ item }}`).
|
||||||
|
when: "vars[item] == ''"
|
||||||
|
with_items:
|
||||||
|
- "matrix_beeper_linkedin_appservice_token"
|
||||||
|
- "matrix_beeper_linkedin_homeserver_token"
|
||||||
|
|
||||||
@ -0,0 +1,267 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
# Homeserver details.
|
||||||
|
homeserver:
|
||||||
|
# The address that this appservice can use to connect to the homeserver.
|
||||||
|
address: {{ matrix_beeper_linkedin_homeserver_address }}
|
||||||
|
# The domain of the homeserver (for MXIDs, etc).
|
||||||
|
domain: {{ matrix_beeper_linkedin_homeserver_domain }}
|
||||||
|
# Whether or not to verify the SSL certificate of the homeserver.
|
||||||
|
# Only applies if address starts with https://
|
||||||
|
verify_ssl: true
|
||||||
|
# Whether or not the homeserver supports asmux-specific endpoints,
|
||||||
|
# such as /_matrix/client/unstable/net.maunium.asmux/dms for atomically
|
||||||
|
# updating m.direct.
|
||||||
|
asmux: false
|
||||||
|
# Number of retries for all HTTP requests if the homeserver isn't reachable.
|
||||||
|
http_retry_count: 4
|
||||||
|
|
||||||
|
|
||||||
|
appservice:
|
||||||
|
# The address that the homeserver can use to connect to this appservice.
|
||||||
|
address: {{ matrix_beeper_linkedin_appservice_address }}
|
||||||
|
|
||||||
|
# The hostname and port where this appservice should listen.
|
||||||
|
hostname: 0.0.0.0
|
||||||
|
port: 29319
|
||||||
|
|
||||||
|
# The maximum body size of appservice API requests (from the homeserver) in mebibytes
|
||||||
|
# Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s
|
||||||
|
max_body_size: 1
|
||||||
|
|
||||||
|
# The full URI to the database. Only Postgres is currently supported.
|
||||||
|
database: {{ matrix_beeper_linkedin_appservice_database_uri|to_json }}
|
||||||
|
# Additional arguments for asyncpg.create_pool()
|
||||||
|
# https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool
|
||||||
|
database_opts:
|
||||||
|
min_size: 5
|
||||||
|
max_size: 10
|
||||||
|
|
||||||
|
# Provisioning API part of the web server for automated portal creation and fetching information.
|
||||||
|
# Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager).
|
||||||
|
provisioning:
|
||||||
|
# Whether or not the provisioning API should be enabled.
|
||||||
|
enabled: true
|
||||||
|
# The prefix to use in the provisioning API endpoints.
|
||||||
|
prefix: /_matrix/provision/v1
|
||||||
|
# The shared secret to authorize users of the API.
|
||||||
|
# Set to "generate" to generate and save a new token.
|
||||||
|
shared_secret: generate
|
||||||
|
|
||||||
|
# The unique ID of this appservice.
|
||||||
|
id: beeper_linkedin
|
||||||
|
# Appservice bot details.
|
||||||
|
bot:
|
||||||
|
# Username of the appservice bot.
|
||||||
|
username: {{ matrix_beeper_linkedin_appservice_bot_username|to_json }}
|
||||||
|
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
|
||||||
|
# to leave display name/avatar as-is.
|
||||||
|
displayname: LinkedIn bridge bot
|
||||||
|
avatar: mxc://sumnerevans.com/XMtwdeUBnxYvWNFFrfeTSHqB
|
||||||
|
|
||||||
|
# Whether or not to receive ephemeral events via appservice transactions.
|
||||||
|
# Requires MSC2409 support (i.e. Synapse 1.22+).
|
||||||
|
# You should disable bridge -> sync_with_custom_puppets when this is enabled.
|
||||||
|
ephemeral_events: false
|
||||||
|
|
||||||
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
||||||
|
as_token: "{{ matrix_beeper_linkedin_appservice_token }}"
|
||||||
|
hs_token: "{{ matrix_beeper_linkedin_homeserver_token }}"
|
||||||
|
|
||||||
|
|
||||||
|
# Prometheus telemetry config. Requires prometheus-client to be installed.
|
||||||
|
metrics:
|
||||||
|
enabled: false
|
||||||
|
listen_port: 8000
|
||||||
|
|
||||||
|
# Manhole config.
|
||||||
|
manhole:
|
||||||
|
# Whether or not opening the manhole is allowed.
|
||||||
|
enabled: false
|
||||||
|
# The path for the unix socket.
|
||||||
|
path: /var/tmp/linkedin-matrix.manhole
|
||||||
|
# The list of UIDs who can be added to the whitelist.
|
||||||
|
# If empty, any UIDs can be specified in the open-manhole command.
|
||||||
|
whitelist:
|
||||||
|
- 0
|
||||||
|
|
||||||
|
|
||||||
|
# Bridge config
|
||||||
|
bridge:
|
||||||
|
# Localpart template of MXIDs for LinkedIn users.
|
||||||
|
username_template: "linkedin_{userid}"
|
||||||
|
# Displayname template for LinkedIn users.
|
||||||
|
# Localpart template for per-user room grouping community IDs.
|
||||||
|
# The bridge will create these communities and add all of the specific user's portals to the community.
|
||||||
|
# {localpart} is the MXID localpart and {server} is the MXID server part of the user.
|
||||||
|
# (Note that, by default, non-admins might not have your homeserver's permission to create
|
||||||
|
# communities. You should set `enable_group_creation: true` in homeserver.yaml to fix this.)
|
||||||
|
# `linkedin_{localpart}={server}` is a good value.
|
||||||
|
community_template: null
|
||||||
|
|
||||||
|
# Displayname template for LinkedIn users.
|
||||||
|
# {displayname} is replaced with the display name of the LinkedIn user
|
||||||
|
# as defined below in displayname_preference.
|
||||||
|
# Keys available for displayname_preference are also available here.
|
||||||
|
displayname_template: "{displayname} (LinkedIn)"
|
||||||
|
|
||||||
|
# Number of chats to sync (and create portals for) on startup/login.
|
||||||
|
# Set 0 to disable automatic syncing.
|
||||||
|
initial_chat_sync: 10
|
||||||
|
|
||||||
|
# Whether or not the LinkedIn users of logged in Matrix users should be
|
||||||
|
# invited to private chats when the user sends a message from another client.
|
||||||
|
invite_own_puppet_to_pm: false
|
||||||
|
# Whether or not to use /sync to get presence, read receipts and typing notifications
|
||||||
|
# when double puppeting is enabled
|
||||||
|
sync_with_custom_puppets: true
|
||||||
|
# Whether or not to update the m.direct account data event when double puppeting is enabled.
|
||||||
|
# Note that updating the m.direct event is not atomic (except with mautrix-asmux)
|
||||||
|
# and is therefore prone to race conditions.
|
||||||
|
sync_direct_chat_list: false
|
||||||
|
# Servers to always allow double puppeting from
|
||||||
|
double_puppet_server_map: {}
|
||||||
|
# example.com: https://example.com
|
||||||
|
# Allow using double puppeting from any server with a valid client .well-known file.
|
||||||
|
|
||||||
|
# Maximum number of seconds since last message in chat to skip
|
||||||
|
# syncing the chat in any case. This setting will take priority
|
||||||
|
# over both recovery_chat_sync_limit and initial_chat_sync_count.
|
||||||
|
# Default is 3 days = 259200 seconds
|
||||||
|
sync_max_chat_age: 259200
|
||||||
|
|
||||||
|
# Whether or not to sync with custom puppets to receive EDUs that
|
||||||
|
# are not normally sent to appservices.
|
||||||
|
sync_with_custom_puppets: true
|
||||||
|
# Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
|
||||||
|
#
|
||||||
|
# If set, custom puppets will be enabled automatically for local users
|
||||||
|
# instead of users having to find an access token and run `login-matrix`
|
||||||
|
# manually.
|
||||||
|
login_shared_secret: {{ matrix_beeper_linkedin_login_shared_secret|to_json }}
|
||||||
|
|
||||||
|
# Allow using double puppeting from any server with a valid client .well-known file.
|
||||||
|
double_puppet_allow_discovery: false
|
||||||
|
|
||||||
|
# Whether or not to bridge presence in both directions. LinkedIn allows users not to broadcast
|
||||||
|
# presence, but then it won't send other users' presence to the client.
|
||||||
|
presence: {{ matrix_beeper_linkedin_bridge_presence|to_json }}
|
||||||
|
# Whether or not to update avatars when syncing all contacts at startup.
|
||||||
|
update_avatar_initial_sync: true
|
||||||
|
|
||||||
|
|
||||||
|
# End-to-bridge encryption support options. These require matrix-nio to be installed with pip
|
||||||
|
# and login_shared_secret to be configured in order to get a device for the bridge bot.
|
||||||
|
#
|
||||||
|
# Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal
|
||||||
|
# application service.
|
||||||
|
encryption:
|
||||||
|
# Allow encryption, work in group chat rooms with e2ee enabled
|
||||||
|
allow: false
|
||||||
|
# Default to encryption, force-enable encryption in all portals the bridge creates
|
||||||
|
# This will cause the bridge bot to be in private chats for the encryption to work properly.
|
||||||
|
default: false
|
||||||
|
# Options for automatic key sharing.
|
||||||
|
key_sharing:
|
||||||
|
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
|
||||||
|
# You must use a client that supports requesting keys from other users to use this feature.
|
||||||
|
allow: false
|
||||||
|
# Require the requesting device to have a valid cross-signing signature?
|
||||||
|
# This doesn't require that the bridge has verified the device, only that the user has verified it.
|
||||||
|
# Not yet implemented.
|
||||||
|
require_cross_signing: false
|
||||||
|
# Require devices to be verified by the bridge?
|
||||||
|
# Verification by the bridge is not yet implemented.
|
||||||
|
require_verification: true
|
||||||
|
# Whether or not the bridge should send a read receipt from the bridge bot when a message has
|
||||||
|
# been sent to LinkedIn.
|
||||||
|
delivery_receipts: false
|
||||||
|
# Whether to allow inviting arbitrary mxids to portal rooms
|
||||||
|
allow_invites: false
|
||||||
|
|
||||||
|
# Settings for backfilling messages from LinkedIn.
|
||||||
|
backfill:
|
||||||
|
# Whether or not the LinkedIn users of logged in Matrix users should be
|
||||||
|
# invited to private chats when backfilling history from LinkedIn. This is
|
||||||
|
# usually needed to prevent rate limits and to allow timestamp massaging.
|
||||||
|
invite_own_puppet: true
|
||||||
|
# Maximum number of messages to backfill initially.
|
||||||
|
# Set to 0 to disable backfilling when creating portal.
|
||||||
|
initial_limit: 0
|
||||||
|
# Maximum number of messages to backfill if messages were missed while
|
||||||
|
# the bridge was disconnected.
|
||||||
|
# Set to 0 to disable backfilling missed messages.
|
||||||
|
missed_limit: 1000
|
||||||
|
# If using double puppeting, should notifications be disabled
|
||||||
|
# while the initial backfill is in progress?
|
||||||
|
disable_notifications: false
|
||||||
|
periodic_reconnect:
|
||||||
|
# TODO needed?
|
||||||
|
# Interval in seconds in which to automatically reconnect all users.
|
||||||
|
# This can be used to automatically mitigate the bug where Linkedin stops sending messages.
|
||||||
|
# Set to -1 to disable periodic reconnections entirely.
|
||||||
|
interval: -1
|
||||||
|
# What to do in periodic reconnects. Either "refresh" or "reconnect"
|
||||||
|
mode: refresh
|
||||||
|
# Should even disconnected users be reconnected?
|
||||||
|
always: false
|
||||||
|
# The number of seconds that a disconnection can last without triggering an automatic re-sync
|
||||||
|
# and missed message backfilling when reconnecting.
|
||||||
|
# Set to 0 to always re-sync, or -1 to never re-sync automatically.
|
||||||
|
resync_max_disconnected_time: 5
|
||||||
|
# Whether or not temporary disconnections should send notices to the notice room.
|
||||||
|
# If this is false, disconnections will never send messages and connections will only send
|
||||||
|
# messages if it was disconnected for more than resync_max_disconnected_time seconds.
|
||||||
|
temporary_disconnect_notices: true
|
||||||
|
# Whether or not the bridge should try to "refresh" the connection if a normal reconnection
|
||||||
|
# attempt fails.
|
||||||
|
refresh_on_reconnection_fail: false
|
||||||
|
# Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
|
||||||
|
# This field will automatically be changed back to false after it,
|
||||||
|
# except if the config file is not writable.
|
||||||
|
resend_bridge_info: false
|
||||||
|
# When using double puppeting, should muted chats be muted in Matrix?
|
||||||
|
mute_bridging: false
|
||||||
|
# Whether or not mute status and tags should only be bridged when the portal room is created.
|
||||||
|
tag_only_on_create: true
|
||||||
|
|
||||||
|
|
||||||
|
# The prefix for commands. Only required in non-management rooms.
|
||||||
|
command_prefix: "!li"
|
||||||
|
|
||||||
|
# Permissions for using the bridge.
|
||||||
|
# Permitted values:
|
||||||
|
# user - Access to use the bridge to chat with a Linkedin account.
|
||||||
|
# admin - User level and some additional administration tools
|
||||||
|
# Permitted keys:
|
||||||
|
# * - All Matrix users
|
||||||
|
# domain - All users on that homeserver
|
||||||
|
# mxid - Specific user
|
||||||
|
permissions:
|
||||||
|
"{{ matrix_beeper_linkedin_homeserver_domain }}": user
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Logging config.
|
||||||
|
logging:
|
||||||
|
version: 1
|
||||||
|
formatters:
|
||||||
|
colored:
|
||||||
|
(): mautrix.util.logging.color.ColorFormatter
|
||||||
|
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
|
||||||
|
normal:
|
||||||
|
format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
|
||||||
|
handlers:
|
||||||
|
console:
|
||||||
|
class: logging.StreamHandler
|
||||||
|
formatter: colored
|
||||||
|
loggers:
|
||||||
|
mau:
|
||||||
|
level: DEBUG
|
||||||
|
paho:
|
||||||
|
level: INFO
|
||||||
|
aiohttp:
|
||||||
|
level: INFO
|
||||||
|
root:
|
||||||
|
level: DEBUG
|
||||||
|
handlers: [ console]
|
||||||
|
|
||||||
@ -0,0 +1,42 @@
|
|||||||
|
#jinja2: lstrip_blocks: "True"
|
||||||
|
[Unit]
|
||||||
|
Description=Matrix Beeper Linkedin bridge
|
||||||
|
{% for service in matrix_beeper_linkedin_systemd_required_services_list %}
|
||||||
|
Requires={{ service }}
|
||||||
|
After={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
{% for service in matrix_beeper_linkedin_systemd_wanted_services_list %}
|
||||||
|
Wants={{ service }}
|
||||||
|
{% endfor %}
|
||||||
|
DefaultDependencies=no
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
Environment="HOME={{ matrix_systemd_unit_home_path }}"
|
||||||
|
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-beeper-linkedin 2>/dev/null'
|
||||||
|
ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-beeper-linkedin 2>/dev/null'
|
||||||
|
|
||||||
|
# Intentional delay, so that the homeserver (we likely depend on) can manage to start.
|
||||||
|
ExecStartPre={{ matrix_host_command_sleep }} 5
|
||||||
|
|
||||||
|
ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-beeper-linkedin \
|
||||||
|
--log-driver=none \
|
||||||
|
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
|
||||||
|
--cap-drop=ALL \
|
||||||
|
--network={{ matrix_docker_network }} \
|
||||||
|
-v {{ matrix_beeper_linkedin_config_path }}:/data:z \
|
||||||
|
--workdir=/opt/linkedin-matrix \
|
||||||
|
{% for arg in matrix_beeper_linkedin_container_extra_arguments %}
|
||||||
|
{{ arg }} \
|
||||||
|
{% endfor %}
|
||||||
|
{{ matrix_beeper_linkedin_docker_image }} \
|
||||||
|
python3 -m linkedin_matrix -c /data/config.yaml -r /data/registration.yaml
|
||||||
|
|
||||||
|
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-beeper-linkedin 2>/dev/null'
|
||||||
|
ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-beeper-linkedin 2>/dev/null'
|
||||||
|
Restart=always
|
||||||
|
RestartSec=30
|
||||||
|
SyslogIdentifier=matrix-beeper-linkedin
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@ -1,88 +0,0 @@
|
|||||||
---
|
|
||||||
|
|
||||||
#
|
|
||||||
# Tasks related to setting up Email2Matrix
|
|
||||||
#
|
|
||||||
|
|
||||||
- name: Ensure Email2Matrix paths exist
|
|
||||||
file:
|
|
||||||
path: "{{ item }}"
|
|
||||||
state: directory
|
|
||||||
mode: 0750
|
|
||||||
owner: "{{ matrix_user_username }}"
|
|
||||||
group: "{{ matrix_user_groupname }}"
|
|
||||||
with_items:
|
|
||||||
- "{{ matrix_email2matrix_base_path }}"
|
|
||||||
- "{{ matrix_email2matrix_config_dir_path }}"
|
|
||||||
when: matrix_email2matrix_enabled|bool
|
|
||||||
|
|
||||||
- name: Ensure Email2Matrix configuration file created
|
|
||||||
template:
|
|
||||||
src: "{{ role_path }}/templates/config.json.j2"
|
|
||||||
dest: "{{ matrix_email2matrix_config_dir_path }}/config.json"
|
|
||||||
owner: "{{ matrix_user_username }}"
|
|
||||||
group: "{{ matrix_user_groupname }}"
|
|
||||||
mode: 0640
|
|
||||||
when: matrix_email2matrix_enabled|bool
|
|
||||||
|
|
||||||
- name: Ensure Email2Matrix image is pulled
|
|
||||||
docker_image:
|
|
||||||
name: "{{ matrix_email2matrix_docker_image }}"
|
|
||||||
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
|
||||||
force_source: "{{ matrix_email2matrix_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
|
||||||
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_email2matrix_docker_image_force_pull }}"
|
|
||||||
when: matrix_email2matrix_enabled|bool
|
|
||||||
|
|
||||||
- name: Ensure matrix-email2matrix.service installed
|
|
||||||
template:
|
|
||||||
src: "{{ role_path }}/templates/systemd/matrix-email2matrix.service.j2"
|
|
||||||
dest: "{{ matrix_systemd_path }}/matrix-email2matrix.service"
|
|
||||||
mode: 0644
|
|
||||||
register: matrix_email2matrix_systemd_service_result
|
|
||||||
when: matrix_email2matrix_enabled|bool
|
|
||||||
|
|
||||||
- name: Ensure systemd reloaded after matrix-email2matrix.service installation
|
|
||||||
service:
|
|
||||||
daemon_reload: yes
|
|
||||||
when: "matrix_email2matrix_enabled|bool and matrix_email2matrix_systemd_service_result.changed"
|
|
||||||
|
|
||||||
#
|
|
||||||
# Tasks related to getting rid of the Email2Matrix (if it was previously enabled)
|
|
||||||
#
|
|
||||||
|
|
||||||
- name: Check existence of matrix-email2matrix service
|
|
||||||
stat:
|
|
||||||
path: "{{ matrix_systemd_path }}/matrix-email2matrix.service"
|
|
||||||
register: matrix_email2matrix_service_stat
|
|
||||||
when: "not matrix_email2matrix_enabled|bool"
|
|
||||||
|
|
||||||
- name: Ensure matrix-email2matrix is stopped
|
|
||||||
service:
|
|
||||||
name: matrix-email2matrix
|
|
||||||
state: stopped
|
|
||||||
daemon_reload: yes
|
|
||||||
register: stopping_result
|
|
||||||
when: "not matrix_email2matrix_enabled|bool and matrix_email2matrix_service_stat.stat.exists"
|
|
||||||
|
|
||||||
- name: Ensure matrix-email2matrix.service doesn't exist
|
|
||||||
file:
|
|
||||||
path: "{{ matrix_systemd_path }}/matrix-email2matrix.service"
|
|
||||||
state: absent
|
|
||||||
when: "not matrix_email2matrix_enabled|bool and matrix_email2matrix_service_stat.stat.exists"
|
|
||||||
|
|
||||||
- name: Ensure systemd reloaded after matrix-email2matrix.service removal
|
|
||||||
service:
|
|
||||||
daemon_reload: yes
|
|
||||||
when: "not matrix_email2matrix_enabled|bool and matrix_email2matrix_service_stat.stat.exists"
|
|
||||||
|
|
||||||
- name: Ensure Email2Matrix data path doesn't exist
|
|
||||||
file:
|
|
||||||
path: "{{ matrix_email2matrix_base_path }}"
|
|
||||||
state: absent
|
|
||||||
when: "not matrix_email2matrix_enabled|bool"
|
|
||||||
|
|
||||||
- name: Ensure Email2Matrix Docker image doesn't exist
|
|
||||||
docker_image:
|
|
||||||
name: "{{ matrix_email2matrix_docker_image }}"
|
|
||||||
state: absent
|
|
||||||
when: "not matrix_email2matrix_enabled|bool"
|
|
||||||
@ -0,0 +1,63 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix paths exist
|
||||||
|
file:
|
||||||
|
path: "{{ item.path }}"
|
||||||
|
state: directory
|
||||||
|
mode: 0750
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
with_items:
|
||||||
|
- { path: "{{ matrix_email2matrix_base_path }}", when: true }
|
||||||
|
- { path: "{{ matrix_email2matrix_config_dir_path }}", when: true }
|
||||||
|
- { path: "{{ matrix_email2matrix_docker_src_files_path }}", when: "{{ matrix_email2matrix_container_image_self_build }}"}
|
||||||
|
when: "item.when|bool"
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix configuration file created
|
||||||
|
template:
|
||||||
|
src: "{{ role_path }}/templates/config.json.j2"
|
||||||
|
dest: "{{ matrix_email2matrix_config_dir_path }}/config.json"
|
||||||
|
owner: "{{ matrix_user_username }}"
|
||||||
|
group: "{{ matrix_user_groupname }}"
|
||||||
|
mode: 0640
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix image is pulled
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_email2matrix_docker_image }}"
|
||||||
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||||
|
force_source: "{{ matrix_email2matrix_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||||
|
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_email2matrix_docker_image_force_pull }}"
|
||||||
|
when: "not matrix_email2matrix_container_image_self_build|bool"
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix repository is present on self-build
|
||||||
|
git:
|
||||||
|
repo: "{{ matrix_email2matrix_container_image_self_build_repo }}"
|
||||||
|
dest: "{{ matrix_email2matrix_docker_src_files_path }}"
|
||||||
|
version: "{{ matrix_email2matrix_container_image_self_build_branch }}"
|
||||||
|
force: "yes"
|
||||||
|
register: matrix_email2matrix_git_pull_results
|
||||||
|
when: "matrix_email2matrix_container_image_self_build|bool"
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix Docker image is built
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_email2matrix_docker_image }}"
|
||||||
|
source: build
|
||||||
|
force_source: "{{ matrix_email2matrix_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
||||||
|
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_email2matrix_git_pull_results.changed }}"
|
||||||
|
build:
|
||||||
|
dockerfile: etc/docker/Dockerfile
|
||||||
|
path: "{{ matrix_email2matrix_docker_src_files_path }}"
|
||||||
|
pull: yes
|
||||||
|
when: "matrix_email2matrix_container_image_self_build|bool"
|
||||||
|
|
||||||
|
- name: Ensure matrix-email2matrix.service installed
|
||||||
|
template:
|
||||||
|
src: "{{ role_path }}/templates/systemd/matrix-email2matrix.service.j2"
|
||||||
|
dest: "{{ matrix_systemd_path }}/matrix-email2matrix.service"
|
||||||
|
mode: 0644
|
||||||
|
register: matrix_email2matrix_systemd_service_result
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-email2matrix.service installation
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_email2matrix_systemd_service_result.changed|bool"
|
||||||
@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Check existence of matrix-email2matrix service
|
||||||
|
stat:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-email2matrix.service"
|
||||||
|
register: matrix_email2matrix_service_stat
|
||||||
|
|
||||||
|
- name: Ensure matrix-email2matrix is stopped
|
||||||
|
service:
|
||||||
|
name: matrix-email2matrix
|
||||||
|
state: stopped
|
||||||
|
daemon_reload: yes
|
||||||
|
register: stopping_result
|
||||||
|
when: "matrix_email2matrix_service_stat.stat.exists|bool"
|
||||||
|
|
||||||
|
- name: Ensure matrix-email2matrix.service doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_systemd_path }}/matrix-email2matrix.service"
|
||||||
|
state: absent
|
||||||
|
when: "matrix_email2matrix_service_stat.stat.exists|bool"
|
||||||
|
|
||||||
|
- name: Ensure systemd reloaded after matrix-email2matrix.service removal
|
||||||
|
service:
|
||||||
|
daemon_reload: yes
|
||||||
|
when: "matrix_email2matrix_service_stat.stat.exists|bool"
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix data path doesn't exist
|
||||||
|
file:
|
||||||
|
path: "{{ matrix_email2matrix_base_path }}"
|
||||||
|
state: absent
|
||||||
|
|
||||||
|
- name: Ensure Email2Matrix Docker image doesn't exist
|
||||||
|
docker_image:
|
||||||
|
name: "{{ matrix_email2matrix_docker_image }}"
|
||||||
|
state: absent
|
||||||
Loading…
Reference in new issue