YunoHost-Apps/simple-torrent_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/simple-torrent_ynh.git synced 2024-09-03 20:26:18 +02:00
Code Issues Activity Actions

Testing (#44)

Browse source 
* Add template
* Update manifest.json
* Auto-update README
This commit is contained in:
Éric Gaspar 2021-06-04 10:37:52 +02:00 • committed by GitHub
parent b2cae72c4d
commit 90ed433b6e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 109 additions and 129 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.DS_Store vendored Normal file
View file

Binary file not shown.

53
README.md
View file

@ -1,22 +1,32 @@
<!--
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.
-->
# Simple Torrent for YunoHost
[![Integration level](https://dash.yunohost.org/integration/simple-torrent.svg)](https://dash.yunohost.org/appci/app/simple-torrent) ![](https://ci-apps.yunohost.org/ci/badges/simple-torrent.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/simple-torrent.maintain.svg)
[![Install Simple Torrent with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=simple-torrent/)
[![Install Simple Torrent with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=simple-torrent)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Simple Torrent 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.*
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
Simple Torrent is a self-hosted remote torrent client, written in Go (golang). Started torrents remotely, download sets of files on the local disk of the server, which are then retrievable or streamable via HTTP.
Self-hosted remote torrent client
**Shipped version:** 1.2.23~ynh3
**Shipped version:** 1.2.23
## Screenshots
![](https://user-images.githubusercontent.com/1033514/64239393-bdbb6480-cf32-11e9-9269-d8d10e7c0dc7.png)
![](./doc/screenshots/64239393-bdbb6480-cf32-11e9-9269-d8d10e7c0dc7.png)
![](./doc/screenshots/.DS_Store)
## Disclaimers / important information
## Configuration
@ -24,34 +34,17 @@ Most of the items can be edited in Web-UI on the fly in the config board.
You can also configure Simple Torrent by editing this file `/var/www/simple-torrent/config.json` using the [documentation](https://github.com/boypt/simple-torrent/wiki/Config-File).
## Documentation
* Official documentation: https://github.com/boypt/simple-torrent/wiki
* YunoHost documentation: https://yunohost.org/en/app_simple-torrent
## YunoHost specific features
#### Multi-user support
* Is LDAP supported? **No**
* Can the app be used by multiple users? **No**
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/simple-torrent.svg)](https://ci-apps.yunohost.org/ci/apps/simple-torrent/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/simple-torrent.svg)](https://ci-apps-arm.yunohost.org/ci/apps/simple-torrent/)
## Limitations
* Sorry, this app cannot be installed on a 32-bit ARM machine.
- This app cannot be installed on a 32-bit ARM machine.
## Links
## Documentation and resources
* Report a bug: https://github.com/YunoHost-Apps/simple-torrent_ynh/issues
* Upstream app repository: https://github.com/boypt/simple-torrent
* YunoHost website: https://yunohost.org/
---
* Official app website: https://github.com/boypt/simple-torrent
* Official admin documentation: https://github.com/boypt/simple-torrent/wiki
* Upstream app code repository: https://github.com/boypt/simple-torrent
* YunoHost documentation for this app: https://yunohost.org/app_simple-torrent
* Report a bug: https://github.com/YunoHost-Apps/simple-torrent_ynh/issues
## Developer info
@ -63,3 +56,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/simple-torrent_ynh/tr
or
sudo yunohost app upgrade simple-torrent -u https://github.com/YunoHost-Apps/simple-torrent_ynh/tree/testing --debug
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

49
README_fr.md
View file

@ -1,22 +1,28 @@
# Simple Torrent pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/simple-torrent.svg)](https://dash.yunohost.org/appci/app/simpletorrent) ![](https://ci-apps.yunohost.org/ci/badges/simple-torrent.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/simple-torrent.maintain.svg)
[![Niveau d'intégration](https://dash.yunohost.org/integration/simple-torrent.svg)](https://dash.yunohost.org/appci/app/simple-torrent) ![](https://ci-apps.yunohost.org/ci/badges/simple-torrent.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/simple-torrent.maintain.svg)
[![Installer Simple Torrent avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=simple-torrent)
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Simple Torrent rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.*
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
Simple Torrent est un client torrent distant auto-hébergé, écrit en Go (golang). Démarrez des torrents à distance, téléchargez des ensembles de fichiers sur le disque local du serveur, qui sont ensuite récupérables ou diffusables via HTTP.
Client torrent distant auto-hébergé
**Version incluse :** 1.2.23~ynh3
**Version incluse :** 1.2.23
## Captures d'écran
![](https://user-images.githubusercontent.com/1033514/64239393-bdbb6480-cf32-11e9-9269-d8d10e7c0dc7.png)
![](./doc/screenshots/64239393-bdbb6480-cf32-11e9-9269-d8d10e7c0dc7.png)
![](./doc/screenshots/.DS_Store)
## Avertissements / informations importantes
## Configuration
@ -24,34 +30,17 @@ La plupart des éléments peuvent être modifiés à la volée dans Web-UI dans
Vous pouvez configurer Simple Torrent en modifiant le fichier `/var/www/simple-torrent/config.json` en vous aidant de la [documentation](https://github.com/boypt/simple-torrent/wiki/Config-File).
## Documentation
* Documentation officielle : https://github.com/boypt/simple-torrent/wiki
* Documentation YunoHost : https://yunohost.org/fr/app_simple-torrent
## Caractéristiques spécifiques YunoHost
#### Support multi-utilisateur
* L'authentification LDAP est-elle prise en charge ? **Non**
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Non**
#### Architectures supportées
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/simple-torrent.svg)](https://ci-apps.yunohost.org/ci/apps/simple-torrent/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/simple-torrent.svg)](https://ci-apps-arm.yunohost.org/ci/apps/simple-torrent/)
## Limitations
* Désolé, cette application ne peut pas être installée sur une machine ARM 32 bits.
- Cette application ne peut pas être installée sur une machine ARM 32 bits.
## Liens
## Documentations et ressources
* Signaler un bug : https://github.com/YunoHost-Apps/simple-torrent_ynh/issues
* Dépôt de l'application principale : https://github.com/boypt/simple-torrent
* Site web YunoHost : https://yunohost.org/
---
* Site officiel de l'app : https://github.com/boypt/simple-torrent
* Documentation officielle de l'admin : https://github.com/boypt/simple-torrent/wiki
* Dépôt de code officiel de l'app : https://github.com/boypt/simple-torrent
* Documentation YunoHost pour cette app : https://yunohost.org/app_simple-torrent
* Signaler un bug : https://github.com/YunoHost-Apps/simple-torrent_ynh/issues
## Informations pour les développeurs
@ -63,3 +52,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/simple-torrent_ynh/tr
ou
sudo yunohost app upgrade simple-torrent -u https://github.com/YunoHost-Apps/simple-torrent_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

1
check_process
View file

@ -5,7 +5,6 @@
is_public=1
admin="john"
password="pass"
port="4533"
; Checks
pkg_linter=1
setup_sub_dir=1

BIN
doc/.DS_Store vendored Normal file
View file

Binary file not shown.

9
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,9 @@
## Configuration
Most of the items can be edited in Web-UI on the fly in the config board.
You can also configure Simple Torrent by editing this file `/var/www/simple-torrent/config.json` using the [documentation](https://github.com/boypt/simple-torrent/wiki/Config-File).
## Limitations
- This app cannot be installed on a 32-bit ARM machine.

9
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,9 @@
## Configuration
La plupart des éléments peuvent être modifiés à la volée dans Web-UI dans la page de configuration.
Vous pouvez configurer Simple Torrent en modifiant le fichier `/var/www/simple-torrent/config.json` en vous aidant de la [documentation](https://github.com/boypt/simple-torrent/wiki/Config-File).
## Limitations
- Cette application ne peut pas être installée sur une machine ARM 32 bits.

BIN
doc/screenshots/.DS_Store vendored Normal file
View file

Binary file not shown.

BIN
doc/screenshots/64239393-bdbb6480-cf32-11e9-9269-d8d10e7c0dc7.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 44 KiB

8
manifest.json
View file

@ -6,8 +6,14 @@
"en": "Self-hosted remote torrent client",
"fr": "Client torrent distant auto-hébergé"
},
"version": "1.2.23~ynh2",
"version": "1.2.23~ynh3",
"url": "https://github.com/boypt/simple-torrent",
"upstream": {
"license": "AGPL-3.0-only",
"website": "https://github.com/boypt/simple-torrent",
"admindoc": "https://github.com/boypt/simple-torrent/wiki",
"code": "https://github.com/boypt/simple-torrent"
},
"license": "AGPL-3.0-only",
"maintainer": {
"name": "eric_G"

22
scripts/install
View file

@ -93,6 +93,11 @@ pushd "$final_path"
mv $(ynh_detect_arch) $app
popd
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod +x $final_path/$app
#=================================================
# NGINX CONFIGURATION
#=================================================
@ -106,6 +111,9 @@ ynh_add_nginx_config
#=================================================
mkdir -p /home/yunohost.app/$app/{torrents,downloads}
# Set permissions to app files
chown -R $app:www-data /home/yunohost.app/$app
chmod 755 /home/yunohost.app/$app/{torrents,downloads}
#=================================================
# MODIFY A CONFIG FILE
@ -121,20 +129,6 @@ ynh_script_progression --message="Configuring a systemd service..." --weight=1
ynh_add_systemd_config
#=================================================
# GENERIC FINALIZATION
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================
ynh_script_progression --message="Securing files and directories..." --weight=1
# Set permissions to app files
chown -R $app:www-data $final_path
chmod -R o-rwx $final_path
chown -R $app:www-data /home/yunohost.app/$app
chmod +x $final_path/$app
chmod 755 /home/yunohost.app/$app/{torrents,downloads}
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================

30
scripts/restore
View file

@ -55,6 +55,14 @@ ynh_script_progression --message="Configuring firewall..." --weight=3
#ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port
ynh_exec_warn_less yunohost firewall allow Both $peer_port
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
# Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir=$final_path
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
@ -62,6 +70,11 @@ ynh_script_progression --message="Restoring $app main directory..." --weight=4
ynh_restore_file --origin_path="$final_path"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod +x $final_path/$app
#=================================================
# RESTORE DATA
#=================================================
@ -69,24 +82,7 @@ ynh_script_progression --message="Restoring $app data..." --weight=10
ynh_restore_file --origin_path="/home/yunohost.app/$app" --not_mandatory
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
# Create the dedicated user (if not existing)
ynh_system_user_create --username=$app
#=================================================
# RESTORE USER RIGHTS
#=================================================
ynh_script_progression --message="Restoring user rights..."
# Set permissions to app files
chown -R $app:www-data $final_path
chmod -R o-rwx $final_path
chown -R $app:www-data /home/yunohost.app/$app
chmod +x $final_path/$app
chmod 755 /home/yunohost.app/$app/{torrents,downloads}
#=================================================

51
scripts/upgrade
View file

@ -71,6 +71,14 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action=stop --log_path=systemd
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
@ -79,28 +87,19 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Upgrading source files..." --weight=5
tmpdir="$(mktemp -d)"
# Backup the config file in the temp dir
cp -a "$final_path/config.json" "$tmpdir/config.json"
# Remove the app directory securely
ynh_secure_remove --file=$final_path
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir=$final_path --source_id="$architecture"
ynh_setup_source --dest_dir=$final_path --source_id="$architecture" --keep="$final_path/config.json"
pushd "$final_path"
gzip --decompress $(ynh_detect_arch).gz
mv $(ynh_detect_arch) $app
popd
# Copy the admin saved settings from tmp directory to final path
cp -a "$tmpdir/config.json" "$final_path/config.json"
# Remove the tmp directory securely
ynh_secure_remove --file="$tmpdir"
fi
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod +x $final_path/$app
#=================================================
# NGINX CONFIGURATION
#=================================================
@ -115,13 +114,8 @@ ynh_add_nginx_config
mkdir -p /home/yunohost.app/$app/{torrents,downloads}
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app
chown -R $app:www-data /home/yunohost.app/$app
chmod 755 /home/yunohost.app/$app/{torrents,downloads}
#=================================================
# SETUP SYSTEMD
@ -130,19 +124,6 @@ ynh_script_progression --message="Configuring a systemd service..." --weight=2
ynh_add_systemd_config
#=================================================
# GENERIC FINALIZATION
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================
ynh_script_progression --message="Securing files and directories..."
chown -R $app:www-data $final_path
chmod -R o-rwx $final_path
chown -R $app:www-data /home/yunohost.app/$app
chmod +x $final_path/$app
chmod 755 /home/yunohost.app/$app/{torrents,downloads}
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================