Skip to content

Commit

Permalink
README.md: Add remote debug information for VS Code
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Serong <tserong@suse.com>
  • Loading branch information
tserong authored and innobead committed Feb 7, 2024
1 parent c55e6b9 commit 9f7a997
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,24 @@ on port `2345`.

Run `vagrant ssh-config` on your host to get the IP address that is
needed to connect the IDE debugger to the `harvester-installer` app.

If you are using the Goland IDE, check out their [documentation](https://www.jetbrains.com/help/go/go-remote.html)
how to attach to the `harvester-installer` process on the remote
Vagrant box.
for information on how to attach to the `harvester-installer` process
on the remote Vagrant box.

If you are using VS Code, create a remote debug configuration in
`.vscode/launch.json` then press F5 to start debugging:

```json
{
"name": "Remote",
"type": "go",
"request": "attach",
"mode": "remote",
"port": 2345,
"host": "IP_ADDRESS_OF_VAGRANT_BOX",
}
```

## License
Copyright (c) 2024 [Rancher Labs, Inc.](http://rancher.com)
Expand Down

0 comments on commit 9f7a997

Please sign in to comment.