|
|
@@ -1,46 +1,39 @@
|
|
|
<!--
|
|
|
-N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
|
+N.B.: This README was automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
|
|
|
It shall NOT be edited by hand.
|
|
|
-->
|
|
|
|
|
|
-# Archivist for YunoHost
|
|
|
+<h1>
|
|
|
+ <img src="https://raw.githubusercontent.com/YunoHost/apps/master/logos/archivist.png" width="32px" alt="Logo of Archivist">
|
|
|
+ Archivist, packaged for YunoHost
|
|
|
+</h1>
|
|
|
|
|
|
-[](https://dash.yunohost.org/appci/app/archivist)  
|
|
|
+Automatic backups
|
|
|
|
|
|
-[](https://install-app.yunohost.org/?app=archivist)
|
|
|
+?style=for-the-badge)
|
|
|
|
|
|
-*[Read this README in other languages.](./ALL_README.md)*
|
|
|
+<div align="center">
|
|
|
+<a href="https://apps.yunohost.org/app/archivist"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
|
|
|
+<a href="https://github.com/YunoHost-Apps/archivist_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
|
|
|
+</div>
|
|
|
|
|
|
-> *This package allows you to install Archivist 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.*
|
|
|
+## 📦 Developer info
|
|
|
|
|
|
-## Overview
|
|
|
+[](https://ci-apps.yunohost.org/ci/apps/archivist/)
|
|
|
|
|
|
-Archivist is an automatic backup system for your server.
|
|
|
-It able to makes backups of your YunoHost core and your apps by using the YunoHost backup command.
|
|
|
-It can also makes backups of specified directories.
|
|
|
-Your backups can be send to many other places, local or distant.
|
|
|
-Archivist is automatically launched periodicaly to update your backups and send the modifications to the other places.
|
|
|
+🛠️ Upstream Archivist repository: <https://github.com/maniackcrudelis/archivist>
|
|
|
|
|
|
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/archivist_ynh/tree/testing).
|
|
|
|
|
|
+The `testing` branch can be tested using:
|
|
|
+```
|
|
|
+# fresh install:
|
|
|
+sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing
|
|
|
|
|
|
-**Shipped version:** 1.3.4~ynh2
|
|
|
-## Documentation and resources
|
|
|
-
|
|
|
-- Upstream app code repository: <https://github.com/maniackcrudelis/archivist>
|
|
|
-- YunoHost Store: <https://apps.yunohost.org/app/archivist>
|
|
|
-- Report a bug: <https://github.com/YunoHost-Apps/archivist_ynh/issues>
|
|
|
-
|
|
|
-## Developer info
|
|
|
-
|
|
|
-Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/archivist_ynh/tree/testing).
|
|
|
-
|
|
|
-To try the `testing` branch, please proceed like that:
|
|
|
-
|
|
|
-```bash
|
|
|
-sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
|
|
|
-or
|
|
|
-sudo yunohost app upgrade archivist -u https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
|
|
|
+# upgrade an existing install:
|
|
|
+sudo yunohost app upgrade archivist -u https://github.com/YunoHost-Apps/archivist_ynh/tree/testing
|
|
|
```
|
|
|
|
|
|
-**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
|
|
+### 📚 App packaging documentation
|
|
|
+
|
|
|
+Please see <https://doc.yunohost.org/packaging_apps> for more information.
|
yunohost-bot