Document the ssh.bootstrap configuration option

This commit is contained in:
Baptist BENOIST 2016-02-10 21:57:13 +01:00
commit 957f04ea02

View file

@ -84,7 +84,9 @@ request.
"password": "password123", "password": "password123",
"user": "remoteUser", "user": "remoteUser",
"x11host": "localhost", "x11host": "localhost",
"x11port": 6000 "x11port": 6000,
// Optional, content will be executed on the SSH host before the debugger call.
"bootstrap": "source /home/remoteUser/some-env"
} }
``` ```
@ -95,4 +97,8 @@ For X11 forwarding to work you first need to enable it in your Display Manager a
connections. To allow connections you can either add an entry for applications or run `xhost +` connections. To allow connections you can either add an entry for applications or run `xhost +`
in the console while you are debugging and turn it off again when you are done using `xhost -`. in the console while you are debugging and turn it off again when you are done using `xhost -`.
Because some builds requires one or more environment files to be sourced before running any
command, you can use the `ssh.bootstrap` option to add some extra commands which will be prepended
to the debugger call (using `&&` to join both).
## [Issues](https://github.com/WebFreak001/code-debug) ## [Issues](https://github.com/WebFreak001/code-debug)