README.md

Packaging 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.toml 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.
• Edit the change_url and config scripts too, or remove them if you have no use of them
• Add a LICENSE file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use the AGPL-3.
• Edit doc/DISCLAIMER*.md
• The README.md files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator

---

Example app for YunoHost

Lire ce readme en français.

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

Overview

SABnzbd is a program to download binary files from Usenet servers.

Features

• Server orientated so available through your web browser;
• Automated - SABnzbd takes care of all the hassle of downloading, verifying, repairing, unpacking and deleting garbage. You throw an NZB file at SABnzbd and some time later a complete and directly usable download is available;
• It is light weight;

Shipped version: 1.0~ynh1

Screenshots

Disclaimers / important information

TBA

• Any known limitations, constrains or stuff not working, such as (but not limited to):

  • requiring a full dedicated domain ?
  • architectures not supported ?
  • not-working single-sign on or LDAP integration ?
  • the app requires an important amount of RAM / disk / .. to install or to work properly
  • etc...

• Other infos that people should be aware of, such as:

  • any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
  • how to configure / administrate the application if it ain't obvious
  • upgrade process / specificities / things to be aware of ?
  • security considerations ?

Documentation and resources

• Official app website: https://example.com
• Official user documentation: https://yunohost.org/apps
• Official admin documentation: https://yunohost.org/packaging_apps
• Upstream app code repository: https://some.forge.com/example/example
• YunoHost documentation for this app: https://yunohost.org/app_sabnzbd
• Report a bug: https://github.com/YunoHost-Apps/sabnzbd_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/sabnzbd_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/sabnzbd_ynh/tree/testing --debug

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