usage.md

Usage

Please make sure to cd to the Firefish local repository (more precisely, the parent directory of the config directory) before running the command, or specify that directory using --config-dir option.

If you use a custom Firefish setup and let's say your config files are located at /etc/firefish, you should provide --config-dir /etc/firefish option or cd to /etc/firefish directory.

Update the config files

The admin note may tell you that you need to update the config files. In such a case, please execute the following command.

fishctl config update

Check the config files

Execute the following command to check if the config files are valid:

fishctl config check

Please note that some items are only formally checked. Even if the output says it is valid, your settings can be incorrect.

This command performs a connection check against the PostgreSQL server and the cache server (Valkey/Redis). You can bypass this check using the --offline option:

fishctl config check --offline

Migrate from "multiple config" setup to "single config" setup

The following command merges multiple (fallback/standard/override) config files into a single file, allowing you to migrate from "multiple config" setup to "single config" setup.

fishctl config merge

Generate VAPID keys for push notifications

fishctl generate vapid