Elgato_dark/bunkerweb
1
0
Fork 0
mirror of https://github.com/bunkerity/bunkerweb synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add information about templates to plugin page

Browse source
This commit is contained in:
Théophile Diot 2024-08-12 13:59:13 +01:00
parent a47ce19482
commit bb0cfb74c6
No known key found for this signature in database
GPG key ID: FA995104A0BA376A
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/plugins.md
View file

@ -87,7 +87,6 @@ The first step is to install the plugin by putting the plugin files inside the c
Then you can mount the volume when starting your Docker stack :
```yaml
version: '3.5'
services:
...
bw-scheduler:
@ -124,7 +123,6 @@ The first step is to install the plugin by putting the plugin files inside the c
Then you can mount the volume when starting your Docker stack :
```yaml
version: '3.5'
services:
...
bw-scheduler:
@ -163,7 +161,6 @@ The first step is to install the plugin by putting the plugin files inside the c
Then you can mount the volume when starting your Swarm stack :
```yaml
version: '3.5'
services:
...
bw-scheduler:
@ -263,6 +260,8 @@ plugin /
ui / actions.py
template.html
jobs / my-job.py
templates / my-template.json
my-template / configs / conf_type / conf_name.conf
plugin.lua
plugin.json
```
@ -275,6 +274,8 @@ plugin /
- **jobs py file** : custom python files executed as jobs by the scheduler
- **my-template.json** : add [custom templates](concepts.md#templates) for the plugin to override settings' default values and apply custom configurations in an easy way
- **plugin.lua** : code to execute on NGINX using [NGINX LUA module](https://github.com/openresty/lua-nginx-module)
- **plugin.json** : metadata, settings and jobs for your settings
@ -371,6 +372,10 @@ location /setting {
`{{ DUMMY_SETTING }}` will be replaced by the value of the `DUMMY_SETTING` chosen by the user of the plugin.
### Templates
Check the [templates documentation](concepts.md#templates) for more information.
### LUA
#### Main script

4
docs/quickstart-guide.md
View file

@ -1545,7 +1545,6 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
You can now create your PHP-FPM containers, mount the correct subfolders and use labels to configure BunkerWeb :
```yaml
version: '3.5'
services:
myapp1:
image: php:fpm
@ -1633,8 +1632,6 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
When you start the BunkerWeb stack, mount the `/shared/www` folder into `/var/www/html` for the BunkerWeb container :
```yaml
version: "3.5"
services:
bunkerweb:
image: bunkerity/bunkerweb:1.6.0-beta
@ -1646,7 +1643,6 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
You can now create your PHP-FPM services, mount the correct subfolders and use labels to configure BunkerWeb :
```yaml
version: '3.5'
services:
myapp1:
image: php:fpm