diff --git a/README.md b/README.md index 90a6f94..0bd533b 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,55 @@ + + +--- + + + # Movim for YunoHost -[![Integration level](https://dash.yunohost.org/integration/movim.svg)](https://dash.yunohost.org/appci/app/movim) ![](https://ci-apps.yunohost.org/ci/badges/movim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/movim.maintain.svg) -[![Install Movim with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=movim) +[![Integration level](https://dash.yunohost.org/integration/movim.svg)](https://dash.yunohost.org/appci/app/movim) ![](https://ci-apps.yunohost.org/ci/badges/movim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/movim.maintain.svg) +[![Install movim with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=movim) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Movim quickly and simply on a YunoHost server. +> *This package allows you to install movim 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 -[Movim](https://movim.eu) is a decentralized social network, written in PHP and HTML5 and based on the XMPP standard protocol. +Web-based cross-platform XMPP client + +**Shipped version:** 0.19~ynh2 + +**Demo:** https://nl.movim.eu/?login -**Shipped version:** 0.19 ## Screenshots -![](https://camo.githubusercontent.com/1392d5eb8cd2824d7eb121424392e82f9393a5ad/68747470733a2f2f6d6f76696d2e65752f696d672f686f6d652e706e67) -## Demo + ![](./doc/screenshots/movim.png) -* [Official demo](https://nl.movim.eu/?login) + + + +## Disclaimers / important information ## Configuration * How to configure this app: From an admin panel at this address https://example.com/movim/?admin. Username and password are defined during installation. -## Documentation - * Official documentation: https://github.com/movim/movim/wiki - * YunoHost documentation: If specific documentation is needed, feel free to contribute. -## YunoHost specific features +## Documentation and resources -#### Multi-user support +* Official app website: https://movim.eu -* Are LDAP and HTTP auth supported? **No** -* Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/movim.svg)](https://ci-apps.yunohost.org/ci/apps/movim/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/movim.svg)](https://ci-apps-arm.yunohost.org/ci/apps/movim/) - -## Limitations - -* Any known limitations. - -## Additional information - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/movim_ynh/issues - * App website: https://movim.eu/ - * Upstream app repository: https://github.com/movim/movim - * YunoHost website: https://yunohost.org/ - ---- +* Official admin documentation: https://github.com/movim/movim/wiki +* Upstream app code repository: https://github.com/movim/movim +* YunoHost documentation for this app: https://yunohost.org/app_movim +* Report a bug: https://github.com/YunoHost-Apps/movim_ynh/issues ## Developer info @@ -68,3 +61,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/movim_ynh/tree/testin or sudo yunohost app upgrade movim -u https://github.com/YunoHost-Apps/movim_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index a6f45d7..f3f7d89 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,70 +1,57 @@ # Movim pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/movim.svg)](https://dash.yunohost.org/appci/app/movim) ![](https://ci-apps.yunohost.org/ci/badges/movim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/movim.maintain.svg) -[![Installer Movim avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=movim) +[![Niveau d'intégration](https://dash.yunohost.org/integration/movim.svg)](https://dash.yunohost.org/appci/app/movim) ![](https://ci-apps.yunohost.org/ci/badges/movim.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/movim.maintain.svg) +[![Installer movim avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=movim) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Movim 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.* +> *This package allows you to install movim 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.* ## Vue d'ensemble -[Movim](https://movim.eu) est un réseau social décentralisé, écrit en PHP et HTML5 et basé sur le protocole standard XMPP. +Client XMPP multiplateforme basé sur le Web + +**Version incluse:** 0.19~ynh2 + +**Démo:** https://nl.movim.eu/?login -**Version incluse :** 0.19 ## Captures d'écran -![](https://camo.githubusercontent.com/1392d5eb8cd2824d7eb121424392e82f9393a5ad/68747470733a2f2f6d6f76696d2e65752f696d672f686f6d652e706e67) -## Démo + ![](./doc/screenshots/movim.png) - * [Démo officielle](https://nl.movim.eu/?login) + + + +## Avertissements / informations importantes ## Configuration * Comment configurer cette application : via le panneau d'administration a cette adresse https://example.com/movim/?admin. Le nom d'utilisateur et le mot de passe sont définis lors de l'installation. -## Documentation - * Documentation officielle : https://github.com/movim/movim/wiki - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. -## Caractéristiques spécifiques YunoHost +## Documentations et ressources -#### Support multi-utilisateur +* Site official de l'app : https://movim.eu -* L'authentification LDAP et HTTP est-elle prise en charge ? **No** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** +* Documentation officielle de l'admin: https://github.com/movim/movim/wiki +* Dépôt de code officiel de l'app: https://github.com/movim/movim +* Documentation YunoHost pour cette app: https://yunohost.org/app_movim +* Signaler un bug: https://github.com/YunoHost-Apps/movim_ynh/issues -#### Architectures supportées +## Informations pour les développeurs -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/movim.svg)](https://ci-apps.yunohost.org/ci/apps/movim/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/movim.svg)](https://ci-apps-arm.yunohost.org/ci/apps/movim/) +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/movim_ynh/tree/testing). -## Limitations - -* Limitations connues. - -## Informations additionnelles - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/movim_ynh/issues - * Site de l'application : https://movim.eu/ - * Dépôt de l'application principale : https://github.com/movim/movim - * Site web YunoHost : https://yunohost.org/ - ---- - -## Developer info - -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/movim_ynh/tree/testing). - -To try the testing branch, please proceed like that. +Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/movim_ynh/tree/testing --debug or sudo yunohost app upgrade movim -u https://github.com/YunoHost-Apps/movim_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index 48e476b..db18f0c 100644 --- a/check_process +++ b/check_process @@ -1,6 +1,3 @@ -# See here for more informations -# https://github.com/YunoHost/package_check#syntax-check_process-file - ;; Test complet ; Manifest domain="domain.tld" @@ -9,7 +6,6 @@ is_public=1 password="phrasedepasse" language="fr" - port=9537 (PORT) ; Checks pkg_linter=1 setup_sub_dir=1 @@ -28,4 +24,4 @@ Notification=none ;;; Upgrade options ; commit=80bdea70f80aafef673718911ad492ddc54aab5c name=Testing (#23) - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=phrasedepasse&port=9537& + manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=phrasedepasse& diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index aded581..56ebb88 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,12 +1,3 @@ -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... +## Configuration -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? + * How to configure this app: From an admin panel at this address https://example.com/movim/?admin. Username and password are defined during installation. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..85e6091 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,3 @@ +## Configuration + + * Comment configurer cette application : via le panneau d'administration a cette adresse https://example.com/movim/?admin. Le nom d'utilisateur et le mot de passe sont définis lors de l'installation. diff --git a/doc/screenshots/movim.png b/doc/screenshots/movim.png new file mode 100644 index 0000000..e7fab07 Binary files /dev/null and b/doc/screenshots/movim.png differ diff --git a/manifest.json b/manifest.json index 1e88f64..432a3b8 100644 --- a/manifest.json +++ b/manifest.json @@ -8,6 +8,13 @@ }, "version": "0.19~ynh2", "url": "https://movim.eu", + "upstream": { + "license": "AGPL-3.0-or-later", + "website": "https://movim.eu", + "demo": "https://nl.movim.eu/?login", + "admindoc": "https://github.com/movim/movim/wiki", + "code": "https://github.com/movim/movim" + }, "license": "AGPL-3.0-or-later", "maintainer": { "name": "", diff --git a/scripts/install b/scripts/install index 800974c..bbb33a0 100644 --- a/scripts/install +++ b/scripts/install @@ -68,6 +68,14 @@ ynh_script_progression --message="Installing dependencies..." --weight=1 # Install packages ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Configuring system user..." --weight=3 + +# Create a system user +ynh_system_user_create --username=$app --home_dir="$final_path" + #================================================= # CREATE A POSTGRESQL DATABASE #================================================= @@ -91,6 +99,10 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$final_path" +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + #================================================= # NGINX CONFIGURATION #================================================= @@ -99,14 +111,6 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=11 # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=3 - -# Create a system user -ynh_system_user_create --username=$app - #================================================= # PHP-FPM CONFIGURATION #================================================= @@ -125,7 +129,8 @@ ynh_script_progression --message="Modifying a config file..." --weight=1 ynh_add_config --template="../conf/db.example.inc.php" --destination="$final_path/config/db.inc.php" -ynh_store_file_checksum --file="$final_path/config/db.inc.php" +chmod 400 "$final_path/config/db.inc.php" +chown $app:$app "$final_path/config/db.inc.php" #================================================= # Install PHP dependencies using composer @@ -156,16 +161,6 @@ pushd $final_path php$phpversion daemon.php config --username=$admin --password=$password --quiet popd -#================================================= -# GENERIC FINALIZATION -#================================================= -# SET PERMISSIONS -#================================================= - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= diff --git a/scripts/restore b/scripts/restore index a560845..19a43b7 100644 --- a/scripts/restore +++ b/scripts/restore @@ -53,6 +53,14 @@ test ! -d $final_path \ 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 + +# Create the dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir="$final_path" + #================================================= # RESTORE THE APP MAIN DIR #================================================= @@ -60,19 +68,6 @@ ynh_script_progression --message="Restoring Movim main directory..." --weight=1 ynh_restore_file --origin_path="$final_path" -#================================================= -# 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 -#================================================= - -# Restore permissions on app files chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" diff --git a/scripts/upgrade b/scripts/upgrade index b7f748c..33de1a1 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -79,6 +79,14 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=23 ynh_systemd_action --service_name=$app --action=stop --log_path="/var/log/$app/$app.log" +#================================================= +# 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 #================================================= @@ -91,6 +99,10 @@ then ynh_setup_source --dest_dir="$final_path" fi +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + #================================================= # NGINX CONFIGURATION #================================================= @@ -106,14 +118,6 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=4 ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=7 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app - #================================================= # PHP-FPM CONFIGURATION #================================================= @@ -124,14 +128,6 @@ ynh_replace_string --match_string="__TIMEZONE__" --replace_string="$timezone" -- ynh_add_fpm_config --package="$extra_php_dependencies" -#================================================= -# SET PERMISSIONS -#================================================= - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - #================================================= # INTEGRATE SERVICE IN YUNOHOST #=================================================