Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.
/ hassio-mihomo Public archive

Home Assistant Add-on for Mihomo Meta - A rule-based transparent proxy with advanced routing capabilities

License

Notifications You must be signed in to change notification settings

kapuic/hassio-mihomo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Home Assistant Add-on: Mihomo

GitHub Release License Build Status Supports aarch64 Architecture

Add to Home Assistant

A Home Assistant add-on repository for running Mihomo (formerly Clash.Meta) as a transparent proxy with advanced routing capabilities.

Add-ons

This repository contains the following add-ons

Supports aarch64 Architecture Supports amd64 Architecture Supports armv7 Architecture Supports armhf Architecture Supports i386 Architecture

Mihomo (Clash.Meta) - A rule-based transparent proxy with advanced routing capabilities.

About

This add-on enables you to run Mihomo (formerly Clash.Meta) on your Home Assistant instance. Mihomo is a rule-based network proxy that supports transparent proxy, multiple protocols, and advanced routing features.

The add-on provides a complete proxy solution with automatic daily updates, ensuring you always have the latest features and security patches from the Mihomo project.

Features

  • πŸš€ Transparent Proxy (TProxy) - Seamless traffic routing on port 9898
  • πŸ”„ Auto-updating - Daily builds with the latest Mihomo binary via GitHub Actions
  • βš™οΈ Flexible Configuration - Support for custom configurations
  • πŸ”§ RESTful API - Control via web interface on port 9090
  • 🌐 Multi-protocol Support - SS, VMess, Trojan, VLESS, and more
  • 🏠 Home Assistant Integration - Native add-on with full access to Home Assistant network
  • 🦾 ARM64 Support - Optimized for Raspberry Pi 4 and similar devices

Installation

One-Click Install

Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

Manual Installation

  1. Navigate to your Home Assistant Supervisor panel
  2. Click on "Add-on Store"
  3. Click the three dots menu and select "Repositories"
  4. Add this repository URL: https://github.com/kapuic/hassio-mihomo
  5. Find "Mihomo Proxy" in the add-on store and click Install

Configuration

Basic Setup

The add-on works out of the box with a default configuration. For custom setups:

  1. Create /config/mihomo.yaml in your Home Assistant config directory
  2. Add your proxy configuration (see Configuration Template)
  3. Restart the add-on

Configuration Template

# Example configuration
mixed-port: 7893
allow-lan: true
mode: rule
log-level: info

dns:
  enable: true
  enhanced-mode: fake-ip
  nameserver:
    - 8.8.8.8
    - 1.1.1.1

proxies:
  # Add your proxy servers here

proxy-groups:
  # Add your proxy groups here

rules:
  # Add your routing rules here
  - MATCH,DIRECT

For a complete configuration reference, see the mihomo-default.yaml template in this repository.

Default Ports

Service Port Description
HTTP Proxy 7890 HTTP(S) proxy server
SOCKS5 Proxy 7891 SOCKS5 proxy server
Mixed Proxy 7893 Combined HTTP(S) and SOCKS proxy
TProxy 9898 Transparent proxy (Linux)
DNS 53 DNS server
API 9090 RESTful API endpoint

Web UI

Access the Mihomo dashboard by navigating to:

http://homeassistant.local:9090

Or use your Home Assistant IP address: http://YOUR_IP:9090

You can use web dashboards like:

Advanced Features

TUN Mode

Enable TUN mode for system-wide proxy (requires additional configuration):

tun:
  enable: true
  stack: system
  auto-route: true
  auto-redirect: true

Sniffer

Enable protocol sniffing for better traffic identification:

sniffer:
  enable: true
  sniff:
    TLS:
      ports: [443, 8443]
    HTTP:
      ports: [80, 8080-8880]

Troubleshooting

Check Logs

# View add-on logs in Home Assistant
ha addons logs mihomo

Common Issues

  1. Port conflicts: Ensure no other services are using the configured ports
  2. DNS issues: Try disabling the DNS server or changing the port
  3. Connection refused: Check if allow-lan is set to true

Links

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes
  • MINOR: Backwards-compatible new features and enhancements
  • PATCH: Backwards-compatible bugfixes and package updates

Support

Got questions?

You have several options to get them answered:

You could also open an issue here on GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Ka Pui Cheung.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright Β© 2025 Ka Pui Cheung

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

Home Assistant Add-on for Mihomo Meta - A rule-based transparent proxy with advanced routing capabilities

Topics

Resources

License

Stars

Watchers

Forks