@@ -7,11 +7,19 @@ Lima supports automatic port-forwarding of localhost ports from guest to host.
7
7
8
8
## Port forwarding types
9
9
10
+ Lima supports two port forwarder: SSH and GRPC.
11
+
12
+ The default port forwarder is SSH.
13
+
14
+ The default was once changed to GRPC in Lima v1.0, but it was reverted to SSH in v1.0.1 due to stability reasons.
15
+
16
+ In future, it is expected that GRPC will take over the default position again.
17
+
10
18
### Using SSH
11
19
12
- SSH based port forwarding is the default and current model that is supported in Lima prior to v1.0 .
20
+ SSH based port forwarding is the default and current model that is supported in Lima.
13
21
14
- To use SSH forwarding use the below command
22
+ To explicitly use SSH forwarding use the below command
15
23
16
24
``` bash
17
25
LIMA_SSH_PORT_FORWARDER=true limactl start
@@ -22,18 +30,18 @@ LIMA_SSH_PORT_FORWARDER=true limactl start
22
30
- Doesn't support UDP based port forwarding
23
31
- Spans child process on host for running SSH master.
24
32
25
- ### Using GRPC (Default since Lima v1.0)
33
+ ### Using GRPC
26
34
27
35
| ⚡ Requirement | Lima >= 1.0 |
28
36
| ---------------| -------------|
29
37
30
38
In this model, lima uses existing GRPC communication (Host <-> Guest) to tunnel port forwarding requests.
31
39
For each port forwarding request, a GRPC tunnel is created and this will be used for transmitting data
32
40
33
- To disable this feature and use SSH forwarding use the following environment variable
41
+ To enable this feature, set ` LIMA_SSH_PORT_FORWARDER ` to ` false ` :
34
42
35
43
``` bash
36
- LIMA_SSH_PORT_FORWARDER=true limactl start
44
+ LIMA_SSH_PORT_FORWARDER=false limactl start
37
45
```
38
46
39
47
#### Advantages
0 commit comments