Skip to content

Commit

Permalink
fix wiki pathss
Browse files Browse the repository at this point in the history
  • Loading branch information
s-allius committed Dec 24, 2024
1 parent a933683 commit 20503b4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ No special configuration is required for the Docker container if it is built and

On the host, two directories (for log files and for config files) must be mapped. If necessary, the UID of the proxy process can be adjusted, which is also the owner of the log and configuration files.

A description of the configuration parameters can be found [here](https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#docker-compose-environment-variables).
A description of the configuration parameters can be found [here](https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#docker-compose-environment-variables).

## Proxy Configuration

Expand Down Expand Up @@ -168,7 +168,7 @@ You find more details here: <https://toml.io/en/v1.0.0>
### https://github.com/s-allius/tsun-gen3-proxy/wiki/Operation-Modes-Overview
###
### Here you will find a description of all configuration options:
### https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details
### https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml
###
### The configration uses the TOML format, which aims to be easy to read due to
### obvious semantics. You find more details here: https://toml.io/en/v1.0.0
Expand All @@ -184,7 +184,7 @@ You find more details here: <https://toml.io/en/v1.0.0>
## required credentials. As the proxy does not currently support an encrypted connection
## to the MQTT broker, it is strongly recommended that you do not use a public broker.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#mqtt-broker-account
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#mqtt-broker-account
##

mqtt.host = 'mqtt' # URL or IP address of the mqtt broker
Expand All @@ -201,7 +201,7 @@ mqtt.passwd = ''
## values match the HA default configuration. If you need to change these or want to use
## a different MQTT client, you can adjust the prefixes of the MQTT topics below.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#home-assistant
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#home-assistant
##

ha.auto_conf_prefix = 'homeassistant' # MQTT prefix for subscribing for homeassistant status updates
Expand All @@ -219,7 +219,7 @@ ha.proxy_unique_id = 'P170000000000001' # MQTT unique id, to identify a prox
## inverters. This connection is only required if you want send data to the TSUN cloud
## to use the TSUN APPs or receive firmware updates.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#tsun-cloud-for-gen3-inverter-only
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#tsun-cloud-for-gen3-inverter-only
##

tsun.enabled = true # false: disables connecting to the tsun cloud, and avoids updates
Expand All @@ -235,7 +235,7 @@ tsun.port = 5005
## inverters. This connection is only required if you want send data to the TSUN cloud
## to use the TSUN APPs or receive firmware updates.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#solarman-cloud-for-gen3plus-inverter-only
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#solarman-cloud-for-gen3plus-inverter-only
##
solarman.enabled = true # false: disables connecting to the tsun cloud, and avoids updates
solarman.host = 'iot.talent-monitoring.com'
Expand Down
10 changes: 5 additions & 5 deletions app/config/default_config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
### https://github.com/s-allius/tsun-gen3-proxy/wiki/Operation-Modes-Overview
###
### Here you will find a description of all configuration options:
### https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details
### https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml
###
### The configration uses the TOML format, which aims to be easy to read due to
### obvious semantics. You find more details here: https://toml.io/en/v1.0.0
Expand All @@ -31,7 +31,7 @@
## required credentials. As the proxy does not currently support an encrypted connection
## to the MQTT broker, it is strongly recommended that you do not use a public broker.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#mqtt-broker-account
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#mqtt-broker-account
##

mqtt.host = 'mqtt' # URL or IP address of the mqtt broker
Expand All @@ -48,7 +48,7 @@ mqtt.passwd = ''
## values match the HA default configuration. If you need to change these or want to use
## a different MQTT client, you can adjust the prefixes of the MQTT topics below.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#home-assistant
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#home-assistant
##

ha.auto_conf_prefix = 'homeassistant' # MQTT prefix for subscribing for homeassistant status updates
Expand All @@ -66,7 +66,7 @@ ha.proxy_unique_id = 'P170000000000001' # MQTT unique id, to identify a prox
## inverters. This connection is only required if you want send data to the TSUN cloud
## to use the TSUN APPs or receive firmware updates.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#tsun-cloud-for-gen3-inverter-only
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#tsun-cloud-for-gen3-inverter-only
##

tsun.enabled = true # false: disables connecting to the tsun cloud, and avoids updates
Expand All @@ -82,7 +82,7 @@ tsun.port = 5005
## inverters. This connection is only required if you want send data to the TSUN cloud
## to use the TSUN APPs or receive firmware updates.
##
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#solarman-cloud-for-gen3plus-inverter-only
## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#solarman-cloud-for-gen3plus-inverter-only
##

solarman.enabled = true # false: disables connecting to the tsun cloud, and avoids updates
Expand Down
2 changes: 1 addition & 1 deletion ha_addons/ha_addon/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,4 @@ SOFTWARE.
[AdGuard]: https://github.com/hassio-addons/addon-adguard-home
[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fs-allius%2Fha-addons
[configdetails]: https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details
[configdetails]: https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml

0 comments on commit 20503b4

Please sign in to comment.