Browse Source

Document the new remoteRoot configuration option

* sphinx-doc/debugger.rst:
* sphinx-doc/setup.rst: Document remoteRoot.
pull/9/head
Nicolas Petton 2 years ago
parent
commit
10d8a24a89
No known key found for this signature in database GPG Key ID: E8BCD7866AFCF978
2 changed files with 26 additions and 0 deletions
  1. +21
    -0
      sphinx-doc/debugger.rst
  2. +5
    -0
      sphinx-doc/setup.rst

+ 21
- 0
sphinx-doc/debugger.rst View File

@ -44,6 +44,27 @@ Overriding the ``sourceMapPathOverrides`` option will erase the default mapping.
.. TIP:: If sourcemaps do not seem to work, you can see how Indium resolves
sourcemap paths using ``M-x indium-list-sourcemap-sources``.
.. _remoteroot:
Setting a different remote root (NodeJS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When running a NodeJS application on a remote machine or inside a Docker
container, your application's root folder path might not correspond to where
their source code is located on your local disk.
In this case, you can tell Indium to replace the ``root`` path with a different
location using the ``remoteRoot`` configuration option.
{
...
"remoteRoot": "/var/task"
}
Note that ``remoteRoot`` can be used together with the ``root`` configuration
option.
Blackboxing scripts
-------------------


+ 5
- 0
sphinx-doc/setup.rst View File

@ -107,6 +107,11 @@ Here is an example configuration for debugging Gulp tasks::
]
}
When the NodeJS application runs on another computer (or inside a container like
Docker), a custom remote project root path can be set with ``remoteRoot``. See
:ref:`remoteroot` for more information on script paths and debugging.
.. _starting_indium:
Starting Indium


Loading…
Cancel
Save