documenting plugins dev

This commit is contained in:
lesion
2023-06-30 23:48:17 +02:00
parent 1bfe4b3995
commit 76e51f0f46
3 changed files with 107 additions and 24 deletions

View File

@@ -17,7 +17,7 @@ has_toc: true
Gancio is distributed with an embedded CLI.
To use the CLI you need to specify the `config.json` configuration file via `--config <your_config.json>` flag; by default the CLI will look for one in the current directory, so if your current directory is /opt/gancio (having followed the [installation instructions](/install/debian)) there is no need to specify it.
#### Using CLI with Docker installation
### Using CLI with Docker installation
To use the CLI in a docker installation you can execute a shell inside the container with:
`docker exec --workdir /home/node/data -it gancio sh` and following the normal CLI usage or running commands with:
@@ -26,7 +26,7 @@ To use the CLI in a docker installation you can execute a shell inside the conta
(the first "gancio" is the container name)
## Users
## Users <span class='label label-yellow'>since 1.6.14</span>
All users related sub-commands starts with `gancio users`.
Note that most of this actions could be done from administration panel (Admin > Users).
@@ -50,8 +50,6 @@ To create an user with administrator privileges use the `--admin` flag, e.g. `ga
### Reset password
`gancio users reset-password <username|email>`
> info "Changelog"
> from: 1.6.14
### Change administrator privileges
@@ -60,6 +58,3 @@ To add administrator privileges to an user:
To remove administrator privileges from an user:
`gancio users unset-admin <username|email>`
> info "Changelog"
> from: 1.6.14