diff --git a/README.md b/README.md index b5c01f8..9d87227 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,50 @@ -# 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 +https://github.com/cjdelisle/cjdns/ +**Shipped version:** 22.7 -# 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 + +* Official app website: +* 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..25ea495 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,50 @@ + + +# 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 + +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/ + +**Version incluse :** 22.7 + +## Captures d’écran + +![Capture d’écran de Cjdns](./doc/screenshots/screenshot.png) + +## Documentations et ressources + +* Site officiel de l’app : +* 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