avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-08-06 05:02:30 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fix/elasticsearch-8x-migration
hassio-addons/zoraxy
History

README.md

Home assistant add-on: Zoraxy

I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons

If this add-on saves you time or makes your setup easier, I would be very grateful for your support!

Buy me a coffee Donate via PayPal

Addon informations

Version Arch

About

Zoraxy is a general purpose HTTP request (reverse) proxy and forwarding tool with a clean web management UI. It can be used as a modern, actively-maintained alternative to Nginx Proxy Manager: create reverse proxy hosts, manage TLS certificates (including ACME / Let's Encrypt), set up redirections, access rules, a basic web server and more.

This add-on is based on the official docker image from tobychui.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA) Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.
  2. Install this add-on.
  3. Click the Save button to store your configuration.
  4. Start the add-on.
  5. Check the logs of the add-on to see if everything went well.
  6. Open the Web UI and create your administrator account.

Configuration

The management Web UI is exposed on port 8000. Because Zoraxy acts as a reverse proxy that must own the standard web ports, it is not served through Home Assistant ingress — open it directly:

Webui can be found at http://homeassistant.local:8000

The reverse proxy itself listens on ports 80 (HTTP) and 443 (HTTPS). Make sure these ports are free on the host (e.g. not used by another proxy add-on) and, if you want to reach your services from outside, forward them on your router.

All configuration, the database, logs and plugins are stored persistently in the add-on configuration folder (/addon_configs/<slug>_zoraxy/, exposed inside the container as /config), so they survive add-on updates and restarts.

Options

Option Default Description
NOAUTH false Disable authentication for the management interface (use with care).
ZEROTIER false Enable the ZeroTier global area network controller (uses the NET_ADMIN capability and /dev/net/tun, both granted by the add-on).
FASTGEOIP false Enable high-speed GeoIP lookup (uses ~1 GB extra memory).
MDNS true Enable mDNS service discovery.
TZ - Timezone, e.g. Europe/Brussels.
env_vars [] Pass any additional upstream environment variable (e.g. AUTORENEW, DB, MDNSNAME, ...).

Any other upstream setting documented in the Zoraxy docker README can be supplied through env_vars:

env_vars:
  - name: AUTORENEW
    value: "86400"
  - name: DB
    value: "auto"

Support

Create an issue on the repository.