lufi_ynh/README.md

<!--
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.
-->

# Lufi for YunoHost

[![Integration level](https://dash.yunohost.org/integration/lufi.svg)](https://dash.yunohost.org/appci/app/lufi) ![Working status](https://ci-apps.yunohost.org/ci/badges/lufi.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/lufi.maintain.svg)  
[![Install Lufi with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lufi)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Lufi 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

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](https://en.wikipedia.org/wiki/Fragment_identifier)), that means this part is only processed client-side and does not reach the server. :-)


**Shipped version:** 0.05.18~ynh1

**Demo:** https://demo.lufi.io/

## Screenshots

![Screenshot of Lufi](./doc/screenshots/screenshot_lufi_1.png)

## Disclaimers / important information

## Configuration

* How to configure this app: a plain file at `/var/www/lufi/lufi.conf` with SSH.

## Documentation and resources

* Official admin documentation: <https://framagit.org/luc/lufi/wikis/home>
* Upstream app code repository: <https://framagit.org/fiat-tux/hat-softwares/lufi>
* YunoHost documentation for this app: <https://yunohost.org/app_lufi>
* Report a bug: <https://github.com/YunoHost-Apps/lufi_ynh/issues>

## Developer info

Please send 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.

``` bash
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 info regarding app packaging:** <https://yunohost.org/packaging_apps>