mirror of https://github.com/YunoHost-Apps/archivebox_ynh.git synced 2024-09-03 18:15:54 +02:00

Self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline, for YunoHost.

Find a file

Yunohost-Bot 728e399740 Auto-update README		2021-08-19 10:02:02 +00:00
.github	Initial commit	2021-08-13 09:42:21 -04:00
conf	Working ynh	2021-08-18 12:15:22 +02:00
doc	Updates to README	2021-08-18 21:18:21 +02:00
scripts	Updates to README	2021-08-18 21:18:21 +02:00
sources	Initial commit	2021-08-13 09:42:21 -04:00
.gitignore	Almost workign	2021-08-13 15:43:07 -04:00
check_process	Initial commit	2021-08-13 09:42:21 -04:00
LICENSE	Updates to README	2021-08-18 21:18:21 +02:00
manifest.json	Updates to README	2021-08-18 21:18:21 +02:00
README.md	Auto-update README	2021-08-19 10:02:02 +00:00
README_fr.md	Auto-update README	2021-08-19 10:02:02 +00:00

README.md

Packaging your an app, starting from this example

Copy this app before working on it, using the 'Use this template' 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.
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

ArchiveBox for YunoHost

Lire ce readme en français.

This package allows you to install ArchiveBox quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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.io/

Screenshots

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 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 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_example
Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
or
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