mirror of
https://github.com/YunoHost-Apps/lufi_ynh.git
synced 2024-09-03 19:36:28 +02:00
Update README
This commit is contained in:
Kayou
parent
e4ff0fd24d
commit
619276677b
2 changed files with 175 additions and 31 deletions
90
README.md
90
README.md
|
|
@ -1,44 +1,72 @@
|
|||
# Lufi for YunoHost
|
||||
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh/releases)
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh/milestones)
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh#dependencies)
|
||||
[](https://raw.githubusercontent.com/YunoHost-Apps/lufi_ynh/master/LICENSE)
|
||||
[](https://github.com/YunoHost/yunohost)
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh/issues)
|
||||
[](https://dash.yunohost.org/appci/app/lufi)
|
||||
[](https://install-app.yunohost.org/?app=lufi)
|
||||
|
||||
## Lufi c'est quoi ?
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
Il stocke vos fichiers et vous permet de les télécharger.
|
||||
|
||||
Est-ce tout? Non. Tous les fichiers sont cryptés par le navigateur! Non chiffré. Ça ne marche pas. L'administrateur de l'instance Lufi ne pourra pas voir quel est votre administrateur réseau ou votre FAI.
|
||||
|
||||
La clé de cryptage est une ancre (voir Fragment Identifier), ce qui signifie que cette partie n'est traitée que par le client et n'atteint pas le serveur. :-)
|
||||
|
||||
Source: [Documentation de Lufi](https://framagit.org/luc/lufi/wikis/home)
|
||||
|
||||
### Installation
|
||||
|
||||
`$ sudo yunohost app install https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
|
||||
### Mise à jour
|
||||
|
||||
`$ sudo yunohost app upgrade --verbose lufi -u https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
|
||||
## What is Lufi?
|
||||
> *This package allow you to install lufi quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
|
||||
## Overview
|
||||
It stores files and allows you to download them.
|
||||
|
||||
Is that all? No. All the files are encrypted by the browser! It means that your files never leave your computer unencrypted. The administrator of the Lufi instance you use will not be able to see what is in your file, neither will your network administrator, or your ISP.
|
||||
Is that all? No. All the files are encrypted **by the browser**! It means that your files **never** leave your computer unencrypted.
|
||||
The administrator of the Lufi instance you use will not be able to see what is in your file, neither will your network administrator, or your ISP.
|
||||
|
||||
The encryption key part of the URL is a anchor (Cf. Fragment Identifier), that means this part is only processed client-side and does not reach the server. :-)
|
||||
The encryption key part of the URL is a anchor (Cf. [Fragment Identifier](https://en.wikipedia.org/wiki/Fragment_identifier)), that means this part is only processed client-side and does not reach the server. :-)
|
||||
|
||||
Source: [Lufi documentation](https://framagit.org/luc/lufi/wikis/home)
|
||||
**Shipped version:** 0.03.5
|
||||
|
||||
### Install
|
||||
## Screenshots
|
||||
|
||||
`$ sudo yunohost app install https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
|
||||
|
||||
### Update
|
||||
## Demo
|
||||
|
||||
`$ sudo yunohost app upgrade --verbose lufi -u https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
* [Official demo](https://demo.lufi.io/)
|
||||
|
||||
## Configuration
|
||||
|
||||
How to configure this app: a plain file with SSH.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://framagit.org/luc/lufi/wikis/home
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
Are LDAP and HTTP auth supported? **Yes**
|
||||
Can the app be used by multiple users? **Yes**
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/lufi/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/lufi/)
|
||||
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/lufi/)
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/lufi_ynh/issues
|
||||
* App website: https://framagit.org/fiat-tux/hat-softwares/lufi
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developers info
|
||||
----------------
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/lufi_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/lufi_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade lufi -u https://github.com/YunoHost-Apps/lufi_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More information on the documentation page:**
|
||||
https://yunohost.org/packaging_apps
|
||||
116
README_fr.md
Normal file
116
README_fr.md
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
# Lufi pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/lufi)
|
||||
[](https://install-app.yunohost.org/?app=lufi)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d'installer lufi 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
|
||||
Il stocke vos fichiers et vous permet de les télécharger.
|
||||
|
||||
Est-ce tout? Non. Tous les fichiers sont cryptés par le navigateur! Non chiffré. Ça ne marche pas. L'administrateur de l'instance Lufi ne pourra pas voir quel est votre administrateur réseau ou votre FAI.
|
||||
|
||||
La clé de cryptage est une ancre (voir [Fragment Identifier](https://en.wikipedia.org/wiki/Fragment_identifier)), ce qui signifie que cette partie n'est traitée que par le client et n'atteint pas le serveur. :-)
|
||||
|
||||
**Version incluse:** 0.03.5
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Démo
|
||||
|
||||
* [Démo officielle](https://demo.lufi.io/)
|
||||
|
||||
## Configuration
|
||||
|
||||
Comment configurer cette application: un fichier brut en SSH.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle: https://framagit.org/luc/lufi/wikis/home
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateurs
|
||||
|
||||
L'authentification LDAP et HTTP est-elle prise en charge? **Oui**
|
||||
L'application peut-elle être utilisée par plusieurs utilisateurs? **Oui**
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/lufi/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/lufi/)
|
||||
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/lufi/)
|
||||
|
||||
## Links
|
||||
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/lufi_ynh/issues
|
||||
* Site de l'application: https://framagit.org/fiat-tux/hat-softwares/lufi
|
||||
* Site web YunoHost: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Informations pour les développeurs
|
||||
----------------
|
||||
|
||||
**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/lufi_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/lufi_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade lufi -u https://github.com/YunoHost-Apps/lufi_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'informations sur la page de documentation:**
|
||||
https://yunohost.org/packaging_apps
|
||||
|
||||
# Lufi for YunoHost
|
||||
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh/releases)
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh/milestones)
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh#dependencies)
|
||||
[](https://raw.githubusercontent.com/YunoHost-Apps/lufi_ynh/master/LICENSE)
|
||||
[](https://github.com/YunoHost/yunohost)
|
||||
[](https://github.com/YunoHost-Apps/lufi_ynh/issues)
|
||||
|
||||
## Lufi c'est quoi ?
|
||||
|
||||
Il stocke vos fichiers et vous permet de les télécharger.
|
||||
|
||||
Est-ce tout? Non. Tous les fichiers sont cryptés par le navigateur! Non chiffré. Ça ne marche pas. L'administrateur de l'instance Lufi ne pourra pas voir quel est votre administrateur réseau ou votre FAI.
|
||||
|
||||
La clé de cryptage est une ancre (voir Fragment Identifier), ce qui signifie que cette partie n'est traitée que par le client et n'atteint pas le serveur. :-)
|
||||
|
||||
Source: [Documentation de Lufi](https://framagit.org/luc/lufi/wikis/home)
|
||||
|
||||
### Installation
|
||||
|
||||
`$ sudo yunohost app install https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
|
||||
### Mise à jour
|
||||
|
||||
`$ sudo yunohost app upgrade --verbose lufi -u https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
|
||||
## What is Lufi?
|
||||
|
||||
It stores files and allows you to download them.
|
||||
|
||||
Is that all? No. All the files are encrypted by the browser! It means that your files never leave your computer unencrypted. The administrator of the Lufi instance you use will not be able to see what is in your file, neither will your network administrator, or your ISP.
|
||||
|
||||
The encryption key part of the URL is a anchor (Cf. Fragment Identifier), that means this part is only processed client-side and does not reach the server. :-)
|
||||
|
||||
Source: [Lufi documentation](https://framagit.org/luc/lufi/wikis/home)
|
||||
|
||||
### Install
|
||||
|
||||
`$ sudo yunohost app install https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
|
||||
### Update
|
||||
|
||||
`$ sudo yunohost app upgrade --verbose lufi -u https://github.com/YunoHost-Apps/lufi_ynh.git`
|
||||
Loading…
Reference in a new issue