YunoHost-Apps/my_flask_webapp_ynh
2
0
Fork 0
mirror of https://github.com/YunoHost-Apps/my_flask_webapp_ynh synced 2026-02-04 07:11:52 +01:00
Code Issues Projects Releases Packages Wiki Activity
No description
35 commits 1 branch 0 tags 134 KiB
Find a file
Exact
axolotle 9e20cfe302 update README
2021-11-04 15:55:55 +01:00
.github Initial commit 2021-10-04 13:52:15 +02:00
conf add permission handling and ldap info in .env 2021-11-02 18:43:11 +01:00
doc add description and disclaimer 2021-11-04 15:36:23 +01:00
scripts update manifest info 2021-11-04 15:35:48 +01:00
sources Initial commit 2021-10-04 13:52:15 +02:00
.gitignore Initial commit 2021-10-04 13:52:15 +02:00
check_process yolo update check_process 2021-11-04 15:55:36 +01:00
config_panel.toml add config panel 2021-11-03 21:18:57 +01:00
LICENSE remove unused conf and add license 2021-10-06 20:31:13 +02:00
manifest.json update manifest info 2021-11-04 15:35:48 +01:00
README.md update README 2021-11-04 15:55:55 +01:00
README_fr.md update README 2021-11-04 15:55:55 +01:00

README.md

My Flask Webapp for YunoHost

Integration level
Install My Flask Webapp with YunoHost

Lire ce readme en français.

This package allows you to install My Flask Webapp quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

This package allows you to install a custom Flask app from a git repository.
It will setup for you some basic requirements for a flask app to run by reading some settings on your app yunohost configuration.

/!\ This is still a work in progress, upgrade of this app itself has not really been tested /!\

Features

  • Install and run your app with Gunicorn and a custom number of workers;
  • Create a database (PostgreSQL, SQLite3 or none);
  • Create a data directory in /home/yunohost.app/my_flask_webapp for your database dump, uploads, etc. ;
  • Basic nginx configuration file but you can overwrite it by adding one in your app repo;
  • Some editable settings (workers, max upload size, admin route)
  • An experimental series of actions to run git pull, pip install, npm ci, npm run build and flask db migrate
  • Expose a service in YunoHost that you can turn on and off with some basic logging;
  • Create a permission for accessing the app;
  • Kind of LDAP integration (env vars available);

Shipped version: 0.1~ynh1

Disclaimers / important information

Currently known limitations

  • Upgrade of this app itself has not really been tested;
  • Apps will have names like my_flask_webapp__1;
  • For some LDAP plugins .env LDAP vars might not be well formated;

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/my_flask_webapp_ynh/tree/testing --debug
or
sudo yunohost app upgrade my_flask_webapp -u https://github.com/YunoHost-Apps/my_flask_webapp_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps