diff --git a/README.md b/README.md index b5c01f8..6bf0564 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,46 @@ -# Cjdns for Yunohost + -This is a cjdns app for yunohost. +# Cjdns for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/cjdns.svg)](https://dash.yunohost.org/appci/app/cjdns) ![Working status](https://ci-apps.yunohost.org/ci/badges/cjdns.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/cjdns.maintain.svg) + +[![Install Cjdns with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cjdns) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Cjdns 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 -## cjdns -Networking Reinvented Cjdns implements an encrypted IPv6 network using public-key cryptography for address allocation and a distributed hash table for routing. This provides near-zero-configuration networking, and prevents many of the security and scalability issues that plague existing networks. -https://github.com/cjdelisle/cjdns +**Shipped version:** 22.7~ynh1 -# Setup your website on cjdns network +## Screenshots -1. Install Yunohost by following the detailed instructions provided [here](link-to-instructions). -2. Once the installation is complete, log in as an administrator at `yunohost.local`. Perform a system update, which may take some time. -3. Return to `yunohost.local` after the update and navigate to the Applications menu. Click on Install, search for "wordpress," select it, and proceed with the installation. -4. In the Applications menu, search for "cjdns" and install it. If it does not appear due to not being published yet. You can sideload it by pasting the following URL: `https://github.com/dkoukoul/cjdns_ynh` into the "Install custom app" section. -5. Obtain your cjdns IPv6 address by navigating to Tools -> Logs -> Click on "Install the 'cjdns' app." Your IPv6 address should be displayed in the log. -6. Reboot your Yunohost server to make the tun device available. Navigate to Tools->Shutdown and click Reboot. -7. Navigate to Tools -> Yunohost Settings -> Security, and under NGINX, disable "Force HTTPS." Click Save to apply the changes. -8. Edit `/etc/nginx/conf.d/[your-domain].conf`, add your cjdns-ipv6 to the list of `server_name`. -9. Finally, to allow public access for cjdns requests to your new wordpress site you can do the following: - 1. SSH into your yunohost server - 2. Copy current sso configuration file to persistent: `cp /etc/ssowat/conf.json /etc/ssowat/conf.json.persistent` - 3. Then edit the persistent file: `nano /etc/ssowat/conf.json.persistent` - 4. Change `public` to `true` and add this line under the `wordpress.main uris` section: `"re:^.fc.*"`. Remember to add a trailing “,” to the above entry. For example: +![Screenshot of Cjdns](./doc/screenshots/screenshot.png) -```json -"wordpress.main": { - "auth_header": true, - "label": "WordPress", - "public": true, - "show_tile": true, - "uris": [ - "example.nohost.me/blog", - "re:^.fc.*" - ], - "use_remote_user_var_in_nginx_conf": false, - "users": [] -} -`````` +## Documentation and resources + +* Upstream app code repository: +* YunoHost Store: +* Report a bug: + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cjdns_ynh/tree/testing). + +To try the testing branch, please proceed like that. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/cjdns_ynh/tree/testing --debug +or +sudo yunohost app upgrade cjdns -u https://github.com/YunoHost-Apps/cjdns_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..a33f5f2 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,45 @@ + + +# Cjdns pour YunoHost + +[![Niveau d’intégration](https://dash.yunohost.org/integration/cjdns.svg)](https://dash.yunohost.org/appci/app/cjdns) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/cjdns.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/cjdns.maintain.svg) + +[![Installer Cjdns avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cjdns) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d’installer Cjdns rapidement et simplement sur un serveur YunoHost. +Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* + +## Vue d’ensemble + +Cjdns implémente un réseau IPv6 crypté utilisant une cryptographie à clé publique pour l'attribution des adresses et une table de hachage distribuée pour le routage. Cela fournit une configuration réseau proche de zéro et évite de nombreux problèmes de sécurité et d'évolutivité qui affectent les réseaux existants. + +**Version incluse :** 22.7~ynh1 + +## Captures d’écran + +![Capture d’écran de Cjdns](./doc/screenshots/screenshot.png) + +## Documentations et ressources + +* Dépôt de code officiel de l’app : +* YunoHost Store: +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/cjdns_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/cjdns_ynh/tree/testing --debug +ou +sudo yunohost app upgrade cjdns -u https://github.com/YunoHost-Apps/cjdns_ynh/tree/testing --debug +``` + +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file diff --git a/doc/Admin.md b/doc/Admin.md new file mode 100644 index 0000000..4acfc9c --- /dev/null +++ b/doc/Admin.md @@ -0,0 +1,30 @@ +# Setup your website on cjdns network + +1. Install Yunohost by following the detailed instructions provided [here](link-to-instructions). +2. Once the installation is complete, log in as an administrator at `yunohost.local`. Perform a system update, which may take some time. +3. Return to `yunohost.local` after the update and navigate to the Applications menu. Click on Install, search for "wordpress," select it, and proceed with the installation. +4. In the Applications menu, search for "cjdns" and install it. If it does not appear due to not being published yet. You can sideload it by pasting the following URL: `https://github.com/dkoukoul/cjdns_ynh` into the "Install custom app" section. +5. Obtain your cjdns IPv6 address by navigating to Tools -> Logs -> Click on "Install the 'cjdns' app." Your IPv6 address should be displayed in the log. +6. Reboot your Yunohost server to make the tun device available. Navigate to Tools->Shutdown and click Reboot. +7. Navigate to Tools -> Yunohost Settings -> Security, and under NGINX, disable "Force HTTPS." Click Save to apply the changes. +8. Edit `/etc/nginx/conf.d/[your-domain].conf`, add your cjdns-ipv6 to the list of `server_name`. +9. Finally, to allow public access for cjdns requests to your new wordpress site you can do the following: + 1. SSH into your yunohost server + 2. Copy current sso configuration file to persistent: `cp /etc/ssowat/conf.json /etc/ssowat/conf.json.persistent` + 3. Then edit the persistent file: `nano /etc/ssowat/conf.json.persistent` + 4. Change `public` to `true` and add this line under the `wordpress.main uris` section: `"re:^.fc.*"`. Remember to add a trailing “,” to the above entry. For example: + +```json +"wordpress.main": { + "auth_header": true, + "label": "WordPress", + "public": true, + "show_tile": true, + "uris": [ + "example.nohost.me/blog", + "re:^.fc.*" + ], + "use_remote_user_var_in_nginx_conf": false, + "users": [] +} +`````` diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 9cc83d6..e0a2575 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,5 +1 @@ -Networking Reinvented - Cjdns implements an encrypted IPv6 network using public-key cryptography for address allocation and a distributed hash table for routing. This provides near-zero-configuration networking, and prevents many of the security and scalability issues that plague existing networks. - -https://github.com/cjdelisle/cjdns/ \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..96ee2f0 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1 @@ +Cjdns implémente un réseau IPv6 crypté utilisant une cryptographie à clé publique pour l'attribution des adresses et une table de hachage distribuée pour le routage. Cela fournit une configuration réseau proche de zéro et évite de nombreux problèmes de sécurité et d'évolutivité qui affectent les réseaux existants. \ No newline at end of file diff --git a/manifest.toml b/manifest.toml index 1c5388a..24601a2 100644 --- a/manifest.toml +++ b/manifest.toml @@ -2,21 +2,27 @@ packaging_format = 2 id = "cjdns" name = "Cjdns" -description = "Cjdns encrypted IPv6 network" -version = "22.7" + +description.en = "Encrypted IPv6 network" +description.fr = "Réseau IPv6 chiffré" + +version = "22.7~ynh1" + maintainers = ["dkoukoul"] [upstream] license = "GPL-3.0" -website = "https://github.com/cjdelisle/cjdns/" code = "https://github.com/cjdelisle/cjdns/" [integration] -yunohost = ">= 11.1.21" +yunohost = ">= 11.2" architectures = ["amd64","arm64"] multi_instance = false + ldap = false + sso = false + disk = "50M" ram.build = "50M" ram.runtime = "50M" diff --git a/scripts/install b/scripts/install index 781f468..cd4ee5c 100755 --- a/scripts/install +++ b/scripts/install @@ -79,6 +79,7 @@ ynh_add_systemd_config # Use logrotate to manage application logfile(s) ynh_use_logrotate + #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= @@ -96,6 +97,7 @@ ynh_script_progression --message="Launching cjdns service..." --weight=1 # Start a systemd service ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" ynh_script_progression --message="Your cjdns IPv6: $cjdns_ipv6" --weight=1 + #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 9d93abc..f6ffecb 100755 --- a/scripts/remove +++ b/scripts/remove @@ -17,8 +17,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 -# This should be a symetric version of what happens in the install script - # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) if ynh_exec_warn_less yunohost service status $app >/dev/null then @@ -38,6 +36,7 @@ killall cjdroute # Remove other various files specific to the app... such as : ynh_secure_remove --file="/var/log/$app" ynh_secure_remove --file="$install_dir" + #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..91daf17 --- /dev/null +++ b/tests.toml @@ -0,0 +1,7 @@ +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------ \ No newline at end of file