Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Bump version to v0.0.2 #41

Merged
merged 1 commit into from
Nov 24, 2024
Merged

chore: Bump version to v0.0.2 #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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"
}