ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-21 12:14:01 +00:00
Code Issues Projects Releases Wiki Activity

feat(etherpad): add optional admin web-UI access

Browse Source 
Enables optional access to Etherpad's web-UI. This is useful for
managing Etherpad plugins.

Among other things, plugins makes it easy to manage/delete pads if you
install the adminpads2 plugin.
This commit is contained in:
Jim Myhrberg 2022-01-01 03:08:00 +00:00
parent 948c411106
commit 993121e517
No known key found for this signature in database
GPG Key ID: B85A9E6D6BBB670E
3 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/configuring-playbook-etherpad.md
View File

@ -25,6 +25,23 @@ The Dimension administrator users can configure the default URL template. The Di
If you wish to disable the Etherpad chat button, you can do it by appending `?showChat=false` to the end of the pad URL, or the template.
Example: `https://dimension.<your-domain>/etherpad/p/$roomId_$padName?showChat=false`
### Etherpad Admin access (optional)
Etherpad comes with a admin web-UI which is disabled by default. You can enable it by setting a username and password in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
```yaml
matrix_etherpad_admin_username: admin
matrix_etherpad_admin_password: some-password
```
The admin web-UI should then be available on: `https://dimension.<your-domain>/etherpad/admin`
### Managing / Deleting old pads
If you want to manage and remove old unused pads from Etherpad, you will first need to able Admin access as described above.
Then from the plugin manager page (`https://dimension.<your-domain>/etherpad/admin/plugins`), install the `adminpads2` plugin. Once installed, you should have a "Manage pads" section in the Admin web-UI.
## Known issues
If your Etherpad widget fails to load, this might be due to Dimension generating a Pad name so long, the Etherpad app rejects it.

5
roles/matrix-etherpad/defaults/main.yml
View File

@ -41,6 +41,11 @@ matrix_etherpad_database_hostname: 'matrix-postgres'
matrix_etherpad_database_port: 5432
matrix_etherpad_database_name: 'matrix_etherpad'
# If a admin username and password is set, the /admin web page will be
# available.
matrix_etherpad_admin_username: ''
matrix_etherpad_admin_password: ''
matrix_etherpad_database_connection_string: 'postgres://{{ matrix_etherpad_database_username }}:{{ matrix_etherpad_database_password }}@{{ matrix_etherpad_database_hostname }}:{{ matrix_etherpad_database_port }}/{{ matrix_etherpad_database_name }}'
# Variables configuring the etherpad

8
roles/matrix-etherpad/templates/settings.json.j2
View File

@ -71,6 +71,14 @@
"chatAndUsers": false,
"lang": "en-gb"
},
{% if matrix_etherpad_admin_username != "" and matrix_etherpad_admin_password != "" %}
"users": {
"{{ matrix_etherpad_admin_username }}": {
"password": "{{ matrix_etherpad_admin_password }}",
"is_admin": true
}
},
{% endif %}
"padShortcutEnabled" : {
"altF9": true,
"altC": true,