archivebox_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# ArchiveBox for YunoHost

[![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)

*[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

A self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline.

**Shipped version:** 1.5~ynh1

**Demo:** https://archiveboxdemo.commoninternet.net

## Screenshots

![](./doc/screenshots/screenshot_archivebox1.png)

## Disclaimers / important information

* Any known limitations, constrains or stuff not working:
    * 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 


## Documentation and resources

* Official app website: https://archivebox.io/
* Official admin documentation: https://github.com/ArchiveBox/ArchiveBox/wiki
* 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

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing --debug
or
sudo yunohost app upgrade archivebox -u https://github.com/YunoHost-Apps/archivebox_ynh/tree/testing --debug
```

**More info regarding app packaging:** https://yunohost.org/packaging_apps