emoji.md 2.04 KB
Newer Older
1
2
# Managing emoji packs

3
{! backend/administration/CLI_tasks/general_cli_task_info.include !}
4

5
## Lists emoji packs and metadata specified in the manifest
6

rinpatch's avatar
rinpatch committed
7
8
9
10
=== "OTP"
    ```sh
    ./bin/pleroma_ctl emoji ls-packs [option ...]
    ```
11

rinpatch's avatar
rinpatch committed
12
13
14
15
=== "From Source"
    ```sh
    mix pleroma.emoji ls-packs [option ...]
    ```
16
17


18
19
20
### 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

rinpatch's avatar
rinpatch committed
21
## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME`
22

rinpatch's avatar
rinpatch committed
23
24
25
26
=== "OTP"
    ```sh
    ./bin/pleroma_ctl emoji get-packs [option ...] <pack ...>
    ```
27

rinpatch's avatar
rinpatch committed
28
29
30
31
=== "From Source"
    ```sh
    mix pleroma.emoji get-packs [option ...] <pack ...>
    ```
32
33
34
35

### Options
- `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)

rinpatch's avatar
rinpatch committed
36
## Create a new manifest entry and a file list from the specified remote pack file
37

rinpatch's avatar
rinpatch committed
38
39
40
41
=== "OTP"
    ```sh
    ./bin/pleroma_ctl emoji gen-pack PACK-URL
    ```
42

rinpatch's avatar
rinpatch committed
43
44
45
46
=== "From Source"
    ```sh
    mix pleroma.emoji gen-pack PACK-URL
    ```
47

48
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.
49

50
  The manifest entry will either be written to a newly created `pack_name.json` file (pack name is asked in questions) or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.
51
52

  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).
53
54
55

## Reload emoji packs

rinpatch's avatar
rinpatch committed
56
57
58
59
=== "OTP"
    ```sh
    ./bin/pleroma_ctl emoji reload
    ```
60
61

This command only works with OTP releases.