From 728e399740ffd804fa95f83d492706987d8aaa67 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Thu, 19 Aug 2021 10:02:02 +0000 Subject: [PATCH] Auto-update README --- README.md | 65 ++++++++++++++++++++++++++++++++-------------------- README_fr.md | 54 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+), 25 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index c7e5b9c..9be9d80 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,69 @@ -# ArchiveBox Yunohost Package +# Packaging your an app, starting from this example -[![Integration level](https://dash.yunohost.org/integration/archivebox.svg)](https://dash.yunohost.org/appci/app/archivebox) ![](https://ci-apps.yunohost.org/ci/badges/archivebox.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/archivebox.maintain.svg) -[![Install archivebox with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=archivebox) +- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo. +- Edit the `manifest.json` with app specific info. +- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. + - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers) +- Add a `LICENSE` file for the package. +- Edit `doc/DISCLAIMER*.md` +- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator +--- + -> *This package allows you to install archivebox quickly and simply on a YunoHost server. +# ArchiveBox for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) +[![Install ArchiveBox with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install ArchiveBox 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 -[ArchiveBox](https://archivebox.io/) is a powerful, self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline. +ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline. **Shipped version:** 1.0~ynh1 -**Demo:** https://archivebox.commoninternet.net - -# Important Points To Read Before Installing - -1. ArchiveBox require a dedicated domain with no subpath to work, eg. yourdomain.tld or archivebox.yourdomain.tld +**Demo:** https://archivebox.io/ ## Screenshots +![](./doc/screenshots/screenshot_archivebox1.png) - ![](./doc/screenshots/screenshot_archivebox1.png) - - -## Disclaimers +## Disclaimers / important information +* Any known limitations, constrains or stuff not working, such as (but not limited to): * required to be run at the base path / , subpaths not yet supported * currently only tested on amd64 - * haven't yet implemented single-sign on or LDAP integration - + * haven't yet implemented single-sign or LDAP integration + +* Other infos that people should be aware of, such as: + * nothing comes to mind + ## Documentation and resources -* Official app website: https://archivebox.io +* Official app website: https://archivebox.io/ * Official user documentation: https://yunohost.org/apps * Official admin documentation: https://yunohost.org/packaging_apps -* Upstream app code repository: https://github.com/ArchiveBox/ArchiveBox -* YunoHost documentation for this app: https://yunohost.org/app_archivebox -* Report a bug: https://github.com/YunoHost-Apps/archivebox_ynh/issues +* Upstream app code repository: https://github.com/ArchiveBox/ArchiveBox +* YunoHost documentation for this app: https://yunohost.org/app_example +* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). -To try the testing branch, please proceed like this: +To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug or -sudo yunohost app upgrade archivebox -u https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing --debug +sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps +**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 new file mode 100644 index 0000000..f1928de --- /dev/null +++ b/README_fr.md @@ -0,0 +1,54 @@ +# ArchiveBox pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) +[![Installer ArchiveBox avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer ArchiveBox 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 + + + +**Version incluse :** 1.0~ynh1 + +**Démo :** https://archivebox.io/ + +## Captures d'écran + +![](./doc/screenshots/screenshot_archivebox1.png) + +## Avertissements / informations importantes + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * required to be run at the base path / , subpaths not yet supported + * currently only tested on amd64 + * haven't yet implemented single-sign or LDAP integration + +* Other infos that people should be aware of, such as: + * nothing comes to mind + +## Documentations et ressources + +* Site officiel de l'app : https://archivebox.io/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://yunohost.org/packaging_apps +* Dépôt de code officiel de l'app : https://github.com/ArchiveBox/ArchiveBox +* Documentation YunoHost pour cette app : https://yunohost.org/app_example +* Signaler un bug : https://github.com/YunoHost-Apps/example_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +ou +sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file