Skip to content

Fix dev docs to point to netdaemon.xyz instead #638

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

Merged
merged 2 commits into from
Jan 29, 2022
Merged

Fix dev docs to point to netdaemon.xyz instead #638

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb1e424
fix devdocs
helto4real Jan 29, 2022
0322b3a
Update DEV.md
helto4real Jan 29, 2022
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
19 changes: 1 addition & 18 deletions DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,5 @@
# Developing NetDaemon
These instructions are for developing NetDaemon. For apps please use [the docs](https://netdaemon.xyz).
For your convenience we provided with a docker setup with Home Assistant you can run on your development machine.
`tests/Docker/HA` you will find the docker-compose file. Run it outside the devcontainer. Remarkts that you should use port 8124 connecting to this instance of Home Assistant.

## Use appsettings.Development.json
Copy the "_appsettings.Development.json under `src/Service`

## Setup the environment vars
Alternative to using appsettings for development is to use environment varables for your Home Assistant instance

| Environment variable | Description |
| ------ | ------ |
| HOMEASSISTANT__TOKEN | Token secret to access the HA instance |
| HOMEASSISTANT__HOST | The ip or hostname of HA |
| HOMEASSISTANT__PORT | The port of home assistant (defaults to 8123 if not specified) |
| NETDAEMON__GENERATEENTITIES | Generate entities, recommed set false unless debugging |
| NETDAEMON__APPSOURCE | The folder/project/dll where it will find daemon. Set this to empty `""` to debug apps local. If needed to debug the dynamic source compilation, set to `/workspaces/netdaemon/Service/apps` |

Use `src/Development/apps` as starting point to debug your stuff!
Thank you for considering contributing to NetDaemon. You will find a good starting point in the [documentation for developers](https://netdaemon.xyz/docs/developer)

Good luck