maunium-stickerpicker-nix/README.md
teutat3s f19ee88860
refactor: only download stickers with nix,
manually invoke sticker-pack from the devshell to upload stickers to
matrix, to avoid leaking the access token from config.json to the nix
store.

Nixify SigStickers https://github.com/FHPythonUtils/SigStickers and
dependency https://github.com/signalstickers/signalstickers-client to
download Signal stickers
2024-04-29 00:12:49 +02:00

1.9 KiB

built with nix

maunium-stickerpicker-nix

Nix wrapper for maunium/stickerpicker

Usage:

Here's an example of a stickerpicker

myStickerPicker = createStickerPicker {
  homeserver = "https://my.matrix.server";
  userId = "@stickerbot:my.matrix.server";
  sha256 = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
  packs = [
    {
      type = "chatsticker";
      name = "pompom-tao3";
    }
    {
      type = "directory";
      src = ./myHomemadeStickers;
    }
  ];
};

Afterwards, you can easily host it in an nginx config

{ ... }:
{
services.nginx.enable = true;
services.nginx.virtualHosts."stickers.myhost.org" = {
    root = myStickerPicker;
  };
}

List of available fetchers

Site Type Name Required Arguments
<local dir> directory src (path to a local dir with image files)
https://chatsticker.com chatsticker name (see url)

Some notes

To use this, leave the sha256 empty at first, build the stickerspicker with whatever stickers you'd like, and paste the sha256 from the error message back into your code.

Normally, maunium/stickerpicker would cache the stickers in a config file, and reuse the config file on the next run in order not to. This does not work with Nix' determinism. Thus every time you want to add just 1 more stickerpack (or any other kind of edit), this will reupload all stickers. In order to make it easier to delete all sticker once in a while, I would recommend creating a separate user (I've called mine stickerbot), whose only purpose is to be the owner of a bunch of sticker media files. Whenever you want to clean up the media store, just delete all the media file of stickerbot (THIS WILL BREAK OLDER MESSAGES)