search

Limych / ha-tor_check

Check your TOR network connection and get your current TOR exit IP
Other
2 stars 0 forks source link
checker home-assistant home-assistant-integration tor tor-network tor-onion-service

readme

Please :star: this repo if you find it useful

TOR Check component for Home Assistant

GitHub Release GitHub Activity License

hacs Project Maintenance Support me on Patreon

Custom component to check your connection to TOR network.

This integration will set up the following platforms.

Platform Description
binary_sensor Shows current TOR network connection status.
sensor Shows your current public IP in TOR network (IP of TOR exit node you use now).

Installation

Install from HACS (recommended)

  1. Have HACS installed, this will allow you to easily manage and track updates.
  2. Search in HACS for "TOR Check" integration or just press the button below:\ Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.
  3. Click Install below the found integration.
  4. If you want to configure component via Home Assistant UI...\ in the HA UI go to "Configuration" > "Integrations" click "+" and search for "TOR Check".
  5. If you want to configure component via configuration.yaml...\ follow instructions below, then restart Home Assistant.

Manual installation

  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 tor_check.
  4. Download file tor_check.zip from the latest release section in this repository.
  5. Extract all files from this archive you downloaded in the directory (folder) you created.
  6. Restart Home Assistant
  7. If you want to configure component via Home Assistant UI...\ in the HA UI go to "Configuration" > "Integrations" click "+" and search for "TOR Check".
  8. If you want to configure component via configuration.yaml...\ follow instructions below, then restart Home Assistant.

Configuration Examples

# Example configuration.yaml entry
tor_check:
  tor_host: 192.168.0.1
  tor_port: 9050

* * *

I put a lot of work into making this repo and component available and updated to inspire and help others! I will be glad to receive thanks from you — it will give me new strength and add enthusiasm:


Patreon
or support via Bitcoin or Etherium:
Bitcoin
16yfCfz9dZ8y8yuSwBFVfiAa3CNYdMh7Ts

Configuration Variables

tor_host:\ (string) (Required)\ Host name or IP address of TOR entry node (SOCKS5 proxy).

tor_port:\ (positive integer) (Optional) (Default value: 9050)\ Port number of TOR entry node (SOCKS5 proxy).

Track updates

You can automatically track new versions of this component and update it by HACS.

Troubleshooting

To enable debug logs use this configuration:

# Example configuration.yaml entry
logger:
  default: info
  logs:
    custom_components.tor_check: debug

... then restart HA.

Contributions are welcome!

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! :heart_eyes:

Authors & contributors

The original setup of this component is by Andrey "Limych" Khrolenok.

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

This Home Assistant custom component was created and is updated using the HA-TOR Check template. You can use this template to maintain your own Home Assistant custom components.

License

creative commons Attribution-NonCommercial-ShareAlike 4.0 International License

See separate license file for full text.