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.

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

README.md: Add remote debug information for VS Code #651

Merged
merged 1 commit into from
Feb 7, 2024
Merged
Changes from all commits
Commits
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: 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
Loading