mirror of
https://github.com/YunoHost-Apps/armadietto_ynh.git
synced 2024-09-03 18:06:18 +02:00
update doc, check_process & fix typo
This commit is contained in:
bencharp
parent
8114dc8d77
commit
64220b732e
11 changed files with 69 additions and 82 deletions
39
README.md
39
README.md
|
|
@ -15,7 +15,6 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
## Overview
|
||||
|
||||
## Armadietto overview
|
||||
|
||||
[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js.
|
||||
|
||||
|
|
@ -39,7 +38,7 @@ Armadietto is maintained by remoteStorage Team [IRC](https://kiwiirc.com/client/
|
|||
- liste des caractéristiques...
|
||||
|
||||
|
||||
**Shipped version:** 0.0.2-beta.10~ynh4
|
||||
**Shipped version:** 0.0.2~ynh6
|
||||
|
||||
|
||||
|
||||
|
|
@ -49,33 +48,31 @@ Armadietto is maintained by remoteStorage Team [IRC](https://kiwiirc.com/client/
|
|||
|
||||
## Disclaimers / important information
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
### :warning: WARNING
|
||||
Armadietto_ynh still in develoment:
|
||||
|
||||
* The upgrade process is not yet operational
|
||||
* Single sign-on or LDAP integration not working?
|
||||
* Security considerations from [Armadietto](https://github.com/remotestorage/armadietto/) :
|
||||
|
||||
> Storage security
|
||||
|
||||
>### **Storage security**
|
||||
>
|
||||
> In production, we recommend that you restrict access to the files managed by your armadietto server as much as possible. This is particularly true if you host your storage on a machine with other web applications; you need to protect your files in the event that one of those apps is exploited.
|
||||
>
|
||||
> You should take these steps to keep your storage safe:
|
||||
>
|
||||
> Pick a unique Unix user to run your server process; no other process on the box should run as this user: sudo useradd armadietto --system --no-create-home
|
||||
>
|
||||
> Do not run other applications as root, or as any user that could access files owned by your armadietto user
|
||||
>
|
||||
> Make sure the directory path/to/storage cannot be read, written or executed by anyone but this user: sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
>
|
||||
> Do not run armadietto as root; if you need to bind to port 80 or 443 use a reverse proxy like nginx, Apache2, caddy, lighttpd or enable bind capability: setcap 'cap_net_bind_service=+ep' `which armadietto`
|
||||
>
|
||||
> Ideally, run your storage inside a container or on a dedicated machine
|
||||
>In production, we recommend that you restrict access to the files managed by your armadietto server as much as possible. This is particularly true if you host your storage on a machine with other web applications; you need to protect your files in the event that one of those apps is exploited.
|
||||
>
|
||||
>You should take these steps to keep your storage safe:
|
||||
>
|
||||
> - Pick a unique Unix user to run your server process; no other process on the box should run as this user: sudo useradd armadietto --system --no-create-home
|
||||
>
|
||||
> - Do not run other applications as root, or as any user that could access files owned by your armadietto user
|
||||
>
|
||||
> - Make sure the directory path/to/storage cannot be read, written or executed by anyone but this user: sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
>
|
||||
> - Do not run armadietto as root; if you need to bind to port 80 or 443 use a reverse proxy like nginx, Apache2, caddy, lighttpd or enable bind capability: setcap 'cap_net_bind_service=+ep' `which armadietto`
|
||||
>
|
||||
> - Ideally, run your storage inside a container or on a dedicated machine
|
||||
|
||||
<br />
|
||||
|
||||
### Important Notes
|
||||
### **Important Notes**
|
||||
|
||||
- RemoteStorage requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**.
|
||||
- As RemoteStorage uses the full domain and is installed on the root, you can create a subdomain such as remote.domain.tld.
|
||||
|
|
|
|||
26
README_fr.md
26
README_fr.md
|
|
@ -11,7 +11,6 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
|
||||
## Vue d'ensemble
|
||||
|
||||
## Aperçu d'Armadietto
|
||||
|
||||
[Armadietto](https://github.com/remotestorage/armadietto/) est un serveur [remoteStorage](https://remotestorage.io) écrit pour Node.js.
|
||||
|
||||
|
|
@ -30,7 +29,7 @@ Armadietto est maintenu par l'équipe remoteStorage [IRC](https://kiwiirc.com/cl
|
|||
|
||||
[Cliquez ici](https://remotestorage.io/apps/) pour voir la liste des applications qui peuvent être utilisées avec RemoteStorage.
|
||||
|
||||
**Version incluse :** 0.0.2-beta.10~ynh4
|
||||
**Version incluse :** 0.0.2~ynh6
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,33 +39,32 @@ Armadietto est maintenu par l'équipe remoteStorage [IRC](https://kiwiirc.com/cl
|
|||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
### :warning: WARNING
|
||||
Armadietto_ynh still in develoment:
|
||||
* le processus de mise à niveau n'est pas encore opérationnel
|
||||
|
||||
* l'authentification unique ou l'intégration LDAP ne fonctionne pas ?
|
||||
* Considérations sur la sécurité de [Armadietto](https://github.com/remotestorage/armadietto/) :
|
||||
|
||||
> Sécurité du stockage
|
||||
>
|
||||
|
||||
> ### **Sécurité du stockage**
|
||||
>
|
||||
> En production, nous vous recommandons de restreindre autant que possible l'accès aux fichiers gérés par votre serveur armadietto. Ceci est particulièrement vrai si vous hébergez votre stockage sur une machine avec d'autres applications web ; vous devez protéger vos fichiers dans le cas où l'une de ces applications serait exploitée.
|
||||
>
|
||||
> Vous devez prendre les mesures suivantes pour assurer la sécurité de votre stockage :
|
||||
>
|
||||
> Choisissez un utilisateur Unix unique pour exécuter votre processus serveur ; aucun autre processus sur la machine ne doit être exécuté sous cet utilisateur : sudo useradd armadietto --system --no-create-home
|
||||
> - Choisissez un utilisateur Unix unique pour exécuter votre processus serveur ; aucun autre processus sur la machine ne doit être exécuté sous cet utilisateur : sudo useradd armadietto --system --no-create-home
|
||||
>
|
||||
> Ne lancez pas d'autres applications en tant que root, ou en tant qu'utilisateur qui pourrait accéder à des fichiers appartenant à votre utilisateur armadietto.
|
||||
> - Ne lancez pas d'autres applications en tant que root, ou en tant qu'utilisateur qui pourrait accéder à des fichiers appartenant à votre utilisateur armadietto.
|
||||
>
|
||||
> Assurez-vous que le répertoire path/to/storage ne peut être lu, écrit ou exécuté par personne d'autre que cet utilisateur : sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
> - Assurez-vous que le répertoire path/to/storage ne peut être lu, écrit ou exécuté par personne d'autre que cet utilisateur : sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
>
|
||||
> Ne lancez pas armadietto en tant que root ; si vous avez besoin de vous lier au port 80 ou 443, utilisez un reverse proxy comme nginx, Apache2, caddy, lighttpd ou activez la capacité de liaison : setcap 'cap_net_bind_service=+ep' `which armadietto`.
|
||||
> - Ne lancez pas armadietto en tant que root ; si vous avez besoin de vous lier au port 80 ou 443, utilisez un reverse proxy comme nginx, Apache2, caddy, lighttpd ou activez la capacité de liaison : setcap 'cap_net_bind_service=+ep' `which armadietto`.
|
||||
>
|
||||
> Idéalement, exécutez votre stockage dans un conteneur ou sur une machine dédiée.
|
||||
> - Idéalement, exécutez votre stockage dans un conteneur ou sur une machine dédiée.
|
||||
|
||||
Traduit avec www.DeepL.com/Translator (version gratuite)
|
||||
<br />
|
||||
|
||||
### Notes importantes
|
||||
### **Notes importantes**
|
||||
|
||||
- RemoteStorage nécessite un domaine dédié, il faut donc en obtenir un et l'ajouter en utilisant le panneau d'administration de YunoHost. **Domaines -> Ajouter un domaine**.
|
||||
- Comme RemoteStorage utilise le domaine complet et est installé à la racine, vous pouvez créer un sous-domaine tel que remote.domain.tld.
|
||||
|
|
|
|||
|
|
@ -16,20 +16,20 @@
|
|||
pkg_linter=1
|
||||
setup_sub_dir=0
|
||||
setup_root=1
|
||||
setup_nourl=1
|
||||
setup_nourl=0
|
||||
setup_private=1
|
||||
setup_public=1
|
||||
upgrade=1
|
||||
# 0.0.2-beta.10~ynh1
|
||||
upgrade=1 from_commit=27894600799b8b04f71e7ec219798e34512e51b0
|
||||
# 0.0.2~ynh5
|
||||
upgrade=1 from_commit=d185b84698a9f7e83eff6bf6dd5606f35282a536
|
||||
backup_restore=1
|
||||
multi_instance=0
|
||||
port_already_use=1
|
||||
port_already_use=0
|
||||
change_url=1
|
||||
;;; Options
|
||||
Email=
|
||||
Notification=none
|
||||
;;; Upgrade options
|
||||
; commit=27894600799b8b04f71e7ec219798e34512e51b0
|
||||
name= Upgrade to version 0.0.2-beta.10~ynh1
|
||||
; commit=d185b84698a9f7e83eff6bf6dd5606f35282a536
|
||||
name= Upgrade to version 0.0.2~ynh6
|
||||
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&is_signup=true&port=8008&
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
## Armadietto overview
|
||||
|
||||
[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
## Aperçu d'Armadietto
|
||||
|
||||
[Armadietto](https://github.com/remotestorage/armadietto/) est un serveur [remoteStorage](https://remotestorage.io) écrit pour Node.js.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,30 +1,28 @@
|
|||
## Disclaimers / important information
|
||||
|
||||
### :warning: WARNING
|
||||
Armadietto_ynh still in develoment:
|
||||
|
||||
* The upgrade process is not yet operational
|
||||
* Single sign-on or LDAP integration not working?
|
||||
* Security considerations from [Armadietto](https://github.com/remotestorage/armadietto/) :
|
||||
|
||||
> Storage security
|
||||
|
||||
>### **Storage security**
|
||||
>
|
||||
> In production, we recommend that you restrict access to the files managed by your armadietto server as much as possible. This is particularly true if you host your storage on a machine with other web applications; you need to protect your files in the event that one of those apps is exploited.
|
||||
>
|
||||
> You should take these steps to keep your storage safe:
|
||||
>
|
||||
> Pick a unique Unix user to run your server process; no other process on the box should run as this user: sudo useradd armadietto --system --no-create-home
|
||||
>
|
||||
> Do not run other applications as root, or as any user that could access files owned by your armadietto user
|
||||
>
|
||||
> Make sure the directory path/to/storage cannot be read, written or executed by anyone but this user: sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
>
|
||||
> Do not run armadietto as root; if you need to bind to port 80 or 443 use a reverse proxy like nginx, Apache2, caddy, lighttpd or enable bind capability: setcap 'cap_net_bind_service=+ep' `which armadietto`
|
||||
>
|
||||
> Ideally, run your storage inside a container or on a dedicated machine
|
||||
>In production, we recommend that you restrict access to the files managed by your armadietto server as much as possible. This is particularly true if you host your storage on a machine with other web applications; you need to protect your files in the event that one of those apps is exploited.
|
||||
>
|
||||
>You should take these steps to keep your storage safe:
|
||||
>
|
||||
> - Pick a unique Unix user to run your server process; no other process on the box should run as this user: sudo useradd armadietto --system --no-create-home
|
||||
>
|
||||
> - Do not run other applications as root, or as any user that could access files owned by your armadietto user
|
||||
>
|
||||
> - Make sure the directory path/to/storage cannot be read, written or executed by anyone but this user: sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
>
|
||||
> - Do not run armadietto as root; if you need to bind to port 80 or 443 use a reverse proxy like nginx, Apache2, caddy, lighttpd or enable bind capability: setcap 'cap_net_bind_service=+ep' `which armadietto`
|
||||
>
|
||||
> - Ideally, run your storage inside a container or on a dedicated machine
|
||||
|
||||
<br />
|
||||
|
||||
### Important Notes
|
||||
### **Important Notes**
|
||||
|
||||
- RemoteStorage requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**.
|
||||
- As RemoteStorage uses the full domain and is installed on the root, you can create a subdomain such as remote.domain.tld.
|
||||
|
|
|
|||
|
|
@ -1,30 +1,29 @@
|
|||
## Avertissements / informations importantes
|
||||
|
||||
### :warning: WARNING
|
||||
Armadietto_ynh still in develoment:
|
||||
* le processus de mise à niveau n'est pas encore opérationnel
|
||||
|
||||
* l'authentification unique ou l'intégration LDAP ne fonctionne pas ?
|
||||
* Considérations sur la sécurité de [Armadietto](https://github.com/remotestorage/armadietto/) :
|
||||
|
||||
> Sécurité du stockage
|
||||
>
|
||||
|
||||
> ### **Sécurité du stockage**
|
||||
>
|
||||
> En production, nous vous recommandons de restreindre autant que possible l'accès aux fichiers gérés par votre serveur armadietto. Ceci est particulièrement vrai si vous hébergez votre stockage sur une machine avec d'autres applications web ; vous devez protéger vos fichiers dans le cas où l'une de ces applications serait exploitée.
|
||||
>
|
||||
> Vous devez prendre les mesures suivantes pour assurer la sécurité de votre stockage :
|
||||
>
|
||||
> Choisissez un utilisateur Unix unique pour exécuter votre processus serveur ; aucun autre processus sur la machine ne doit être exécuté sous cet utilisateur : sudo useradd armadietto --system --no-create-home
|
||||
> - Choisissez un utilisateur Unix unique pour exécuter votre processus serveur ; aucun autre processus sur la machine ne doit être exécuté sous cet utilisateur : sudo useradd armadietto --system --no-create-home
|
||||
>
|
||||
> Ne lancez pas d'autres applications en tant que root, ou en tant qu'utilisateur qui pourrait accéder à des fichiers appartenant à votre utilisateur armadietto.
|
||||
> - Ne lancez pas d'autres applications en tant que root, ou en tant qu'utilisateur qui pourrait accéder à des fichiers appartenant à votre utilisateur armadietto.
|
||||
>
|
||||
> Assurez-vous que le répertoire path/to/storage ne peut être lu, écrit ou exécuté par personne d'autre que cet utilisateur : sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
> - Assurez-vous que le répertoire path/to/storage ne peut être lu, écrit ou exécuté par personne d'autre que cet utilisateur : sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
|
||||
>
|
||||
> Ne lancez pas armadietto en tant que root ; si vous avez besoin de vous lier au port 80 ou 443, utilisez un reverse proxy comme nginx, Apache2, caddy, lighttpd ou activez la capacité de liaison : setcap 'cap_net_bind_service=+ep' `which armadietto`.
|
||||
> - Ne lancez pas armadietto en tant que root ; si vous avez besoin de vous lier au port 80 ou 443, utilisez un reverse proxy comme nginx, Apache2, caddy, lighttpd ou activez la capacité de liaison : setcap 'cap_net_bind_service=+ep' `which armadietto`.
|
||||
>
|
||||
> Idéalement, exécutez votre stockage dans un conteneur ou sur une machine dédiée.
|
||||
> - Idéalement, exécutez votre stockage dans un conteneur ou sur une machine dédiée.
|
||||
|
||||
Traduit avec www.DeepL.com/Translator (version gratuite)
|
||||
<br />
|
||||
|
||||
### Notes importantes
|
||||
### **Notes importantes**
|
||||
|
||||
- RemoteStorage nécessite un domaine dédié, il faut donc en obtenir un et l'ajouter en utilisant le panneau d'administration de YunoHost. **Domaines -> Ajouter un domaine**.
|
||||
- Comme RemoteStorage utilise le domaine complet et est installé à la racine, vous pouvez créer un sous-domaine tel que remote.domain.tld.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
"en": "A remoteStorage server written for Node.js.",
|
||||
"fr": "Un serveur remoteStorage écrit pour node.js."
|
||||
},
|
||||
"version": "0.0.2-beta.10~ynh4",
|
||||
"version": "0.0.2~ynh6",
|
||||
"url": "https://github.com/remotestorage/armadietto",
|
||||
"upstream": {
|
||||
"license": "MIT",
|
||||
|
|
|
|||
|
|
@ -49,6 +49,7 @@ ynh_backup --src_path="$final_path"
|
|||
|
||||
ynh_backup --src_path="$datadir"
|
||||
|
||||
#=================================================
|
||||
# BACKUP THE ARMADIETTO SERVER
|
||||
#=================================================
|
||||
|
||||
|
|
|
|||
|
|
@ -40,6 +40,7 @@ datadir="/home/yunohost.app/${app}/storage"
|
|||
ynh_script_progression --message="Validating installation parameters..." --weight=2
|
||||
|
||||
final_path=/opt/yunohost/$app
|
||||
|
||||
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
|
||||
|
||||
# Only on / directory
|
||||
|
|
@ -86,8 +87,6 @@ ynh_use_nodejs
|
|||
ynh_script_progression --message="Setting up and create final app path..." --weight=1
|
||||
|
||||
ynh_app_setting_set $app final_path $final_path
|
||||
# Download, check integrity, uncompress and patch the source from app.src
|
||||
# ynh_setup_source --dest_dir="$final_path"
|
||||
|
||||
# Create final_path
|
||||
mkdir -p "$final_path"
|
||||
|
|
@ -97,8 +96,6 @@ mkdir -p "$final_path"
|
|||
#=================================================
|
||||
ynh_script_progression --message="Configuring NGINX web server..." --weight=2
|
||||
|
||||
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
||||
|
||||
# Create a dedicated NGINX config
|
||||
ynh_add_nginx_config
|
||||
|
||||
|
|
|
|||
|
|
@ -38,8 +38,7 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
|||
#=================================================
|
||||
ynh_script_progression --message="Validating restoration parameters..." --weight=1
|
||||
|
||||
test ! -d $final_path \
|
||||
|| ynh_die --message="There is already a directory: $final_path "
|
||||
test ! -d "$final_path" || ynh_die --message="There is already a directory: $final_path "
|
||||
|
||||
#=================================================
|
||||
# REINSTALL DEPENDENCIES
|
||||
|
|
@ -61,7 +60,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
|
|||
#=================================================
|
||||
# RECREATE THE DEDICATED USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Recreating the dedicated system user..." ---weight=1
|
||||
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
|
||||
|
||||
# Create the dedicated user (if not existing)
|
||||
ynh_system_user_create --username=$app
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue