1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/transfersh_ynh.git synced 2024-09-04 01:35:59 +02:00
transfersh_ynh/README.md

81 lines
3.3 KiB
Markdown
Raw Normal View History

2022-06-25 13:37:10 +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.
-->
2022-06-25 14:48:42 +02:00
# Transfer.sh for YunoHost
2022-06-25 13:37:10 +02:00
2022-06-25 13:37:16 +02:00
[![Integration level](https://dash.yunohost.org/integration/transfersh.svg)](https://dash.yunohost.org/appci/app/transfersh) ![Working status](https://ci-apps.yunohost.org/ci/badges/transfersh.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/transfersh.maintain.svg)
2022-06-25 14:48:42 +02:00
[![Install Transfer.sh with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=transfersh)
2022-06-25 13:37:10 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-06-25 14:48:42 +02:00
> *This package allows you to install Transfer.sh quickly and simply on a YunoHost server.
2022-06-25 13:37:10 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-06-25 13:37:16 +02:00
Easy and fast file sharing from the command-line. This code contains the server with everything you need to create your own instance.
2022-06-25 13:37:10 +02:00
2022-06-25 13:37:16 +02:00
Transfer.sh currently supports the s3 (Amazon S3), gdrive (Google Drive), storj (Storj) providers, and local file system (local).
2022-06-25 13:37:10 +02:00
2022-06-25 13:37:16 +02:00
### Features
2022-06-25 13:37:10 +02:00
2022-06-25 13:37:16 +02:00
- Made for use with shell
- Share files with a URL
- Unlimited upload
- Files stored forever
- Encrypt your files
- Maximize amount of downloads
- Preview your files in the browser
2022-06-25 13:37:10 +02:00
2022-06-25 13:37:16 +02:00
**Shipped version:** 1.4.0~ynh1
2022-06-25 13:37:10 +02:00
## Screenshots
2022-06-25 14:48:42 +02:00
![Screenshot of Transfer.sh](./doc/screenshots/transfer.sh-about.jpg)
2022-06-25 13:37:10 +02:00
## Disclaimers / important information
2022-06-25 13:37:16 +02:00
# Using the shell function
### Add alias to `.bashrc` or `.zshrc`
Copy and past this function into your `.bashrc` or `.zshrc` file.
Replace `domain.tld` by your transfersh domain
```
transfer(){ if [ $# -eq 0 ];then echo "No arguments specified.\nUsage:\n transfer <file|directory>\n ... | transfer <file_name>">&2;return 1;fi;if tty -s;then file="$1";file_name=$(basename "$file");if [ ! -e "$file" ];then echo "$file: No such file or directory">&2;return 1;fi;if [ -d "$file" ];then file_name="$file_name.zip" ,;(cd "$file"&&zip -r -q - .)|curl --progress-bar --upload-file "-" "https://domain.tld/$file_name"|tee /dev/null,;else cat "$file"|curl --progress-bar --upload-file "-" "https://domain.tld/$file_name"|tee /dev/null;fi;else file_name=$1;curl --progress-bar --upload-file "-" "https://domain.tld/$file_name"|tee /dev/null;fi;}
```
Now you can use transfer function
```
$ transfer hello.txt
```
2022-06-25 13:37:10 +02:00
2022-06-25 13:43:30 +02:00
### How to
2022-06-25 13:37:10 +02:00
2022-06-25 13:37:16 +02:00
https://github.com/dutchcoders/transfer.sh/blob/main/examples.md
2022-06-25 13:37:10 +02:00
## Documentation and resources
2022-06-25 13:37:16 +02:00
* Official app website: <https://transfer.sh/>
* Official admin documentation: <https://github.com/dutchcoders/transfer.sh/>
* Upstream app code repository: <https://github.com/dutchcoders/transfer.sh>
* YunoHost documentation for this app: <https://yunohost.org/app_transfersh>
* Report a bug: <https://github.com/YunoHost-Apps/transfersh_ynh/issues>
2022-06-25 13:37:10 +02:00
## Developer info
2022-06-25 13:37:16 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/transfersh_ynh/tree/testing).
2022-06-25 13:37:10 +02:00
To try the testing branch, please proceed like that.
``` bash
2022-06-25 13:37:16 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/transfersh_ynh/tree/testing --debug
2022-06-25 13:37:10 +02:00
or
2022-06-25 13:37:16 +02:00
sudo yunohost app upgrade transfersh -u https://github.com/YunoHost-Apps/transfersh_ynh/tree/testing --debug
2022-06-25 13:37:10 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>