kawen/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity
akkoma/docs/administration/CLI_tasks/emoji.md
rinpatch bd9c7807fb Move emoji task docs to a separate file
2019-10-03 01:03:47 +03:00

1.6 KiB
Raw Blame History

Managing emoji packs

Every command should be ran with a prefix, in case of OTP releases it is ./bin/pleroma_ctl emoji and in case of source installs it's mix pleroma.emoji.

ls-packs

$PREFIX ls-packs [OPTION...]

Lists the emoji packs and metadata specified in the manifest.

Options

  • -m, --manifest PATH/URL - path to a custom manifest, it can either be an URL starting with http, in that case the manifest will be fetched from that address, or a local path

get-packs

$PREFIX get-packs [OPTION...] PACKS

Fetches, verifies and installs the specified PACKS from the manifest into the STATIC-DIR/emoji/PACK-NAME

Options

  • -m, --manifest PATH/URL - same as ls-packs

gen-pack

$PREFIX gen-pack PACK-URL

Creates a new manifest entry and a file list from the specified remote pack file. Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you.

The manifest entry will either be written to a newly created index.json file or appended to the existing one, replacing the old pack with the same name if it was in the file previously.

The file list will be written to the file specified previously, replacing that file. You should check that the file list doesn't contain anything you don't need in the pack, that is, anything that is not an emoji (the whole pack is downloaded, but only emoji files are extracted).