https://github.com/xwiki-labs/synapse_scripts

Tools for maintaining a matrix synapse chat server // SEEKING MAINTAINERS
https://github.com/xwiki-labs/synapse_scripts

maintainers

Last synced: 5 days ago
JSON representation

Tools for maintaining a matrix synapse chat server // SEEKING MAINTAINERS

• Host: GitHub
• URL: https://github.com/xwiki-labs/synapse_scripts
• Owner: xwiki-labs
• Archived: true
• Created: 2017-10-03T07:13:41.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-21T16:38:29.000Z (over 4 years ago)
• Last Synced: 2024-07-29T04:39:40.223Z (3 months ago)
• Topics: maintainers
• Language: PLpgSQL
• Homepage:
• Size: 9.77 KB
• Stars: 63
• Watchers: 14
• Forks: 12
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-starred - xwiki-labs/synapse_scripts - Tools for maintaining a matrix synapse chat server // SEEKING MAINTAINERS (others)

README

        
# UNMAINTAINED AND DANGEROUS

These script aren't maintained and the synapse team had problems with people who used this, where it broke their server.

The synapse team advises against using these scripts.

# Synapse Scripts

## synapse_janitor.sql

Cleans a synapse Postgres database of deleted messages and abandoned rooms.

### Deleted Messages

If a message was sent in matrix and is then deleted (or *redacted* in technical parlance) it is not displayed but it is not removed from the server either. This script removes it.

### Abandoned Rooms

If a room has been joined by someone on your homeserver but currently nobody on your homeserver is using it, this script will remove all traces of that room. **NOTE**: It will cause the room to disappear from people's "historical" section of old rooms.

This can improve performance significantly.

### Using this script

This script should be run from the command line while synapse server is stopped.

```

psql -Umatrix synapse < synapse_janitor.sql

```

## synapse_dumper.sh

Allows easy backup of a matrix postgres database by dumping it to a compressed file.

## synapse_startloop.sh

Script which starts up synapse if it is not running. **NOTE**: This is configured for a matrix server which has the synchrotron

worker enabled, if you do not use the synchrotron, just comment the block at the bottom.

## Using these scripts

The startloop and the dumper are appropriate for use in crontab:

```

* * * * * /home/matrix/synapse_scripts/synapse_startloop.sh 2>&1 >>/home/matrix/synapse_startloop.log

0 3 * * * /home/matrix/synapse_scripts/synapse_dumper.sh 2>&1 >>/home/matrix/synapse_dumper.log

```