#🏠 HACS China

HACS is an excellent Home Assistant integration store, however, it's difficult for Chinese users to download plugins or frontend cards from it, mainly due to the domestic network environment. This project uses Github proxy services provided by gitmirror.com and fastgit.org, allowing everyone to download plugins from the store more quickly.

#Installation/Update

#Method 1️⃣: Install using command

wget -O - https://get.hacs.vip | bash -

# or

curl -fsSL get.hacs.vip | bash

• If you're using haos/hassio/supervised version of HA, you can directly execute the above command on the host machine or in the Terminal & SSH add-on
• If you're using core/docker version of HA, need to ssh into the host machine, cd into the HA configuration directory, then execute the installation command

#Method 2️⃣: Add-on Installer: https://hacs.vip/get-addon

Requires HAOS or Supervised version of HA

1. Add add-on repository https://gitee.com/hacs-china/addons
2. Find HACS China Installer and install the add-on
3. Start the add-on and observe the logs
4. Restart HA

#Method 3️⃣: upgrade service

Requires HACS China v1.33.0.3 or higher already installed

1. Execute service service: hacs.upgrade in Developer Tools
2. Restart HA to make the updated HACS take effect

#Method 4️⃣: shell_command service

1. Copy code to HA configuration file configuration.yaml

   shell_command:
     update_hacs_china: |-
       wget -O - https://get.hacs.vip | bash -
2. Restart HA to make configuration take effect
3. Execute action action: shell_command.update_hacs_china in Developer Tools
4. Restart HA again to make the updated HACS take effect

#Method 5️⃣: Docker Installation

Only for Docker version of HA without HACS installed

1. Install using command

   docker run -d \
     --name homeassistant \
     --privileged \
     --restart=unless-stopped \
     -e TZ=Asia/Shanghai \
     -v /PATH_TO_YOUR_CONFIG:/config \
     -v /run/dbus:/run/dbus:ro \
     --network=host \
     hacn/hacn:stable
2. Install using Compose

   services:
     homeassistant:
       container_name: homeassistant
       image: hacn/hacn:stable
       volumes:
         - /PATH_TO_YOUR_CONFIG:/config
         - /etc/localtime:/etc/localtime:ro
         - /run/dbus:/run/dbus:ro
       restart: unless-stopped
       privileged: true
       network_mode: host
3. After startup, add HACS integration

#Method 6️⃣: Manual Installation

• Click here to download installation package and unzip (if download fails, please click here or here)
• Access HA configuration directory via samba/ftp, usually the following directories:
  • /usr/share/hassio/homeassistant haos/hassio host machine
  • /config haos/hassio's Samba or Terminal & SSH add-on
  • $HOME/.homeassistant default configuration directory for HA installed in core mode
  • For HA installed with docker, it's the directory mapped after the -v parameter
• Create custom_components folder in HA configuration directory (ignore if already exists)
• Create hacs folder in custom_components directory (delete and recreate if already exists)
• Copy the unzipped files to the newly created hacs folder
• Restart HA
• Add HACS integration (only for first-time installation)