⚠️ Note: This README corresponds to v1.0.0 and may not fully reflect the current state of the repository. Please change to the specific tag for the most accurate information.

Hass Addon FRP Client

Home Assistant Community Add-on: FRP Client

You can leverage this add-on to achieve remote access to local Home Assistant OS by port forwarding.

Architecture

Installation

• Go to Settings -> Add-ons -> Add-on Store (bottom right)
• Click Repositories (top right)

• Add the current repository https://github.com/huxiaoxu2019/hass-addon-frp-client/

• Wait and refresh the Add-on Store page, then you can see one new add-on Frp Client, click it and install

• Add the configurations shown as below in your configurations.yaml with File Editor addon

http:
  use_x_forwarded_for: true
  trusted_proxies:
    - 0.0.0.0/0

It's better to modify the 0.0.0.0/0 to your proxy server IP

Notes for Chinese Users: If the above steps fail, please try again as GitHub resource access may be unstable. If the issue persists, you can check the specific logs for troubleshooting by using the command ha su logs.

Usage Tutorial

Contribution

Welcome and appreciate contributions from the Home Assistant community. If you have ideas for improvements, bug fixes, or new features, feel free to contribute by submitting a pull request (PR). Before you start, please make sure to follow these guidelines:

Bug Reports

If you encounter any bugs or have ideas for new features, please open an issue on the issue tracker.

Pull Request

• Clearly describe the purpose of your changes in the pull request
• Provide step-by-step instructions for testing your changes
• Ensure that your changes do not introduce new issues

Code of Conduct

Please note that this project follows Home Assistant's Code of Conduct. Be respectful and considerate in all interactions.

Author

Xiaoxu Hu [email protected]

Special thanks to: @steplov for the setup script