Skip to content

Commit 9133240

Browse files
authored
Add "HACS" Button to README (#337)
Adds a clickable button using https://my.home-assistant.io/create-link/ to the repository README
1 parent 6f59ef9 commit 9133240

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

README.md

+27-25
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,33 @@ checked against usernames AND full names. Users have to be created in Home Assis
99

1010
## Installation
1111

12-
Add this repository to [HACS](https://hacs.xyz/).
13-
14-
Update your configuration.yaml file with
15-
16-
```yaml
17-
http:
18-
use_x_forwarded_for: true
19-
trusted_proxies:
20-
- 1.2.3.4/32 # This needs to be set to the IP of your reverse proxy
21-
auth_header:
22-
# Optionally set this if you're not using authentik proxy or oauth2_proxy
23-
# username_header: X-Forwarded-Preferred-Username
24-
# Optionally set this if you don't want to bypass the login prompt
25-
# allow_bypass_login: false
26-
# Optionally enable debug mode to see the headers Home-Assistant gets
27-
# debug: false
28-
# Optionally, if something is not working right, add this block below to get more information
29-
logger:
30-
default: info
31-
logs:
32-
custom_components.auth_header: debug
33-
```
34-
35-
Afterwards, restart Home Assistant.
36-
12+
1. Add this repository to [HACS](https://hacs.xyz/).
13+
14+
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=BeryJu&repository=hass-auth-header&category=integration)
15+
16+
17+
2. Update your configuration.yaml file with
18+
19+
```yaml
20+
http:
21+
use_x_forwarded_for: true
22+
trusted_proxies:
23+
- 1.2.3.4/32 # This needs to be set to the IP of your reverse proxy
24+
auth_header:
25+
# Optionally set this if you're not using authentik proxy or oauth2_proxy
26+
# username_header: X-Forwarded-Preferred-Username
27+
# Optionally set this if you don't want to bypass the login prompt
28+
# allow_bypass_login: false
29+
# Optionally enable debug mode to see the headers Home-Assistant gets
30+
# debug: false
31+
# Optionally, if something is not working right, add this block below to get more information
32+
logger:
33+
default: info
34+
logs:
35+
custom_components.auth_header: debug
36+
```
37+
3. Afterwards, restart Home Assistant.
38+
3739
![](./.github/demo.gif)
3840
3941
## CSRF Errors when used with oauth2_proxy or authentik

0 commit comments

Comments
 (0)