encrypt/gancio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documenting plugins dev

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/usage/cli.md
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

10
docs/usage/plugins.md
View File

@@ -10,13 +10,12 @@ has_toc: true
# Plugins
{: .no_toc }
This page is a guide to install plugins, if you want to develop one instead look [here](/dev/plugins)
This page is a guide to install plugins, if you want to develop one instead look [here](/dev/plugins).
__Please note that some plugins are officially supported and distributed along with the release__
1. TOC
{:toc}
## Install
To install a plugin you have to:
@@ -49,7 +48,7 @@ __with docker__
docker-compose restart
```
# List of plugins
# List of embedded plugins
## __Telegram__
@@ -57,6 +56,5 @@ This plugin republishes events to Telegram channels or groups.
The goal is to spread the info of our networks to the capitalist cyberspace, and pull otherwise isolated people to our radical and free part of the internet.
- **Website**: [https://framagit.org/bcn.convocala/gancio-plugin-telegram-bridge](https://framagit.org/bcn.convocala/gancio-plugin-telegram-bridge)
- **Download**: [gancio-plugin-telegram-bridge-v0.2.0.zip](https://framagit.org/les/gancio-plugin-telegram-bridge/-/archive/v0.2.0/gancio-plugin-telegram-bridge-v0.2.0.zip)
- **Release**: v0.2.0 / 10 Dec '22
- **Release**: https://framagit.org/bcn.convocala/gancio-plugin-telegram-bridge/-/commit/af0eed7b42242ba484d9828157f1be0355bba69b