From 957f04ea020dc886d06770cdea110794f63bea5e Mon Sep 17 00:00:00 2001 From: Baptist BENOIST Date: Wed, 10 Feb 2016 21:57:13 +0100 Subject: [PATCH] Document the ssh.bootstrap configuration option --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fdfbd2..852ac20 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,9 @@ request. "password": "password123", "user": "remoteUser", "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 +` 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) \ No newline at end of file