A Matrix bot which downloads all media from the rooms it's invited to.
It will download all kind of content with a URL to the output directory. A folder will be created per room.
It will be tried to keep the original filename received by Matrix, but there might be numeric suffixes added to avoid files being overriden or - if no filename is available - the timestamp of the message will be used.
- Option A: run via Node.js:
- Copy/rename
.env.sample
to.env
- Configure the environment variables in this file (see details below)
- Run
node index.js
- Copy/rename
- Option B: run via Docker Compose:
- Copy/rename
docker-compose.sample.yml
todocker-compose.yml
- Configure the environment variables in this file (see details below)
- Run
docker-compose up
(or append-d
to run as daemon)
- Copy/rename
Variable | Required | Description |
---|---|---|
HOMESERVER_URL | Yes | Path to your homeserver. |
ACCESS_TOKEN | Yes | Access token of your bot user. Learn how to get an access token. |
MSG_TYPES | No | Comma separated list of message types to fetch. Defaults to everything with a URL. Sample value: m.audio,m.file,m.image,m.video |
OUTPUT_PATH | No | Path to output directory. |