diff --git a/README.md b/README.md index 2d91465..8dfae55 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,63 @@ -# psitransfer_ynh + -**ÉTAT**=**NOT-WORKING** +# PSITransfer for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/psitransfer.svg)](https://dash.yunohost.org/appci/app/psitransfer) ![](https://ci-apps.yunohost.org/ci/badges/psitransfer.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/psitransfer.maintain.svg) +[![Install PSITransfer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=psitransfer) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install PSITransfer 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 + +Simple open source self-hosted file sharing solution. +It's an alternative to paid services like Dropbox, WeTransfer. + +* No accounts, no logins +* Mobile friendly responsive interface +* Supports many and very big files (Streams ftw) +* Resumable up- and downloads ([tus.io](https://tus.io)) +* Set an expire-time for your upload bucket +* One-time downloads +* Download all files as zip/tar.gz archive +* Modal-style file preview +* Requires Node >=7.4 or use `--harmony-async-await` flag +* Password protected download list ([AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard)) +* `/admin` Page lists bucket information, [Screenshot](https://raw.githubusercontent.com/psi-4ward/psitransfer/master/docs/PsiTransfer-Admin.png) (_disabled until you set `adminPass` config value_) +* Lightweight [Vue](https://vuejs.org) based frontend apps. Gzipped (on by default) less than 100k +* Explicit named bucket IDs with query param `sid=` + + +**Shipped version:** 1.12.0~ynh1 + + + +## Screenshots + +![](./doc/screenshots/psitransfer.gif) + +## Documentation and resources + +* Official app website: https://psi.cx/tags/PsiTransfer +* Official admin documentation: https://github.com/psi-4ward/psitransfer/tree/master/docs +* Upstream app code repository: https://github.com/psi-4ward/psitransfer +* YunoHost documentation for this app: https://yunohost.org/app_psitransfer +* Report a bug: https://github.com/YunoHost-Apps/psitransfer_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/psitransfer_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/psitransfer_ynh/tree/testing --debug +or +sudo yunohost app upgrade psitransfer -u https://github.com/YunoHost-Apps/psitransfer_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..7a37186 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,59 @@ +# PSITransfer pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/psitransfer.svg)](https://dash.yunohost.org/appci/app/psitransfer) ![](https://ci-apps.yunohost.org/ci/badges/psitransfer.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/psitransfer.maintain.svg) +[![Installer PSITransfer avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=psitransfer) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer PSITransfer 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 + +Simple open source self-hosted file sharing solution. +It's an alternative to paid services like Dropbox, WeTransfer. + +* No accounts, no logins +* Mobile friendly responsive interface +* Supports many and very big files (Streams ftw) +* Resumable up- and downloads ([tus.io](https://tus.io)) +* Set an expire-time for your upload bucket +* One-time downloads +* Download all files as zip/tar.gz archive +* Modal-style file preview +* Requires Node >=7.4 or use `--harmony-async-await` flag +* Password protected download list ([AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard)) +* `/admin` Page lists bucket information, [Screenshot](https://raw.githubusercontent.com/psi-4ward/psitransfer/master/docs/PsiTransfer-Admin.png) (_disabled until you set `adminPass` config value_) +* Lightweight [Vue](https://vuejs.org) based frontend apps. Gzipped (on by default) less than 100k +* Explicit named bucket IDs with query param `sid=` + + +**Version incluse :** 1.12.0~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/psitransfer.gif) + +## Documentations et ressources + +* Site officiel de l'app : https://psi.cx/tags/PsiTransfer +* Documentation officielle de l'admin : https://github.com/psi-4ward/psitransfer/tree/master/docs +* Dépôt de code officiel de l'app : https://github.com/psi-4ward/psitransfer +* Documentation YunoHost pour cette app : https://yunohost.org/app_psitransfer +* Signaler un bug : https://github.com/YunoHost-Apps/psitransfer_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/psitransfer_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/psitransfer_ynh/tree/testing --debug +ou +sudo yunohost app upgrade psitransfer -u https://github.com/YunoHost-Apps/psitransfer_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file