Skip to content

Commit 72c4cbe

Browse files
authored
Fixed formatting and links (#261)
Fixed numbered list style in docs/services/virtualmachines/rdp-tunnelling.md. 'pre-commit run --all-files' expects all elements of a numbered list to start with '1.' Fixed docs/safe-haven-services/tre-container-user-guide/workflow-examples.md's internal links
1 parent 804fe2c commit 72c4cbe

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

docs/safe-haven-services/tre-container-user-guide/workflow-examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ ces-run podman --gpu ghcr.io/$GHCR_NAMESPACE/pytorch-test:v1.1
9999

100100
### E1 - Step 4. Pull and run in the TRE
101101

102-
The container can be imported and run inside the TRE using the same commands as the [previous step](#e1---step-3-test-in-ces-test-environment).
102+
The container can be imported and run inside the TRE using the same commands as the [previous step](#e1-step-3-test-in-ces-test-environment).
103103

104104
## Example 2 - Python ML
105105

@@ -272,7 +272,7 @@ ces-run podman --gpu ghcr.io/$GHCR_NAMESPACE/python-ml-test:v1.1
272272

273273
### E2 - Step 4. Pull and run in the TRE
274274

275-
We can import and run the container in the TRE using the commands from the [earlier step](#e2---step-3-test-in-ces-test-environment).
275+
We can import and run the container in the TRE using the commands from the [earlier step](#e2-step-3-test-in-ces-test-environment).
276276

277277
## Example 3 - Interactive RStudio Rocker container
278278

@@ -485,4 +485,4 @@ The container is running successfully if:
485485

486486
### E3 - Step 4. Pull and run in the TRE
487487

488-
The container can then be imported inside the TRE using the same commands as [Step 3](#e3---step-3-test-in-ces-test-environment).
488+
The container can then be imported inside the TRE using the same commands as [Step 3](#e3-step-3-test-in-ces-test-environment).

docs/services/virtualmachines/rdp-tunnelling.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,8 @@ By setting up an SSH tunnel, a local port is forwarded to the remote server's RD
1414
### Steps
1515

1616
1. Jump host (-J): connect first to the eidf_gateway as an intermediary before reaching the target VM. Authentication is achieved using the identity file provided by the host (-i).
17-
18-
2. Local Port Forwarding (-L): Forwards local port 12345 to localhost:3389 on the remote machine, allowing RDP access via localhost:12345.
19-
20-
3. Configure a RDP client (for example 'Windows App') to connect to `localhost:<local_forwarded_port>` instead of directly accessing the remote machine's IP. Then connect on the remote server as 'username'.
17+
1. Local Port Forwarding (-L): Forwards local port 12345 to localhost:3389 on the remote machine, allowing RDP access via localhost:12345.
18+
1. Configure a RDP client (for example 'Windows App') to connect to `localhost:<local_forwarded_port>` instead of directly accessing the remote machine's IP. Then connect on the remote server as 'username'.
2119

2220
### Example
2321

@@ -93,30 +91,30 @@ Friendly Name: <ProjectID> Remote Connection via local port
9391
The Microsoft Windows documentation [Remote Desktop Connection](https://support.microsoft.com/en-gb/windows/how-to-use-remote-desktop-5fe128d5-8fb1-7a23-3b8a-41e636865e8c) is relevant from step 2 "_Use Remote Desktop to connect to the PC you set up_" onwards. The Remote Desktop Connection program is preinstalled on Windows machines.
9492

9593
1. Open the 'Remote Desktop Connection' program (`mstsc` in Run)
96-
2. Input `localhost:<port forwarded to>` e.g. `localhost:23001` as the connection name![Windows Remote Desktop](../../images/access/rdp_client_connect/Windows_Remote_Desktop.png)
97-
3. Click 'Connect'
98-
4. Input VDI login credentials once prompted at the login screen
94+
1. Input `localhost:<port forwarded to>` e.g. `localhost:23001` as the connection name![Windows Remote Desktop](../../images/access/rdp_client_connect/Windows_Remote_Desktop.png)
95+
1. Click 'Connect'
96+
1. Input VDI login credentials once prompted at the login screen
9997

10098
### macOS
10199

102100
These instructions use the [Microsoft Windows App](https://learn.microsoft.com/en-us/windows-app/) a free program available from the [Apple App Store](https://apps.apple.com/us/app/windows-app/id1295203466?mt=12).
103101

104102
1. Open the Windows App -> Click '+' -> Add PC
105-
2. Input into 'PC Name' the forwarded port on the local machine `localhost:<port forwarded to>` e.g. `localhost:23001`![macOS server input](../../images/access/rdp_client_connect/macos_ip_input.png)
106-
3. Also add a 'friendly name' to describe the device being connected to
107-
4. Leave all other options as defaults at this stage
108-
5. Click Add
109-
6. Double-click on the newly created PC to connect
110-
7. You will be prompted for the VDI username and password
103+
1. Input into 'PC Name' the forwarded port on the local machine `localhost:<port forwarded to>` e.g. `localhost:23001`![macOS server input](../../images/access/rdp_client_connect/macos_ip_input.png)
104+
1. Also add a 'friendly name' to describe the device being connected to
105+
1. Leave all other options as defaults at this stage
106+
1. Click Add
107+
1. Double-click on the newly created PC to connect
108+
1. You will be prompted for the VDI username and password
111109

112110
### Linux
113111

114112
The following uses [Remmina](https://remmina.org), a stable Linux RDP client available via most package managers.
115113

116114
1. Install and open Remmina
117-
2. Select "Add a new connection profile" in the top right for the connection profile window to appear![linux add new connection](../../images/access/rdp_client_connect/Add_New_Connection_Remmina.png)
118-
3. Ensure that 'Protocol' is set to RDP
119-
4. In the 'Server' field input the localhost and forwarded port `localhost:<port forwarded to>` e.g. `localhost:23001`![Linux configuration via Remmina](../../images/access/rdp_client_connect/Connection_Config_Remmina.png)
120-
5. Enter a 'Friendly Name' to describe the device being connected to
121-
6. Leave the 'Username' and 'Password' fields blank at this stage. After your first successful connection, save your VDI credentials here for easier connection in the future
122-
7. Click Save and Connect to start the remote desktop connection. You will be able to double-click on the friendly name in the main Remmina pane the next time you want to connect to the machine
115+
1. Select "Add a new connection profile" in the top right for the connection profile window to appear![linux add new connection](../../images/access/rdp_client_connect/Add_New_Connection_Remmina.png)
116+
1. Ensure that 'Protocol' is set to RDP
117+
1. In the 'Server' field input the localhost and forwarded port `localhost:<port forwarded to>` e.g. `localhost:23001`![Linux configuration via Remmina](../../images/access/rdp_client_connect/Connection_Config_Remmina.png)
118+
1. Enter a 'Friendly Name' to describe the device being connected to
119+
1. Leave the 'Username' and 'Password' fields blank at this stage. After your first successful connection, save your VDI credentials here for easier connection in the future
120+
1. Click Save and Connect to start the remote desktop connection. You will be able to double-click on the friendly name in the main Remmina pane the next time you want to connect to the machine

0 commit comments

Comments
 (0)