Skip to content

Reverse proxy addon for hassio based on traefik and web admin panel

License

Notifications You must be signed in to change notification settings

porkyoot/hassio-addon-traefik

 
 

Repository files navigation

Traefik

GitHub Release Project Stage License

Supports aarch64 Architecture Supports amd64 Architecture Supports armv7 Architecture

Project Maintenance

Create reverse proxy configs via web interface!

About

Traefik is a reverse proxy with a strong focus on container orchestration plaforms. Beside that it also supports dynamic configuration via file input. This addon provides a beautiful web interface to create the dynamic configuration for you.

By using this addon you agree to the TOS of lets encrypt.

Features

  • 🔒 HTTPS by default (provided by lets encrypt)
  • 🔒 HTTP to HTTPS redirect
  • 🔒 HSTS
  • 🔠 Custom request headers
  • 🗝️ Basic auth
  • 🗝️ SSO using homeassistant api
  • 🚪 IP restriction

Configuration

loglevel: error
email: [email protected]
authEndpoint: 'https://hass.example.com/auth/authorize'
cookieSecret: aVerySecureStringHere
insecureSkipVerify: false
environment:
  - DNS_PROVIDER=cloudflare
  - CF_DNS_API_TOKEN=12345
hosts:
  - 192.168.1.1 foo.example.com
rootCAs: []

Option: loglevel

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to error, which is the recommended setting unless you are troubleshooting.

Option: email

The email option is required for the registration with the lets encrypt service.

Option: httpreq

removed This option sets the necessary variables and cert resolver to dns01. Please refer the official documentation from traefik for further details https://doc.traefik.io/traefik/https/acme/#dnschallenge

Option: authEndpoint

This option enables the forward auth feature. With this feature you can secure any proxy entry with the homeassistant login system. It also works as single sign on (SSO) solution for all proxy entries sharing the forward auth config.

Option: cookieSecret

This should be a very random value used for encryption of the cookies for forward auth.

Option: insecureSkipVerify

Skip verification of ssl certs on backends. Useful if you proxy to a tls/ssl backend with a self signed certificate Try to leave this settings to false and provide necessary root CAs. Please refer the official documentation from traefik for further details https://doc.traefik.io/traefik/routing/overview/#insecureskipverify

Option: environment

Sets the specified environment variables. This can be used to provider information for the dns challenge provider. Use the variable DNS_PROVIDER to specify the provider. More information can be found at https://doc.traefik.io/traefik/https/acme/#providers

DNS_PROVIDER=cloudflare
CF_DNS_API_TOKEN=12345

Option: hosts

Writes the entries to the hosts file.

192.168.1.1 foo.example.com

Option: rootCAs

Specifies a list of root CAs as base64 strings to import in traefik.

License

MIT License

Copyright (c) 2021-2022 Philipp Ritter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Reverse proxy addon for hassio based on traefik and web admin panel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dockerfile 100.0%