Skip to content

Commit 2de99da

Browse files
Update ADDON.md
1 parent 80c971e commit 2de99da

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

ADDON.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,16 @@ You should now see the "HAKIT Dashboard" option in the sidebar menu which should
2222

2323
**NOTE**: You may have to change the `html_file_path` in the configuration tab of the addon.
2424

25+
### Configuring the Addon
2526

26-
#### Local Development
27+
Under /hassio/dashboard within home assistant, find the HAKIT addon and click on it.
28+
29+
- `html_file_path`: The path to the index.html file of your custom dashboard. This should be the path from the config directory of your home assistant instance. For example, if your dashboard is located at `/config/www/ha-dashboard/index.html`, you would set this to `www/ha-dashboard/index.html`.
30+
- `spa_mode`: If your dashboard is a single page application, set this to true. This will ensure that the dashboard is loaded correctly.
31+
- `custom_dashboard` - This option is currently something that should always be enabled, this is something that's under development and will potentially be used later on for uploadable pre-built templates.
32+
33+
34+
#### Local Addon Development
2735
Set your directory to the hakit folder, After `npm install`, Simply run `npm run dev` and it will spin up a server and client under port 2022.
2836

2937
#### Options

0 commit comments

Comments
 (0)