naskya/fishctl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
naskya 2024-07-01 14:09:19 +09:00
parent 9a891a5126
commit f2693af52d
Signed by: naskya
GPG key ID: 712D413B3A9FED5C
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -40,6 +40,9 @@ cargo install --locked --git https://firefish.dev/firefish/fishctl.git
Using the `registry.firefish.dev/firefish/fishctl` container image, `fishctl ___` commands can be executed as Using the `registry.firefish.dev/firefish/fishctl` container image, `fishctl ___` commands can be executed as
```sh ```sh
# Assuming that $(pwd) (current directory) is the parent of the config directory
# (i.e., the Firefish local repository directory)
docker run -it --rm --volume "$(pwd)":/firefish --network network_name \ docker run -it --rm --volume "$(pwd)":/firefish --network network_name \
registry.firefish.dev/firefish/fishctl \ registry.firefish.dev/firefish/fishctl \
fishctl ___ fishctl ___
@ -53,7 +56,7 @@ podman run -it --rm --volume "$(pwd)":/firefish --network network_name \
Where `network_name` is the network name on which the database is running. If you want to use this for the host network (i.e., use the container as if it were a locally installed command), you should replace `network_name` with `host`. Where `network_name` is the network name on which the database is running. If you want to use this for the host network (i.e., use the container as if it were a locally installed command), you should replace `network_name` with `host`.
If you are using a container network (which is typically the case if you are using `docker-compose.yml` to run Firefish), you need to search for your network name by `docker network ls` or `podman network ls`: If you are using a container network (which is typically the case if you are using `compose.yml` or `docker-compose.yml` to run Firefish), you need to search for your network name by `docker network ls` or `podman network ls`:
``` ```
$ podman network ls # the network name is `firefish_calcnet` in this case $ podman network ls # the network name is `firefish_calcnet` in this case
@ -64,7 +67,9 @@ NETWORK ID NAME DRIVER
## Usage ## Usage
Please make sure to `cd` to the Firefish local repository before running these commands. Please make sure to `cd` to the Firefish local repository (more precisely, the parent directory of the config directory) before running these commands, 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 ### Update the config files
@ -88,9 +93,9 @@ Execute the following command to validate the config files.
fishctl config validate fishctl config validate
``` ```
Note that some items are only formally checked, so even if the output says it is valid, your settings may not be appropriate. 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 Redis/Valkey server. You can bypass this check using the `--offline` option: 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 ```sh
fishctl config validate --offline fishctl config validate --offline