mirror of
https://framagit.org/les/gancio.git
synced 2025-01-31 16:42:22 +01:00
new plugins installation docs
This commit is contained in:
parent
bedf147e93
commit
ecb44881d2
3 changed files with 72 additions and 6 deletions
|
@ -11,5 +11,5 @@ nav_order: 9
|
||||||
- :elephant: Mastodon ⇒ [@gancio@mastodon.cisti.org](https://mastodon.cisti.org/@gancio)
|
- :elephant: Mastodon ⇒ [@gancio@mastodon.cisti.org](https://mastodon.cisti.org/@gancio)
|
||||||
- :email: Email ⇒ [info@cisti.org](mailto:info@cisti.org)
|
- :email: Email ⇒ [info@cisti.org](mailto:info@cisti.org)
|
||||||
- IRC ⇒ #gancio @ irc.autistici.org (sometimes...)
|
- IRC ⇒ #gancio @ irc.autistici.org (sometimes...)
|
||||||
- Issues ⇒ https://framagit.org/les/gancio/-/issues
|
- Issues ⇒ [https://framagit.org/les/gancio/-/issues](https://framagit.org/les/gancio/-/issues)
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ The configuration file shoud be a `.json` or a `.js` file and could be specified
|
||||||
1. TOC
|
1. TOC
|
||||||
{:toc}
|
{:toc}
|
||||||
|
|
||||||
- ### Server
|
### Server
|
||||||
This probably support unix socket too
|
This probably support unix socket too
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -26,7 +26,7 @@ This probably support unix socket too
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- ### Database
|
### Database
|
||||||
DB configuration, look [here](https://sequelize.org/v6/class/src/sequelize.js~Sequelize.html#instance-constructor-constructor) for options.
|
DB configuration, look [here](https://sequelize.org/v6/class/src/sequelize.js~Sequelize.html#instance-constructor-constructor) for options.
|
||||||
```json
|
```json
|
||||||
"db": {
|
"db": {
|
||||||
|
@ -34,11 +34,15 @@ DB configuration, look [here](https://sequelize.org/v6/class/src/sequelize.js~Se
|
||||||
"storage": "/tmp/db.sqlite"
|
"storage": "/tmp/db.sqlite"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
- ### Upload path
|
### Upload path
|
||||||
Where to save images
|
Where to save images
|
||||||
`"upload_path": "./uploads"`
|
`"upload_path": "./uploads"`
|
||||||
|
|
||||||
- ### User locale
|
### Plugins path
|
||||||
|
Where to search for [plugins](/usage/plugins)
|
||||||
|
`"plugins_path": "./plugins"`
|
||||||
|
|
||||||
|
### User locale
|
||||||
Probably you want to modify some text for your specific community, that's
|
Probably you want to modify some text for your specific community, that's
|
||||||
why we thought the `user_locale` configuration: you can specify your version of
|
why we thought the `user_locale` configuration: you can specify your version of
|
||||||
each string of **gancio** making a directory with your locales inside.
|
each string of **gancio** making a directory with your locales inside.
|
||||||
|
|
62
docs/usage/plugins.md
Normal file
62
docs/usage/plugins.md
Normal file
|
@ -0,0 +1,62 @@
|
||||||
|
---
|
||||||
|
layout: default
|
||||||
|
title: Plugins
|
||||||
|
permalink: /usage/plugins
|
||||||
|
nav_order: 2
|
||||||
|
parent: Usage
|
||||||
|
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)
|
||||||
|
|
||||||
|
1. TOC
|
||||||
|
{:toc}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
To install a plugin you have to:
|
||||||
|
|
||||||
|
1. **download the .zip archive (look for the url on the plugin list below)**
|
||||||
|
```
|
||||||
|
wget https://framagit.org/les/gancio-plugin-telegram-bridge/-/archive/v0.2.0/gancio-plugin-telegram-bridge-v0.2.0.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **unpack it in the `./plugins` directory.**
|
||||||
|
```
|
||||||
|
cd plugins
|
||||||
|
unzip https://framagit.org/les/gancio-plugin-telegram-bridge/-/archive/v0.2.0/gancio-plugin-telegram-bridge-v0.2.0.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
3. **install the dependencies with `yarn`**
|
||||||
|
```
|
||||||
|
cd plugins/gancio-plugin-telegram-bridge
|
||||||
|
yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **restart gancio**
|
||||||
|
__with debian__
|
||||||
|
```
|
||||||
|
sudo sytemctl restart gancio
|
||||||
|
```
|
||||||
|
__with docker__
|
||||||
|
```
|
||||||
|
docker-compose restart
|
||||||
|
```
|
||||||
|
|
||||||
|
# List of plugins
|
||||||
|
|
||||||
|
## __Telegram__
|
||||||
|
|
||||||
|
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
|
||||||
|
|
Loading…
Reference in a new issue