send_ynh/README.md

57 lines
2.1 KiB
Markdown
Raw Normal View History

2021-08-25 17:43:06 +02:00
<!--
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.
-->
2021-08-25 17:42:59 +02:00
# Send for YunoHost
2022-06-26 07:47:24 +02:00
[![Integration level](https://dash.yunohost.org/integration/send.svg)](https://dash.yunohost.org/appci/app/send) ![Working status](https://ci-apps.yunohost.org/ci/badges/send.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/send.maintain.svg)
2021-08-25 17:43:06 +02:00
[![Install Send with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=send)
2021-08-25 17:42:59 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-08-25 17:43:06 +02:00
> *This package allows you to install Send quickly and simply on a YunoHost server.
2021-08-25 17:42:59 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2021-08-28 23:32:38 +02:00
A fork of Mozilla's Firefox Send. Mozilla discontinued Send, this fork is a community effort to keep the project up-to-date and alive.
Send is a file sharing experiment which allows you to send encrypted files to other users.
2021-08-25 17:42:59 +02:00
2022-06-26 07:47:24 +02:00
**Shipped version:** 3.4.20~ynh1
2021-08-25 17:42:59 +02:00
2021-08-25 17:43:06 +02:00
**Demo:** https://send.vis.ee/
2021-08-25 17:42:59 +02:00
2021-08-25 17:43:06 +02:00
## Screenshots
2021-08-25 17:42:59 +02:00
2022-06-26 07:47:24 +02:00
![Screenshot of Send](./doc/screenshots/screenshot.png)
2021-08-25 17:42:59 +02:00
2021-08-26 13:24:08 +02:00
## Disclaimers / important information
## Configuration
The config file path is `var/www/send/server/config.js`.
You can configure things such as the max file size, max downloads, or max file expire time.
2021-08-25 17:43:06 +02:00
## Documentation and resources
2021-08-25 17:42:59 +02:00
2022-06-26 07:47:24 +02:00
* Official app website: <https://send.vis.ee/>
* Upstream app code repository: <https://github.com/timvisee/send>
* YunoHost documentation for this app: <https://yunohost.org/app_send>
* Report a bug: <https://github.com/YunoHost-Apps/send_ynh/issues>
2021-08-25 17:42:59 +02:00
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/send_ynh/tree/testing).
To try the testing branch, please proceed like that.
2022-06-26 07:47:24 +02:00
``` bash
2021-08-25 17:42:59 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/send_ynh/tree/testing --debug
or
sudo yunohost app upgrade send -u https://github.com/YunoHost-Apps/send_ynh/tree/testing --debug
```
2021-08-25 17:43:06 +02:00
2022-06-26 07:47:24 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>