Skip to content

Commit 2b00ba3

Browse files
committed
fixup! fixup! fixup! docs: make clearer the c8y-remote-access-plugin requirements
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
1 parent 61b700e commit 2b00ba3

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

‎docs/src/operate/c8y/remote-access.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ import BrowserWindow from '@site/src/components/BrowserWindow';
1111
You can use the remote access feature of Cumulocity to access via SSH or VNC a device that runs %%te%%,
1212
without having to expose the SSH or VNC service over a public IP address.
1313

14+
In its simplest form, the Cumulocity Remote Access feature allows you to open a shell session on the device from you tenant.
15+
However, combined with `PASSTHROUGH` option, this feature is extremely versatile
16+
and allows arbitrary TCP connections between a client on your local machine and a service on the device
17+
(such as the SSH daemon/service, or a local HTTP server).
18+
1419
When a cloud remote access operation is received by the `tedge-mapper-c8y`,
1520
a process is spawned to establish a direct communication to Cumulocity.
1621
That connection being independent of any local services,
@@ -80,3 +85,11 @@ the `c8y-remote-access-plugin` must be running as a socket activated service:
8085
</BrowserWindow>
8186

8287
:::
88+
89+
## PASSTHROUGH
90+
91+
To enable the `PASSTHROUGH` option of Cumulocity Remote Access, nothing specific has to be done on the %%te%% device,
92+
beyond enabling the `c8y-remote-access-plugin`. This option has only to be enabled on your tenant when configuring remote access.
93+
94+
However, you will have to configure your local machine to fully leverage the `PASSTHROUGH` option.
95+
For that, the recommendation is to use the [`go-c8y-cli` remoteaccess](https://c8y.app/docs/examples/remoteaccess/) command.

0 commit comments

Comments
 (0)