diff --git a/collabora/README.md b/collabora/README.md index 90c3bce9a..434249833 100644 --- a/collabora/README.md +++ b/collabora/README.md @@ -1,4 +1,4 @@ -# Home assistant add-on: collabora +# Home assistant add-on: Collabora [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA) @@ -7,32 +7,68 @@ ![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fcollabora%2Fconfig.json) ![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fcollabora%2Fconfig.json) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) +[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) +[![Builder](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/onpush_builder.yaml?label=Builder)](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml) + +[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20(no%20paypal)-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white +[paypal-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20with%20Paypal-0070BA?logo=paypal&style=flat&logoColor=white + +_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_ + +[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) + +![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/collabora/stats.png) + ## About Collabora Online is a collaborative office suite based on LibreOffice technology. ## Installation -1. Click the Home Assistant My add-on store button below. -1. Click the "Install" button to install the add-on. +--- + +1. Add my add-ons repository to your Home Assistant instance or click the My link below. +1. Install the add-on. 1. Start the add-on. -1. Check the logs of the add-on to see if everything went well. +1. Check the add-on logs to verify successful startup. Open your Home Assistant instance and show the add add-on repository dialog ## Configuration -Webui can be found at or through Ingress. +--- + +Webui can be found at `http://homeassistant:9980` or through Ingress. ### Options -Configure the add-on to allow access from your Nextcloud instance: +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `aliasgroup1` | str | | Nextcloud external domain with escaped dots (e.g. `nextcloud_domain\\.com`) | +| `domain1` | str | | Collabora external domain with escaped dots (e.g. `code_domain\\.com`) | +| `extra_params` | str | | Extra parameters passed to the Collabora start script | +| `username` | str | | Username for the Collabora admin console | +| `password` | str | | Password for the Collabora admin console | +| `dictionaries` | str | | Space-separated list of dictionary languages to install | -- `domain`: Regex matching the Nextcloud host (for example `cloud\\.example\\.com`). -- `username` and `password`: Optional credentials for the Collabora admin console. -- `aliasgroup1`: Additional allowed hostnames for WOPI connections. -- `dictionaries`: Space separated list of dictionary languages to install. -- `extra_params`: Extra parameters passed to the Collabora start script. +### Example configuration + +```yaml +aliasgroup1: nextcloud_domain\.com +domain1: code_domain\.com +extra_params: "" +username: admin +password: changeme +``` + +### Using Collabora with Nextcloud + +1. Install the Collabora add-on and configure the options above. +1. Start the add-on and expose the Collabora server to an external domain. +1. Install and configure the Nextcloud add-on. +1. Inside Nextcloud, install the **Nextcloud Office** app. +1. In Nextcloud **Administration Settings → Office**, set the Collabora server URL to `https://yourdomain:9980` and enable **Disable certificate validation**. ### Custom Scripts and Environment Variables @@ -45,5 +81,3 @@ This addon supports custom scripts and environment variables through the `addon_ Create an issue on GitHub -[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20(no%20paypal)-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white -[paypal-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20with%20Paypal-0070BA?logo=paypal&style=flat&logoColor=white