42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
|
# 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 `--base-dir` option.
|
||
|
|
|
||
|
|
If you use a custom Firefish setup and let's say your config files are located at `/etc/firefish/config`, you should provide `--base-dir /etc/firefish` option or `cd` to `/etc/firefish` directory.
|
||
|
|
|
||
|
|
## Update the config files
|
||
|
|
|
||
|
|
[The admin note](https://firefish.dev/firefish/firefish/-/blob/main/docs/notice-for-admins.md) may tell you that you need to update the config files. In such a case, please execute the following command.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
fishctl config update
|
||
|
|
```
|
||
|
|
|
||
|
|
You can also specify the revision to update to, but this feature is for development purposes only.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
fishctl config update v1
|
||
|
|
```
|
||
|
|
|
||
|
|
## Check the config files
|
||
|
|
|
||
|
|
Execute the following command to check if the config files are valid:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
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:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
fishctl config check --offline
|
||
|
|
```
|
||
|
|
|
||
|
|
## Generate VAPID keys for push notifications
|
||
|
|
|
||
|
|
```sh
|
||
|
|
fishctl generate vapid
|
||
|
|
```
|