Skip to content

Commit

Permalink
chore: Bump version to v0.0.2 (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
dermotduffy authored Nov 24, 2024
1 parent 283fe57 commit cf80c30
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ Result:
- Visiting
`https://$HA_INSTANCE/api/hass_web_proxy/v0/?url=http%3A%2F%2Fcam-back-yard.mydomain.io`
will proxy through Home Assistant for authenticated Home Assistant users.
- The service call will return a dictionary with a `url_id` parameter referring
to the created proxied URL.

To delete the proxied URL:

Expand Down Expand Up @@ -119,15 +121,15 @@ action: hass_web_proxy.create_proxied_url
data: [...]
```

| Name | Default | Description |
| ----------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `open_limit` | | An optional number of times a URL pattern may be proxied to before it is automatically removed as a proxied URL. |
| `ssl_verification` | `true` | Whether SSL certifications/hostnames should be verified on the proxy URL targets. |
| `ssl_ciphers` | `default` | Whether to use `default`, `modern`, `intermediate`, or `insecure` ciphers. Older devices may not support default or modern ciphers. |
| `ttl` | | An optional number of seconds to allow proxying of this URL pattern. |
| `url_pattern` | | An required [URL pattern](https://github.com/jessepollak/urlmatch) to allow proxying for, e.g. `http://cam-*.mydomain.io`. |
| `url_id` | | An optional ID that can be used to refer to that proxied URL later (e.g. to delete it with the `hass_web_proxy.delete_proxied_url` action). |
| `allow_unauthenticated` | `false` | If `false`, or unset, unauthenticated HA users will not be allowed to access the proxied URL. If `true`, they will. See below. |
| Name | Default | Description |
| ----------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `open_limit` | | An optional number of times a URL pattern may be proxied to before it is automatically removed as a proxied URL. |
| `ssl_verification` | `true` | Whether SSL certifications/hostnames should be verified on the proxy URL targets. |
| `ssl_ciphers` | `default` | Whether to use `default`, `modern`, `intermediate`, or `insecure` ciphers. Older devices may not support default or modern ciphers. |
| `ttl` | | An optional number of seconds to allow proxying of this URL pattern. |
| `url_pattern` | | An required [URL pattern](https://github.com/jessepollak/urlmatch) to allow proxying for, e.g. `http://cam-*.mydomain.io`. |
| `url_id` | [UUID] | An optional ID that can be used to refer to that proxied URL later (e.g. to delete it with the `hass_web_proxy.delete_proxied_url` action). A UUID is automatically used if this parameter is not specified. |
| `allow_unauthenticated` | `false` | If `false`, or unset, unauthenticated HA users will not be allowed to access the proxied URL. If `true`, they will. See below. |

#### `hass_web_proxy.delete_proxied_url`

Expand Down
2 changes: 1 addition & 1 deletion custom_components/hass_web_proxy/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
"iot_class": "local_push",
"issue_tracker": "https://github.com/dermotduffy/hass-web-proxy-integration/issues",
"requirements": ["hass-web-proxy-lib==0.0.7", "urlmatch==1.0.1"],
"version": "0.0.1"
"version": "0.0.2"
}

0 comments on commit cf80c30

Please sign in to comment.