mirror of
https://github.com/YunoHost-Apps/microbin_ynh.git
synced 2024-09-03 19:45:57 +02:00
first commit
This commit is contained in:
Éric Gaspar
commit
acda560cc0
24 changed files with 1315 additions and 0 deletions
4
LICENSE
Normal file
4
LICENSE
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
File containing the license of your package.
|
||||||
|
|
||||||
|
More information here:
|
||||||
|
https://choosealicense.com/
|
||||||
85
README.md
Normal file
85
README.md
Normal file
|
|
@ -0,0 +1,85 @@
|
||||||
|
# Packaging an app, starting from this example
|
||||||
|
|
||||||
|
* Copy this app before working on it, using the ['Use this template'](https://github.com/new?template_name=example_ynh&template_owner=YunoHost) button on the Github repo.
|
||||||
|
* Edit the `manifest.toml` with app specific info.
|
||||||
|
* Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, and any relevant conf files in `conf/`.
|
||||||
|
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
||||||
|
* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
|
||||||
|
* Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
|
||||||
|
* Edit files under the `doc/` directory
|
||||||
|
* The `README.md` files are to be automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
|
|
||||||
|
---
|
||||||
|
<!--
|
||||||
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
|
||||||
|
It shall NOT be edited by hand.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Example app for YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/example)  
|
||||||
|
[](https://install-app.yunohost.org/?app=example)
|
||||||
|
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *This package allows you to install Example app quickly and simply on a YunoHost server.
|
||||||
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||||
|
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||||
|
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||||
|
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||||
|
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||||
|
|
||||||
|
|
||||||
|
**Shipped version:** 1.0~ynh1
|
||||||
|
|
||||||
|
**Demo:** https://demo.example.com
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Disclaimers / important information
|
||||||
|
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
* requiring a full dedicated domain ?
|
||||||
|
* architectures not supported ?
|
||||||
|
* not-working single-sign on or LDAP integration ?
|
||||||
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||||
|
* etc...
|
||||||
|
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
|
|
||||||
|
## Documentation and resources
|
||||||
|
|
||||||
|
* Official app website: <https://example.com>
|
||||||
|
* Official user documentation: <https://yunohost.org/apps>
|
||||||
|
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
||||||
|
* Upstream app code repository: <https://some.forge.com/example/example>
|
||||||
|
* YunoHost documentation for this app: <https://yunohost.org/app_example>
|
||||||
|
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||||
|
|
||||||
|
## Developer info
|
||||||
|
|
||||||
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||||
|
|
||||||
|
To try the testing branch, please proceed like that.
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||||
|
or
|
||||||
|
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
73
README_fr.md
Normal file
73
README_fr.md
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
<!--
|
||||||
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||||
|
It shall NOT be edited by hand.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Exemple d'app pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/example)  
|
||||||
|
[](https://install-app.yunohost.org/?app=example)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost.
|
||||||
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
|
## Vue d'ensemble
|
||||||
|
|
||||||
|
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||||
|
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||||
|
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||||
|
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||||
|
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||||
|
|
||||||
|
|
||||||
|
**Version incluse :** 1.0~ynh1
|
||||||
|
|
||||||
|
**Démo :** https://demo.example.com
|
||||||
|
|
||||||
|
## Captures d'écran
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
* requiring a full dedicated domain ?
|
||||||
|
* architectures not supported ?
|
||||||
|
* not-working single-sign on or LDAP integration ?
|
||||||
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||||
|
* etc...
|
||||||
|
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Site officiel de l'app : <https://example.com>
|
||||||
|
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
||||||
|
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
|
||||||
|
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
|
||||||
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
|
||||||
|
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||||
237
conf/.env
Normal file
237
conf/.env
Normal file
|
|
@ -0,0 +1,237 @@
|
||||||
|
# Require username for HTTP Basic Authentication when
|
||||||
|
# visiting the service. If basic auth username is set but
|
||||||
|
# basic auth password is not, just leave the password field
|
||||||
|
# empty when logging in. You can also just go to
|
||||||
|
# https://username:password@yourserver.net or
|
||||||
|
# https://username@yourserver.net if password is not set
|
||||||
|
# instead of typing into the password
|
||||||
|
# Default value: unset
|
||||||
|
# export MICROBIN_BASIC_AUTH_USERNAME=
|
||||||
|
|
||||||
|
# Require password for HTTP Basic Authentication when
|
||||||
|
# visiting the service. Will not have any affect unless
|
||||||
|
# basic auth username is also set. If basic auth username is
|
||||||
|
# set but basic auth password is not, just leave the
|
||||||
|
# password field empty when logging in. You can also just go
|
||||||
|
# to https://username:password@yourserver.net or
|
||||||
|
# https://username@yourserver.net if password is not set
|
||||||
|
# instead of typing into the password prompt.
|
||||||
|
# Default value: unset
|
||||||
|
# export MICROBIN_BASIC_AUTH_PASSWORD=
|
||||||
|
|
||||||
|
# Enables administrator interface at yourserver.com/admin/
|
||||||
|
# if set, disables it if unset. If admin username is set but
|
||||||
|
# admin password is not, just leave the password field empty
|
||||||
|
# when logging in.
|
||||||
|
# Default value: admin
|
||||||
|
export MICROBIN_ADMIN_USERNAME=__ADMIN__
|
||||||
|
|
||||||
|
# Enables administrator interface at yourserver.com/admin/
|
||||||
|
# if set, disables it if unset. Will not have any affect
|
||||||
|
# unless admin username is also set. If admin username is
|
||||||
|
# set but admin password is not, just leave the password
|
||||||
|
# field empty when logging in.
|
||||||
|
# Default value: m1cr0b1n
|
||||||
|
export MICROBIN_ADMIN_PASSWORD=__PASSWORD__
|
||||||
|
|
||||||
|
# Enables editable pastas. You will still be able to make
|
||||||
|
# finalised pastas but there will be an extra checkbox to
|
||||||
|
# make your new pasta editable from the pasta list or the
|
||||||
|
# pasta view page.
|
||||||
|
# Default value: 8080
|
||||||
|
export MICROBIN_EDITABLE=true
|
||||||
|
|
||||||
|
# Replaces the default footer text with your own. If you
|
||||||
|
# want to hide the footer, use the hide footer option instead.
|
||||||
|
# Note that you can also embed HTML here, so you may want to escape
|
||||||
|
# '<', '>' and so on.
|
||||||
|
# export MICROBIN_FOOTER_TEXT=
|
||||||
|
|
||||||
|
# Hides the navigation bar on every page.
|
||||||
|
# Default value: 8080
|
||||||
|
export MICROBIN_HIDE_HEADER=false
|
||||||
|
|
||||||
|
# Hides the footer on every page.
|
||||||
|
# Default value: 8080
|
||||||
|
export MICROBIN_HIDE_FOOTER=false
|
||||||
|
|
||||||
|
# Hides the MicroBin logo from the navigation bar on every
|
||||||
|
# page.
|
||||||
|
# Default value: 8080
|
||||||
|
export MICROBIN_HIDE_LOGO=false
|
||||||
|
|
||||||
|
# Disables the /pastalist endpoint, essentially making all
|
||||||
|
# pastas private.
|
||||||
|
# Default value: 8080
|
||||||
|
export MICROBIN_NO_LISTING=false
|
||||||
|
|
||||||
|
# Enables syntax highlighting support. When creating a new
|
||||||
|
# pasta, a new dropdown selector will be added where you can
|
||||||
|
# select your pasta's syntax, or just leave it empty for no
|
||||||
|
# highlighting.
|
||||||
|
export MICROBIN_HIGHLIGHTSYNTAX=true
|
||||||
|
|
||||||
|
# Sets the port for the server will be listening on.
|
||||||
|
# Default value: 8080
|
||||||
|
export MICROBIN_PORT=__PORT__
|
||||||
|
|
||||||
|
# Sets the bind address for the server will be listening on.
|
||||||
|
# Both ipv4 and ipv6 are supported. Default value: "0.0.0.0".
|
||||||
|
# Example value: "myserver.net", "127.0.0.1".
|
||||||
|
export MICROBIN_BIND="127.0.0.1"
|
||||||
|
|
||||||
|
# Enables private pastas. Adds a new checkbox to make your
|
||||||
|
# pasta private, which then won't show up on the pastalist
|
||||||
|
# page. With the URL to your pasta, it will still be
|
||||||
|
# accessible.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_PRIVATE=true
|
||||||
|
|
||||||
|
# DEPRECATED: Will be removed soon. If you want to change styling (incl. removal), use custom CSS variable instead.
|
||||||
|
# Disables main CSS styling, just uses a few in-line
|
||||||
|
# stylings for the layout. With this option you will lose
|
||||||
|
# dark-mode support.
|
||||||
|
export MICROBIN_PURE_HTML=false
|
||||||
|
|
||||||
|
# Sets the name of the directory where MicroBin creates
|
||||||
|
# its database and stores attachments.
|
||||||
|
# Default value: microbin_data
|
||||||
|
export MICROBIN_DATA_DIR=__DATA_DIR__
|
||||||
|
|
||||||
|
# Enables storing pasta data (not attachments and files) in
|
||||||
|
# a JSON file instead of the SQLite database.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_JSON_DB=false
|
||||||
|
|
||||||
|
# Add the given public path prefix to all urls. This allows
|
||||||
|
# you to host MicroBin behind a reverse proxy on a subpath.
|
||||||
|
# Note that MicroBin itself still expects all routes to be
|
||||||
|
# as without this option, and thus is unsuited if you are
|
||||||
|
# running MicroBin directly. Default value: unset. Example
|
||||||
|
# values: https://myserver.com/ or https://192.168.0.10:8080/
|
||||||
|
export MICROBIN_PUBLIC_PATH=https://__DOMAIN____PATH__
|
||||||
|
|
||||||
|
# Sets a shortened path to use when the user copies URL from
|
||||||
|
# the application. This will also use shorter endpoints,
|
||||||
|
# such as /p/ instead if /pasta/. Default value:
|
||||||
|
# unset.Example value: https://b.in/ export
|
||||||
|
# MICROBIN_SHORT_PATH=
|
||||||
|
|
||||||
|
# The password required for uploading, if read-only mode is enabled
|
||||||
|
# Default value: unset
|
||||||
|
# export MICROBIN_UPLOADER_PASSWORD=
|
||||||
|
|
||||||
|
# If set to true, authentication required for uploading
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_READONLY=false
|
||||||
|
|
||||||
|
# Enables showing read count on pasta pages.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_SHOW_READ_STATS=true
|
||||||
|
|
||||||
|
# Adds your title of choice to the
|
||||||
|
# navigation bar.
|
||||||
|
# Default value: unset
|
||||||
|
# export MICROBIN_TITLE=
|
||||||
|
|
||||||
|
# Number of workers MicroBin is allowed to have. Increase
|
||||||
|
# this to the number of CPU cores you have if you want to go
|
||||||
|
# beast mode, but for personal use one worker is enough.
|
||||||
|
# Default value: 1.
|
||||||
|
export MICROBIN_THREADS=1
|
||||||
|
|
||||||
|
# Sets the garbage collector time limit. Pastas not accessed
|
||||||
|
# for N days are removed even if they are set to never
|
||||||
|
# expire.
|
||||||
|
# Default value: 90.
|
||||||
|
# To turn off GC: 0.
|
||||||
|
export MICROBIN_GC_DAYS=90
|
||||||
|
|
||||||
|
# Enables or disables the "Burn after" function
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_ENABLE_BURN_AFTER=true
|
||||||
|
|
||||||
|
# Sets the default burn after setting on the main screen.
|
||||||
|
# Default value: 0. Available expiration options: 1, 10,
|
||||||
|
# 100, 1000, 10000, 0 (= no limit)
|
||||||
|
export MICROBIN_DEFAULT_BURN_AFTER=0
|
||||||
|
|
||||||
|
# Changes the maximum width of the UI from 720 pixels to
|
||||||
|
# 1080 pixels.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_WIDE=false
|
||||||
|
|
||||||
|
# Enables generating QR codes for pastas. Requires
|
||||||
|
# the public path to also be set.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_QR=true
|
||||||
|
|
||||||
|
# Toggles "Never" expiry settings for pastas. Default
|
||||||
|
# value: false
|
||||||
|
export MICROBIN_ETERNAL_PASTA=false
|
||||||
|
|
||||||
|
# Enables "Read-only" uploads. These are unlisted and
|
||||||
|
# unencrypted, but can be viewed without password if you
|
||||||
|
# have the URL. Editing and removing requires password.
|
||||||
|
# Default value: true
|
||||||
|
export MICROBIN_ENABLE_READONLY=true
|
||||||
|
|
||||||
|
# Sets the default expiry time setting on the main screen.
|
||||||
|
# Default value: 24hour Available expiration options: 1min,
|
||||||
|
# 10min, 1hour, 24hour, 1week, never
|
||||||
|
export MICROBIN_DEFAULT_EXPIRY=24hour
|
||||||
|
|
||||||
|
# Disables and hides the file upload option in the UI.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_NO_FILE_UPLOAD=false
|
||||||
|
|
||||||
|
# Replaced the built-in water.css stylesheet with the URL
|
||||||
|
# you provide. Default value: unset. Example value:
|
||||||
|
# https://myserver.net/public/mystyle.css
|
||||||
|
# export MICROBIN_CUSTOM_CSS=
|
||||||
|
|
||||||
|
# Use short hash strings in the URLs instead of animal names
|
||||||
|
# to make URLs shorter. Does not change the underlying data
|
||||||
|
# stored, just how pastas are recalled.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_HASH_IDS=false
|
||||||
|
|
||||||
|
# Enables server-side encryption. This will add private
|
||||||
|
# privacy level, where the user sends plain unencrypted data
|
||||||
|
# (still secure, because you use HTTPS, right?), but the
|
||||||
|
# server sees everything that the user submits, therefore
|
||||||
|
# the user does not have complete and absolute protection.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_ENCRYPTION_CLIENT_SIDE=true
|
||||||
|
|
||||||
|
# Enables client-side encryption. This will add the secret
|
||||||
|
# privacy level where the user's browser encrypts all data
|
||||||
|
# with JavaScript before sending it over to MicroBin, which
|
||||||
|
# encrypt the data once again on server side.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_ENCRYPTION_SERVER_SIDE=true
|
||||||
|
|
||||||
|
# Limit the maximum file size users can upload without
|
||||||
|
# encryption. Default value: 256.
|
||||||
|
export MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB=256
|
||||||
|
|
||||||
|
# Limit the maximum file size users can upload with
|
||||||
|
# encryption (more strain on your server than without
|
||||||
|
# encryption, so the limit should be lower. Secrets tend to
|
||||||
|
# be tiny files usually anyways.) Default value: 2048.
|
||||||
|
export MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB=2048
|
||||||
|
|
||||||
|
# Disables the feature that checks for available updates
|
||||||
|
# when opening the admin screen.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_DISABLE_UPDATE_CHECKING=false
|
||||||
|
|
||||||
|
# Disables telemetry if set to true.
|
||||||
|
# Telemetry includes your configuration and helps development.
|
||||||
|
# It does not include any sensitive data.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_DISABLE_TELEMETRY=false
|
||||||
|
|
||||||
|
# Enables listing your server in the public MicroBin server list.
|
||||||
|
# Default value: false
|
||||||
|
export MICROBIN_LIST_SERVER=false
|
||||||
15
conf/nginx.conf
Normal file
15
conf/nginx.conf
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
|
||||||
|
location __PATH__/ {
|
||||||
|
|
||||||
|
proxy_pass http://127.0.0.1:__PORT__;
|
||||||
|
proxy_redirect off;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
client_max_body_size 1024M;
|
||||||
|
|
||||||
|
# Include SSOWAT user panel.
|
||||||
|
include conf.d/yunohost_panel.conf.inc;
|
||||||
|
}
|
||||||
79
conf/systemd.service
Normal file
79
conf/systemd.service
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
[Unit]
|
||||||
|
Description=Microbin
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=__APP__
|
||||||
|
Group=__APP__
|
||||||
|
Environment="MICROBIN_ADMIN_USERNAME=__ADMIN__"
|
||||||
|
Environment="MICROBIN_ADMIN_PASSWORD=__PASSWORD__"
|
||||||
|
Environment="MICROBIN_PORT=__PORT__"
|
||||||
|
Environment="MICROBIN_BIND=127.0.0.1"
|
||||||
|
# Environment="MICROBIN_PUBLIC_PATH=https://__DOMAIN__"
|
||||||
|
# Environment="MICROBIN_SHORT_PATH=https://short.net"
|
||||||
|
Environment="MICROBIN_DATA_DIR=__DATA_DIR__
|
||||||
|
Environment="MICROBIN_JSON_DB=false"
|
||||||
|
Environment="MICROBIN_EDITABLE=true"
|
||||||
|
Environment="MICROBIN_HIDE_HEADER=false"
|
||||||
|
Environment="MICROBIN_HIDE_FOOTER=false"
|
||||||
|
Environment="MICROBIN_HIDE_LOGO=false"
|
||||||
|
Environment="MICROBIN_NO_LISTING=false"
|
||||||
|
Environment="MICROBIN_READONLY=false"
|
||||||
|
Environment="MICROBIN_SHOW_READ_STATS=true"
|
||||||
|
Environment="MICROBIN_THREADS=1"
|
||||||
|
Environment="MICROBIN_GC_DAYS=90"
|
||||||
|
Environment="MICROBIN_WIDE=false"
|
||||||
|
Environment="MICROBIN_ETERNAL_PASTA=false"
|
||||||
|
Environment="MICROBIN_PRIVATE=true"
|
||||||
|
Environment="MICROBIN_HIGHLIGHTSYNTAX=true"
|
||||||
|
Environment="MICROBIN_QR=true"
|
||||||
|
Environment="MICROBIN_ENABLE_BURN_AFTER=true"
|
||||||
|
Environment="MICROBIN_ENABLE_READONLY=true"
|
||||||
|
Environment="MICROBIN_DEFAULT_EXPIRY=24hour"
|
||||||
|
Environment="MICROBIN_NO_FILE_UPLOAD=false"
|
||||||
|
Environment="MICROBIN_HASH_IDS=false"
|
||||||
|
Environment="MICROBIN_ENCRYPTION_CLIENT_SIDE=true"
|
||||||
|
Environment="MICROBIN_ENCRYPTION_SERVER_SIDE=true"
|
||||||
|
Environment="MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB=256"
|
||||||
|
Environment="MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB=2048"
|
||||||
|
Environment="MICROBIN_DISABLE_TELEMETRY=true"
|
||||||
|
WorkingDirectory=__INSTALL_DIR__/
|
||||||
|
ExecStart=__INSTALL_DIR__/microbin --editable --highlightsyntax
|
||||||
|
|
||||||
|
### Depending on specificities of your service/app, you may need to tweak these
|
||||||
|
### .. but this should be a good baseline
|
||||||
|
# Sandboxing options to harden security
|
||||||
|
# Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html
|
||||||
|
NoNewPrivileges=yes
|
||||||
|
PrivateTmp=yes
|
||||||
|
PrivateDevices=yes
|
||||||
|
RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK
|
||||||
|
RestrictNamespaces=yes
|
||||||
|
RestrictRealtime=yes
|
||||||
|
DevicePolicy=closed
|
||||||
|
ProtectClock=yes
|
||||||
|
ProtectHostname=yes
|
||||||
|
ProtectProc=invisible
|
||||||
|
ProtectSystem=full
|
||||||
|
ProtectControlGroups=yes
|
||||||
|
ProtectKernelModules=yes
|
||||||
|
ProtectKernelTunables=yes
|
||||||
|
LockPersonality=yes
|
||||||
|
SystemCallArchitectures=native
|
||||||
|
SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged
|
||||||
|
|
||||||
|
# Denying access to capabilities that should not be relevant for webapps
|
||||||
|
# Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html
|
||||||
|
CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD
|
||||||
|
CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE
|
||||||
|
CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT
|
||||||
|
CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK
|
||||||
|
CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
|
||||||
|
CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
|
||||||
|
CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
|
||||||
|
CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
|
||||||
|
CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
302
config_panel.toml.example
Normal file
302
config_panel.toml.example
Normal file
|
|
@ -0,0 +1,302 @@
|
||||||
|
|
||||||
|
## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button
|
||||||
|
## Those panels let user configure some params on their apps using a friendly interface,
|
||||||
|
## and remove the need to manually edit files from the command line.
|
||||||
|
|
||||||
|
## From a packager perspective, this .toml is coupled to the scripts/config script,
|
||||||
|
## which may be used to define custom getters/setters. However, most use cases
|
||||||
|
## should be covered automagically by the core, thus it may not be necessary
|
||||||
|
## to define a scripts/config at all!
|
||||||
|
|
||||||
|
## -----------------------------------------------------------------------------
|
||||||
|
## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and
|
||||||
|
## do not overwhelm the admin with tons of misunderstandable or advanced settings.
|
||||||
|
## -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
## The top level describe the entire config panels screen.
|
||||||
|
|
||||||
|
## The version is a required property.
|
||||||
|
## Here a small reminder to associate config panel version with YunoHost version
|
||||||
|
## | Config | YNH | Config panel small change log |
|
||||||
|
## | ------ | --- | ------------------------------------------------------- |
|
||||||
|
## | 0.1 | 3.x | 0.1 config script not compatible with YNH >= 4.3 |
|
||||||
|
## | 1.0 | 4.3.x | The new config panel system with 'bind' property |
|
||||||
|
version = "1.0"
|
||||||
|
|
||||||
|
## (optional) i18n property let you internationalize questions, however this feature
|
||||||
|
## is only available in core configuration panel (like yunohost domain config).
|
||||||
|
## So in app config panel this key is ignored for now, but you can internationalize
|
||||||
|
## by using a lang dictionary (see property name bellow)
|
||||||
|
# i18n = "prefix_translation_key"
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
#### ABOUT PANELS
|
||||||
|
################################################################################
|
||||||
|
|
||||||
|
## The next level describes web admin panels
|
||||||
|
## You have to choose an ID for each panel, in this example the ID is "main"
|
||||||
|
## Keep in mind this ID will be used in CLI to refer to your question, so choose
|
||||||
|
## something short and meaningfull.
|
||||||
|
## In the webadmin, each panel corresponds to a distinct tab / form
|
||||||
|
[main]
|
||||||
|
|
||||||
|
## Define the label for your panel
|
||||||
|
## Internationalization works similarly to the 'description' and 'ask' questions in the manifest
|
||||||
|
# name.en = "Main configuration"
|
||||||
|
# name.fr = "Configuration principale"
|
||||||
|
|
||||||
|
## (optional) If you need to trigger a service reload-or-restart after the user
|
||||||
|
## change a question in this panel, you can add your service in the list.
|
||||||
|
services = ["__APP__"]
|
||||||
|
# or services = ["nginx", "__APP__"] to also reload-or-restart nginx
|
||||||
|
|
||||||
|
## (optional) This help properties is a short help displayed on the same line
|
||||||
|
## than the panel title but not displayed in the tab.
|
||||||
|
# help = ""
|
||||||
|
|
||||||
|
############################################################################
|
||||||
|
#### ABOUT SECTIONS
|
||||||
|
############################################################################
|
||||||
|
|
||||||
|
## A panel is composed of one or several sections.
|
||||||
|
##
|
||||||
|
## Sections are meant to group questions together when they correspond to
|
||||||
|
## a same subtopic. This impacts the rendering in terms of CLI prompts
|
||||||
|
## and HTML forms
|
||||||
|
##
|
||||||
|
## You should choose an ID for your section, and prefix it with the panel ID
|
||||||
|
## (Be sure to not make a typo in the panel ID, which would implicitly create
|
||||||
|
## an other entire panel)
|
||||||
|
##
|
||||||
|
## We use the context of pepettes_ynh as an example,
|
||||||
|
## which is a simple donation form app written in python,
|
||||||
|
## and for which the admin will want to edit the configuration
|
||||||
|
[main.customization]
|
||||||
|
|
||||||
|
## (optional) Defining a proper title for sections is not mandatory
|
||||||
|
## and depends on the exact rendering you're aiming for the CLI / webadmin
|
||||||
|
name = ""
|
||||||
|
|
||||||
|
## (optional) This help properties is a short help displayed on the same line
|
||||||
|
## than the section title, meant to provide additional details
|
||||||
|
# help = ""
|
||||||
|
|
||||||
|
## (optional) As for panel, you can specify to trigger a service
|
||||||
|
## reload-or-restart after the user change a question in this section.
|
||||||
|
## This property is added to the panel property, it doesn't deactivate it.
|
||||||
|
## So no need to replicate, the service list from panel services property.
|
||||||
|
# services = []
|
||||||
|
|
||||||
|
## (optional) By default all questions are optionals, but you can specify a
|
||||||
|
## default behaviour for question in the section
|
||||||
|
optional = false
|
||||||
|
|
||||||
|
## (optional) It's also possible with the 'visible' property to only
|
||||||
|
## display the section depending on the user's answers to previous questions.
|
||||||
|
##
|
||||||
|
## Be careful that the 'visible' property should only refer to **previous** questions
|
||||||
|
## Hence, it should not make sense to have a "visible" property on the very first section.
|
||||||
|
##
|
||||||
|
## Also, keep in mind that this feature only works in the webadmin and not in CLI
|
||||||
|
## (therefore a user could be prompted in CLI for a question that may not be relevant)
|
||||||
|
# visible = true
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
#### ABOUT QUESTIONS
|
||||||
|
########################################################################
|
||||||
|
|
||||||
|
## A section is compound of one or several questions.
|
||||||
|
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
## IMPORTANT: as for panel and section you have to choose an ID, but this
|
||||||
|
## one should be unique in all this document, even if the question is in
|
||||||
|
## an other panel.
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
|
||||||
|
## You can use same questions types and properties than in manifest.yml
|
||||||
|
## install part. However, in YNH 4.3, a lot of change has been made to
|
||||||
|
## extend availables questions types list.
|
||||||
|
## See: TODO DOC LINK
|
||||||
|
|
||||||
|
[main.customization.project_name]
|
||||||
|
|
||||||
|
## (required) The ask property is equivalent to the ask property in
|
||||||
|
## the manifest. However, in config panels, questions are displayed on the
|
||||||
|
## left side and therefore have less space to be rendered. Therefore,
|
||||||
|
## it is better to use a short question, and use the "help" property to
|
||||||
|
## provide additional details if necessary.
|
||||||
|
ask.en = "Name of the project"
|
||||||
|
|
||||||
|
## (required) The type property indicates how the question should be
|
||||||
|
## displayed, validated and managed. Some types have specific properties.
|
||||||
|
##
|
||||||
|
## Types available: string, boolean, number, range, text, password, path
|
||||||
|
## email, url, date, time, color, select, domain, user, tags, file.
|
||||||
|
##
|
||||||
|
## For a complete list with specific properties, see: TODO DOC LINK
|
||||||
|
type = "string"
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
#### ABOUT THE BIND PROPERTY
|
||||||
|
########################################################################
|
||||||
|
|
||||||
|
## (recommended) 'bind' property is a powerful feature that let you
|
||||||
|
## configure how and where the data will be read, validated and written.
|
||||||
|
|
||||||
|
## By default, 'bind property is in "settings" mode, it means it will
|
||||||
|
## **only** read and write the value in application settings file.
|
||||||
|
## bind = "settings"
|
||||||
|
|
||||||
|
## However, settings usually correspond to key/values in actual app configurations
|
||||||
|
## Hence, a more useful mode is to have bind = ":FILENAME". In that case, YunoHost
|
||||||
|
## will automagically find a line with "KEY=VALUE" in FILENAME
|
||||||
|
## (with the adequate separator between KEY and VALUE)
|
||||||
|
##
|
||||||
|
## YunoHost will then use this value for the read/get operation.
|
||||||
|
## During write/set operations, YunoHost will overwrite the value
|
||||||
|
## in **both** FILENAME and in the app's settings.yml
|
||||||
|
|
||||||
|
## Configuration file format supported: yaml, toml, json, ini, env, php,
|
||||||
|
## python. The feature probably works with others formats, but should be tested carefully.
|
||||||
|
|
||||||
|
## Note that this feature only works with relatively simple cases
|
||||||
|
## such as `KEY: VALUE`, but won't properly work with
|
||||||
|
## complex data structures like multilin array/lists or dictionnaries.
|
||||||
|
## It also doesn't work with XML format, custom config function call, php define(), ...
|
||||||
|
|
||||||
|
## More info on TODO
|
||||||
|
# bind = ":/var/www/__APP__/settings.py"
|
||||||
|
|
||||||
|
|
||||||
|
## By default, bind = ":FILENAME" will use the question ID as KEY
|
||||||
|
## ... but the question ID may sometime not be the exact KEY name in the configuration file.
|
||||||
|
##
|
||||||
|
## In particular, in pepettes, the python variable is 'name' and not 'project_name'
|
||||||
|
## (c.f. https://github.com/YunoHost-Apps/pepettes_ynh/blob/5cc2d3ffd6529cc7356ff93af92dbb6785c3ab9a/conf/settings.py##L11 )
|
||||||
|
##
|
||||||
|
## In that case, the key name can be specified before the column ':'
|
||||||
|
|
||||||
|
bind = "name:/var/www/__APP__/settings.py"
|
||||||
|
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
## IMPORTANT: other 'bind' mode exists:
|
||||||
|
##
|
||||||
|
## bind = "FILENAME" (with no column character before FILENAME)
|
||||||
|
## may be used to bind to the **entire file content** (instead of a single KEY/VALUE)
|
||||||
|
## This could be used to expose an entire configuration file, or binary files such as images
|
||||||
|
## For example:
|
||||||
|
## bind = "/var/www/__APP__/img/logo.png"
|
||||||
|
##
|
||||||
|
## bind = "null" can be used to disable reading / writing in settings.
|
||||||
|
## This creates sort of a "virtual" or "ephemeral" question which is not related to any actual setting
|
||||||
|
## In this mode, you are expected to define custom getter/setters/validators in scripts/config:
|
||||||
|
##
|
||||||
|
## getter: get__QUESTIONID()
|
||||||
|
## setter: set__QUESTIONID()
|
||||||
|
## validator: validate__QUESTIONID()
|
||||||
|
##
|
||||||
|
## You can also specify a common getter / setter / validator, with the
|
||||||
|
## function 'bind' mode, for example here it will try to run
|
||||||
|
## get__array_settings() first.
|
||||||
|
# bind = "array_settings()"
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
## IMPORTANT: with the exception of bind=null questions,
|
||||||
|
## question IDs should almost **always** correspond to an app setting
|
||||||
|
## initialized / reused during install/upgrade.
|
||||||
|
## Not doing so may result in inconsistencies between the config panel mechanism
|
||||||
|
## and the use of ynh_add_config
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
#### OTHER GENERIC PROPERTY FOR QUESTIONS
|
||||||
|
########################################################################
|
||||||
|
|
||||||
|
## (optional) An help text for the question
|
||||||
|
help = "Fill the name of the project which will received donation"
|
||||||
|
|
||||||
|
## (optional) An example display as placeholder in web form
|
||||||
|
# example = "YunoHost"
|
||||||
|
|
||||||
|
## (optional) set to true in order to redact the value in operation logs
|
||||||
|
# redact = false
|
||||||
|
|
||||||
|
## (optional) for boolean questions you can specify replacement values
|
||||||
|
## bound to true and false, in case property is bound to config file
|
||||||
|
# useful if bound property in config file expects something else than integer 1
|
||||||
|
yes = "Enable"
|
||||||
|
# useful if bound property in config file expects something else than integer 0
|
||||||
|
no = "Disable"
|
||||||
|
|
||||||
|
## (optional) A validation pattern
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
## IMPORTANT: your pattern should be between simple quote, not double.
|
||||||
|
## ---------------------------------------------------------------------
|
||||||
|
pattern.regexp = '^\w{3,30}$'
|
||||||
|
pattern.error = "The name should be at least 3 chars and less than 30 chars. Alphanumeric chars are accepted"
|
||||||
|
|
||||||
|
## Note: visible and optional properties are also available for questions
|
||||||
|
|
||||||
|
|
||||||
|
[main.customization.contact_url]
|
||||||
|
ask = "Contact url"
|
||||||
|
type = "url"
|
||||||
|
example = "mailto: contact@example.org"
|
||||||
|
help = "mailto: accepted"
|
||||||
|
pattern.regexp = '^mailto:[^@]+@[^@]+|https://$'
|
||||||
|
pattern.error = "Should be https or mailto:"
|
||||||
|
bind = ":/var/www/__APP__/settings.py"
|
||||||
|
|
||||||
|
[main.customization.logo]
|
||||||
|
ask = "Logo"
|
||||||
|
type = "file"
|
||||||
|
accept = ".png"
|
||||||
|
help = "Fill with an already resized logo"
|
||||||
|
bind = "__INSTALL_DIR__/img/logo.png"
|
||||||
|
|
||||||
|
[main.customization.favicon]
|
||||||
|
ask = "Favicon"
|
||||||
|
type = "file"
|
||||||
|
accept = ".png"
|
||||||
|
help = "Fill with an already sized favicon"
|
||||||
|
bind = "__INSTALL_DIR__/img/favicon.png"
|
||||||
|
|
||||||
|
|
||||||
|
[main.stripe]
|
||||||
|
name = "Stripe general info"
|
||||||
|
optional = false
|
||||||
|
|
||||||
|
# The next alert is overwrited with a getter from the config script
|
||||||
|
[main.stripe.amount]
|
||||||
|
ask = "Donation in the month : XX €
|
||||||
|
type = "alert"
|
||||||
|
style = "success"
|
||||||
|
|
||||||
|
[main.stripe.publishable_key]
|
||||||
|
ask = "Publishable key"
|
||||||
|
type = "string"
|
||||||
|
redact = true
|
||||||
|
help = "Indicate here the stripe publishable key"
|
||||||
|
bind = ":/var/www/__APP__/settings.py"
|
||||||
|
|
||||||
|
[main.stripe.secret_key]
|
||||||
|
ask = "Secret key"
|
||||||
|
type = "string"
|
||||||
|
redact = true
|
||||||
|
help = "Indicate here the stripe secret key"
|
||||||
|
bind = ":/var/www/__APP__/settings.py"
|
||||||
|
|
||||||
|
[main.stripe.prices]
|
||||||
|
ask = "Prices ID"
|
||||||
|
type = "tags"
|
||||||
|
help = """\
|
||||||
|
Indicates here the prices ID of donation products you created in stripe interfaces. \
|
||||||
|
Go on [Stripe products](https://dashboard.stripe.com/products) to create those donation products. \
|
||||||
|
Fill it tag with 'FREQUENCY/CURRENCY/PRICE_ID' \
|
||||||
|
FREQUENCY: 'one_time' or 'recuring' \
|
||||||
|
CURRENCY: 'EUR' or 'USD' \
|
||||||
|
PRICE_ID: ID from stripe interfaces starting with 'price_' \
|
||||||
|
"""
|
||||||
|
pattern.regexp = '^(one_time|recuring)/(EUR|USD)/price_.*$'
|
||||||
|
pattern.error = "Please respect the format describe in help text for each price ID"
|
||||||
0
doc/.gitkeep
Normal file
0
doc/.gitkeep
Normal file
1
doc/DESCRIPTION.md
Normal file
1
doc/DESCRIPTION.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?
|
||||||
1
doc/DESCRIPTION_fr.md
Normal file
1
doc/DESCRIPTION_fr.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
MicroBin est une application Web super petite, riche en fonctionnalités, configurable, autonome et auto-hébergée. Il est très simple à configurer et à utiliser et ne nécessitera que quelques mégaoctets de mémoire et de stockage sur disque. La configuration ne prend que quelques minutes, pourquoi ne pas l'essayer maintenant ?
|
||||||
0
doc/screenshots/.gitkeep
Normal file
0
doc/screenshots/.gitkeep
Normal file
BIN
doc/screenshots/screenshot7.png
Normal file
BIN
doc/screenshots/screenshot7.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 448 KiB |
68
manifest.toml
Normal file
68
manifest.toml
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json
|
||||||
|
|
||||||
|
packaging_format = 2
|
||||||
|
|
||||||
|
id = "microbin"
|
||||||
|
name = "Microbin"
|
||||||
|
description.en = "Configurable file-sharing and URL shortening web app"
|
||||||
|
description.fr = "Application Web sécurisée et configurable de partage de fichiers et de raccourcissement d'URL"
|
||||||
|
|
||||||
|
version = "2.0.4~ynh1"
|
||||||
|
|
||||||
|
maintainers = ["eric_G"]
|
||||||
|
|
||||||
|
[upstream]
|
||||||
|
license = "BSD-3-Clause"
|
||||||
|
website = "https://microbin.eu/"
|
||||||
|
demo = "https://pub.microbin.eu/"
|
||||||
|
code = "https://github.com/szabodanika/microbin"
|
||||||
|
fund = "https://ko-fi.com/dani_sz"
|
||||||
|
|
||||||
|
[integration]
|
||||||
|
yunohost = ">= 11.2"
|
||||||
|
architectures = "all"
|
||||||
|
multi_instance = true
|
||||||
|
|
||||||
|
ldap = false
|
||||||
|
|
||||||
|
sso = false
|
||||||
|
|
||||||
|
disk = "50M"
|
||||||
|
ram.build = "50M"
|
||||||
|
ram.runtime = "50M"
|
||||||
|
|
||||||
|
[install]
|
||||||
|
[install.domain]
|
||||||
|
type = "domain"
|
||||||
|
|
||||||
|
[install.init_main_permission]
|
||||||
|
type = "group"
|
||||||
|
default = "visitors"
|
||||||
|
|
||||||
|
[install.admin]
|
||||||
|
type = "user"
|
||||||
|
|
||||||
|
[install.password]
|
||||||
|
help.en = "Use the help field to add an information for the admin about this question."
|
||||||
|
help.fr = "Utilisez le champ aide pour ajouter une information à l'intention de l'administrateur à propos de cette question."
|
||||||
|
type = "password"
|
||||||
|
|
||||||
|
[resources]
|
||||||
|
|
||||||
|
[resources.sources]
|
||||||
|
|
||||||
|
[resources.sources.main]
|
||||||
|
in_subdir = false
|
||||||
|
url = "https://github.com/szabodanika/microbin/releases/download/v2.0.4/microbin-v2.0.4-x86_64-unknown-linux-musl.tar.gz"
|
||||||
|
sha256 = "ccfc69c5ab33cc79c56da0cea55e68a5b93f19fd68ac028a00e9d09bcf5575b6"
|
||||||
|
|
||||||
|
[resources.system_user]
|
||||||
|
|
||||||
|
[resources.install_dir]
|
||||||
|
|
||||||
|
[resources.data_dir]
|
||||||
|
|
||||||
|
[resources.permissions]
|
||||||
|
main.url = "/"
|
||||||
|
|
||||||
|
[resources.ports]
|
||||||
17
scripts/_common.sh
Normal file
17
scripts/_common.sh
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# COMMON VARIABLES
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# PERSONAL HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# EXPERIMENTAL HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# FUTURE OFFICIAL HELPERS
|
||||||
|
#=================================================
|
||||||
43
scripts/backup
Executable file
43
scripts/backup
Executable file
|
|
@ -0,0 +1,43 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
|
||||||
|
source ../settings/scripts/_common.sh
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DECLARE DATA AND CONF FILES TO BACKUP
|
||||||
|
#=================================================
|
||||||
|
ynh_print_info --message="Declaring files to be backed up..."
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE APP MAIN DIR
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup --src_path="$install_dir"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE DATA DIR
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
### Only relevant if there is a "data_dir" resource for this app
|
||||||
|
ynh_backup --src_path="$data_dir" --is_big
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SYSTEM CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Backup the nginx configuration
|
||||||
|
ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
|
# Backup the systemd service unit
|
||||||
|
ynh_backup --src_path="/etc/systemd/system/$app.service"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
|
||||||
40
scripts/change_url
Normal file
40
scripts/change_url
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
## this script is only run if actual change to domain/path is detected, if you're here either $domain or $path changed
|
||||||
|
## new location is available via $domain and $path (or $new_domain and $new_path variables if you want to be explicit)
|
||||||
|
## old values are available via, you guessed it, $old_domain and $old_path
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
source _common.sh
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# STOP SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Stopping $app's systemd service..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name="$app" --action="stop" --log_path="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# MODIFY URL IN NGINX CONF
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
|
||||||
|
|
||||||
|
# this will most likely adjust NGINX config correctly
|
||||||
|
ynh_change_url_nginx_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# START SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Starting $app's systemd service..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_script_progression --message="Change of URL completed for $app" --last
|
||||||
92
scripts/config
Normal file
92
scripts/config
Normal file
|
|
@ -0,0 +1,92 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# In simple cases, you don't need a config script.
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
ynh_abort_if_errors
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RETRIEVE ARGUMENTS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
install_dir=$(ynh_app_setting_get --app="$app" --key=install_dir)
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SPECIFIC GETTERS FOR TOML SHORT KEY
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
get__amount() {
|
||||||
|
# Here we can imagine to have an API call to stripe to know the amount of donation during a month
|
||||||
|
local amount=200
|
||||||
|
|
||||||
|
# It's possible to change some properties of the question by overriding it:
|
||||||
|
if [ "$amount" -gt 100 ]; then
|
||||||
|
cat << EOF
|
||||||
|
style: success
|
||||||
|
value: $amount
|
||||||
|
ask:
|
||||||
|
en: A lot of donation this month: **$amount €**
|
||||||
|
EOF
|
||||||
|
else
|
||||||
|
cat << EOF
|
||||||
|
style: danger
|
||||||
|
value: $amount
|
||||||
|
ask:
|
||||||
|
en: Not so much donation this month: $amount €
|
||||||
|
EOF
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
get__prices() {
|
||||||
|
local prices
|
||||||
|
prices="$(grep "DONATION\['" "$install_dir/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')"
|
||||||
|
if [ "$prices" == "," ]; then
|
||||||
|
# Return YNH_NULL if you prefer to not return a value at all.
|
||||||
|
echo YNH_NULL
|
||||||
|
else
|
||||||
|
echo "$prices"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SPECIFIC VALIDATORS FOR TOML SHORT KEYS
|
||||||
|
#=================================================
|
||||||
|
validate__publishable_key() {
|
||||||
|
|
||||||
|
# We can imagine here we test if the key is really a publishable key
|
||||||
|
(is_secret_key "$publishable_key") &&
|
||||||
|
echo 'This key seems to be a secret key'
|
||||||
|
}
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SPECIFIC SETTERS FOR TOML SHORT KEYS
|
||||||
|
#=================================================
|
||||||
|
set__prices() {
|
||||||
|
|
||||||
|
#---------------------------------------------
|
||||||
|
# IMPORTANT: setters are triggered only if a change is detected
|
||||||
|
#---------------------------------------------
|
||||||
|
for price in $(echo "$prices" | sed "s/,/ /"); do
|
||||||
|
frequency=$(echo "$price" | cut -d/ -f1)
|
||||||
|
currency=$(echo "$price" | cut -d/ -f2)
|
||||||
|
price_id=$(echo "$price" | cut -d/ -f3)
|
||||||
|
sed "d/DONATION\['$frequency'\]\['$currency'\]" "$install_dir/settings.py"
|
||||||
|
|
||||||
|
echo "DONATION['$frequency']['$currency'] = '$price_id'" >> "$install_dir/settings.py"
|
||||||
|
done
|
||||||
|
|
||||||
|
#---------------------------------------------
|
||||||
|
# IMPORTANT: to be able to upgrade properly, you have to save the value in settings too
|
||||||
|
#---------------------------------------------
|
||||||
|
ynh_app_setting_set --app="$app" --key=prices --value="$prices"
|
||||||
|
}
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# GENERIC FINALIZATION
|
||||||
|
#=================================================
|
||||||
|
ynh_app_config_run "$1"
|
||||||
42
scripts/install
Executable file
42
scripts/install
Executable file
|
|
@ -0,0 +1,42 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
source _common.sh
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Setting up source files..." --weight=1
|
||||||
|
|
||||||
|
ynh_setup_source --dest_dir="$install_dir"
|
||||||
|
|
||||||
|
chown -R "$app:www-data" "$install_dir"
|
||||||
|
chmod +x "$install_dir/microbin"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SYSTEM CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
|
||||||
|
|
||||||
|
ynh_add_nginx_config
|
||||||
|
|
||||||
|
ynh_add_systemd_config
|
||||||
|
|
||||||
|
yunohost service add "$app" --description="Configurable file-sharing app" --log="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# START SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Starting $app's systemd service..." --weight=1
|
||||||
|
|
||||||
|
# Start a systemd service
|
||||||
|
ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Installation of $app completed" --last
|
||||||
28
scripts/remove
Executable file
28
scripts/remove
Executable file
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
source _common.sh
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE SYSTEM CONFIGURATIONS
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
|
||||||
|
|
||||||
|
if ynh_exec_warn_less yunohost service status "$app" >/dev/null; then
|
||||||
|
ynh_script_progression --message="Removing $app service integration..." --weight=1
|
||||||
|
yunohost service remove "$app"
|
||||||
|
fi
|
||||||
|
|
||||||
|
ynh_remove_systemd_config
|
||||||
|
|
||||||
|
ynh_remove_nginx_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_script_progression --message="Removal of $app completed" --last
|
||||||
56
scripts/restore
Executable file
56
scripts/restore
Executable file
|
|
@ -0,0 +1,56 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
|
||||||
|
source ../settings/scripts/_common.sh
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RESTORE THE APP MAIN DIR
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Restoring the app main directory..." --weight=1
|
||||||
|
|
||||||
|
ynh_restore_file --origin_path="$install_dir"
|
||||||
|
|
||||||
|
chown -R "$app:www-data" "$install_dir"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RESTORE THE DATA DIRECTORY
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Restoring the data directory..." --weight=1
|
||||||
|
|
||||||
|
ynh_restore_file --origin_path="$data_dir" --not_mandatory
|
||||||
|
|
||||||
|
### (Same as for install dir)
|
||||||
|
chown -R "$app:www-data" "$data_dir"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RESTORE SYSTEM CONFIGURATIONS
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
|
||||||
|
|
||||||
|
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
|
ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
|
||||||
|
systemctl enable "$app.service" --quiet
|
||||||
|
|
||||||
|
yunohost service add "$app" --description="Configurable file-sharing app" --log="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
|
||||||
|
|
||||||
|
### Typically you only have either $app or php-fpm but not both at the same time...
|
||||||
|
ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name=nginx --action=reload
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_script_progression --message="Restoration completed for $app" --last
|
||||||
50
scripts/upgrade
Executable file
50
scripts/upgrade
Executable file
|
|
@ -0,0 +1,50 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
source _common.sh
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# STOP SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Stopping $app's systemd service..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name="$app" --action="stop" --log_path="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Upgrading source files..." --weight=1
|
||||||
|
|
||||||
|
ynh_setup_source --dest_dir="$install_dir"
|
||||||
|
|
||||||
|
chown -R "$app:www-data" "$install_dir"
|
||||||
|
chmod +x "$install_dir/microbin"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REAPPLY SYSTEM CONFIGURATIONS
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
|
||||||
|
|
||||||
|
ynh_add_nginx_config
|
||||||
|
|
||||||
|
ynh_add_systemd_config
|
||||||
|
|
||||||
|
yunohost service add "$app" --description="Configurable file-sharing app" --log="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# START SYSTEMD SERVICE
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Starting $app's systemd service..." --weight=1
|
||||||
|
|
||||||
|
ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# END OF SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_script_progression --message="Upgrade of $app completed" --last
|
||||||
2
sources/extra_files/app/.gitignore
vendored
Normal file
2
sources/extra_files/app/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
*~
|
||||||
|
*.sw[op]
|
||||||
2
sources/patches/.gitignore
vendored
Normal file
2
sources/patches/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
*~
|
||||||
|
*.sw[op]
|
||||||
78
tests.toml
Normal file
78
tests.toml
Normal file
|
|
@ -0,0 +1,78 @@
|
||||||
|
#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json
|
||||||
|
|
||||||
|
test_format = 1.0
|
||||||
|
|
||||||
|
[default]
|
||||||
|
|
||||||
|
# ------------
|
||||||
|
# Tests to run
|
||||||
|
# ------------
|
||||||
|
|
||||||
|
# -------------------------------------------------------------------------------
|
||||||
|
# EVERYTHING PAST THIS POINT IS OPTIONAL AND MOST LIKELY UNNECESSARY FOR NEW APPS
|
||||||
|
#--------------------------------------------------------------------------------
|
||||||
|
## Conventions in this sample:
|
||||||
|
## <- An actual comment
|
||||||
|
# <- uncommenting this should be a valid entry in 'tests.toml'
|
||||||
|
|
||||||
|
## NB: the tests to run are automatically deduced by the CI script according to the
|
||||||
|
## content of the app's manifest. The declarations below allow to customize which
|
||||||
|
## tests are ran, possibly add special test suite to test special args, or
|
||||||
|
## declare which commits to test upgrade from.
|
||||||
|
##
|
||||||
|
## You can also decide (though this is discouraged!) to ban/ignore some tests,
|
||||||
|
## The test IDs to be used in only/exclude statements are:
|
||||||
|
## * install.root
|
||||||
|
## * install.subdir
|
||||||
|
## * install.nourl
|
||||||
|
## * install.multi
|
||||||
|
## * backup_restore
|
||||||
|
## * upgrade
|
||||||
|
## * upgrade.someCommitId
|
||||||
|
## * change_url
|
||||||
|
## NB: you should NOT need this except if you really have a good reason...
|
||||||
|
|
||||||
|
# exclude = ["install.private", "install.multi"]
|
||||||
|
|
||||||
|
## For special usecases, sometimes you need to setup other things on the machine
|
||||||
|
## prior to installing the app (such as installing another app)
|
||||||
|
## (Remove this key entirely if not needed)
|
||||||
|
|
||||||
|
# preinstall = """
|
||||||
|
# sudo yunohost app install foobar
|
||||||
|
# sudo yunohost user list
|
||||||
|
# """
|
||||||
|
|
||||||
|
# -------------------------------
|
||||||
|
# Default args to use for install
|
||||||
|
# -------------------------------
|
||||||
|
|
||||||
|
## By default, the CI will automagically fill the 'standard' args
|
||||||
|
## such as domain, path, admin, is_public and password with relevant values
|
||||||
|
## and also install args with a "default" provided in the manifest..
|
||||||
|
## It should only make sense to declare custom args here for args with no default values
|
||||||
|
## NB: you should NOT need those lines unless for custom questions with no obvious/default value
|
||||||
|
|
||||||
|
# args.language = "fr_FR"
|
||||||
|
# args.multisite = 0
|
||||||
|
|
||||||
|
# -------------------------------
|
||||||
|
# Commits to test upgrade from
|
||||||
|
# -------------------------------
|
||||||
|
|
||||||
|
## 00a1a6e7 is part of commit SHA, preferrably from 'master' branch
|
||||||
|
## that points to valid install of previous version
|
||||||
|
|
||||||
|
# test_upgrade_from.00a1a6e7.name = "Upgrade from 5.4"
|
||||||
|
# test_upgrade_from.00a1a6e7.args.foo = "bar"
|
||||||
|
|
||||||
|
|
||||||
|
## This is an additional test suite
|
||||||
|
# [some_additional_testsuite]
|
||||||
|
|
||||||
|
## On additional tests suites, you can decide to run only specific tests
|
||||||
|
|
||||||
|
# only = ["install.subdir"]
|
||||||
|
|
||||||
|
# args.language = "en_GB"
|
||||||
|
# args.multisite = 1
|
||||||
Loading…
Add table
Reference in a new issue