Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msrd0/docker-stickerpicker
Docker container to host https://github.com/maunium/stickerpicker with a self-hosted s3 backend
https://github.com/msrd0/docker-stickerpicker
Last synced: 9 days ago
JSON representation
Docker container to host https://github.com/maunium/stickerpicker with a self-hosted s3 backend
- Host: GitHub
- URL: https://github.com/msrd0/docker-stickerpicker
- Owner: msrd0
- License: gpl-3.0
- Created: 2021-08-29T20:58:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-10T15:51:06.000Z (about 2 years ago)
- Last Synced: 2024-10-11T02:32:43.645Z (26 days ago)
- Language: Rust
- Homepage:
- Size: 94.7 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-stickerpicker
Docker container to host https://github.com/maunium/stickerpicker with a self-hosted s3 backend
## Features:
* custom sticker packs for the matrix messenger
* multiple profiles, so different people can use different packs
## Setup Server:
### Requirements:
* (local) s3 bucket, with no password
* Docker
* http reverse proxy for tls (optional, but strongly recommended)
### setup:
docker-compose:
```yaml
stickerpicker:
image: ghcr.io/msrd0/stickerpicker
environment:
- "HOMESERVER=https://MATRIX.SERVER.URL"
- "PACKS_S3_SERVER=https://S3.SERVER.URL"
- "PACKS_S3_BUCKET=stickerpicker"
ports:
- "8080:8080"
restart: unless-stopped
```
Environment variable:
* PACKS_S3_SERVER the url of your s3 server
* PACKS_S3_BUCKET the name of your s3 bucket
* HOMESERVER publicly accessible homeserver url, which is used to render the preview images; can be different from the server, where the stickers are saved
### add sticker packs:
* create a stickerpack using the [stickerpicker-import/creating script](https://github.com/maunium/stickerpicker/wiki/Creating-packs)
* upload the created `.json` of your stickerpack (located in `web/packs/`) to `/PROFILE_NAME/*.json` at your s3 bucket.
⚠️ **Do not upload the `index.json`**. The server creates this file.
## Settup Client:
* enter `/devtools` in a chat in element.
* go to: Explore Account Data -> m.widgets
* change the json to:
```json
{
"stickerpicker": {
"content": {
"type": "m.stickerpicker",
"url": "https://YOUR.STICKER.PICKER.URL/PROFILE_NAME/index.html?theme=$theme",
"name": "Stickerpaket",
"data": {}
},
"sender": "@YOU:MATRIX.SERVER.NAME",
"state_key": "stickerpicker",
"type": "m.widget",
"id": "stickerpicker"
}
}
```
Do not forget to change `YOUR.STICKER.PICKER.URL/PROFILE_NAME`, `PROFILE_NAME` and `@YOU:MATRIX.SERVER.NAME`