hassio-addons/stirling-pdf/DOCS.md

38 lines
1.5 KiB
Markdown

# Home Assistant Slowtech Add-on: Stirling PDF
This is an Home Assistant add-on that packages [_Stirling PDF_][stirlingpdf], a fully-featured self-hosted PDF editor.
## Installation
1. Add the _addons_ repository to your Home Assistant instance's repositories list. (See README.md file in the parent directory.)
1. Follow [Home Assistant's instructions][hassio-install-addon] to install the add-on.
## Configuration
The port on which the web interface is exposed can be changed in the _Configuration_ tab, under _Network_.
Note that this parameter is independent from the _Ingress_ integration. Providing `null` as a port will make the add-on only exposed through the _Ingress_ integration.
## Changelog & Releases
The add-on versioning follows the [docker container's versioning][dockerhub-releases].
## Known issues
- The "View PDF" applet does not work in Ingress mode.
## Support
This repository does not accept inquiries for the moment.
## Authors & contributors
The original setup of this repository and packaging work is by Pierre Guillod.
The backend software is developped by [Anthony 'Frooodle' Stirling][github-frooodle] and [contributors][github-contribs].
[stirlingpdf]: https://www.stirlingtools.com/
[hassio-install-addon]: https://www.home-assistant.io/addons/
[github-frooodle]: https://github.com/Frooodle
[github-contribs]: https://github.com/Frooodle/Stirling-PDF/graphs/contributors
[dockerhub-releases]: https://hub.docker.com/r/frooodle/s-pdf/tags