Skip to content
This repository has been archived by the owner on Jul 28, 2024. It is now read-only.

A HACS Integration to replace the core matrix Home Assistant integration.

Notifications You must be signed in to change notification settings

PaarthShah/matrix-nio-hacs

Repository files navigation

Matrix Nio - HACS

Caution

This project is NO LONGER MAINTAINED... because it's been included directly into Home Assistant core! See this PR and this commit

GitHub Release GitHub Activity Downloads License

hacs Project Maintenance

Community Forum Matrix

Integration to integrate with Matrix Homeservers using matrix-nio. Replaces the core HomeAssistant matrix integration.

PR to merge to core

Installation

HACS (Preferred)

  1. Add the custom integration repository: https://github.com/PaarthShah/matrix-nio-hacs
  2. Select Matrix Nio in the Integration tab and click download
  3. Restart Home Assistant
  4. Done!

Manual

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called matrix.
  4. Download all the files from the custom_components/matrix/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. Done!

Usage

For v1.0.X, all documentation available for the default matrix integrations is fully-applicable and should work as-stated with 0 changes.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines