Skip to content

Commit

Permalink
Merge pull request #2881 from AkihiroSuda/docs
Browse files Browse the repository at this point in the history
website: misc updates
  • Loading branch information
jandubois authored Nov 8, 2024
2 parents 0e93110 + 3f17abf commit 97ef064
Show file tree
Hide file tree
Showing 20 changed files with 37 additions and 13 deletions.
Empty file modified website/content/en/docs/_index.md
100755 → 100644
Empty file.
13 changes: 12 additions & 1 deletion website/content/en/docs/config/environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Environment Variables
weight: 6
weight: 80
---

## Environment Variables
Expand Down Expand Up @@ -47,6 +47,17 @@ This page documents the environment variables used in Lima.
lima
```
### `LIMA_SSH_PORT_FORWARDER`
- **Description**: Specifies to use the SSH port forwarder (slow, stable) instead of gRPC (fast, unstable)
- **Default**: `true`
- **Usage**:
```sh
export LIMA_SSH_PORT_FORWARDER=false
```
- **Note**: It is expected that this variable will be set to `false` by default in future
when the gRPC port forwarder is well matured.
### `LIMA_USERNET_RESOLVE_IP_ADDRESS_TIMEOUT`
- **Description**: Specifies the timeout duration for resolving the IP address in usernet.
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Port Forwarding
weight: 50
weight: 31
---

Lima supports automatic port-forwarding of localhost ports from guest to host.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 7 additions & 7 deletions website/content/en/docs/faq/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ weight: 6
- [Filesystem sharing](#filesystem-sharing)
- ["Filesystem is slow"](#filesystem-is-slow)
- ["Filesystem is not writable"](#filesystem-is-not-writable)
- ["Filesystem is unmounted after upgrading Lima to v1.0 (pre-release)"](#filesystem-is-unmounted-after-upgrading-lima-to-v10-pre-release)
- ["Filesystem is unmounted after upgrading Lima to v1.0"](#filesystem-is-unmounted-after-upgrading-lima-to-v10)
- [External projects](#external-projects)
- ["I am using Rancher Desktop. How to deal with the underlying Lima?"](#i-am-using-rancher-desktop-how-to-deal-with-the-underlying-lima)
- ["Hints for debugging other problems?"](#hints-for-debugging-other-problems)
Expand All @@ -42,9 +42,9 @@ weight: 6
### Generic
#### "How does Lima work?"

- Hypervisor: [QEMU with HVF accelerator (default), or Virtualization.framework](../config/vmtype/)
- Filesystem sharing: [Reverse SSHFS (default), or virtio-9p-pci aka virtfs, or virtiofs](../config/mount/)
- Port forwarding: `ssh -L`, automated by watching `/proc/net/tcp` and `iptables` events in the guest
- Hypervisor: [QEMU (default on Linux), or Virtualization.framework (default on macOS)](../config/vmtype/)
- Filesystem sharing: [Reverse SSHFS, virtio-9p-pci aka virtfs (default for QEMU), or virtiofs (default for Virtualization.framework)](../config/mount/)
- Port forwarding: [`ssh -L`](../config/port), automated by watching `/proc/net/tcp` and `iptables` events in the guest

#### "What's my login password?"
Password is disabled and locked by default.
Expand All @@ -53,7 +53,7 @@ You have to use `limactl shell bash` (or `lima bash`) to open a shell.
Alternatively, you may also directly ssh into the guest: `ssh -p 60022 -i ~/.lima/_config/user -o NoHostAuthenticationForLocalhost=yes 127.0.0.1`.

#### "Does Lima work on ARM Mac?"
Yes, it should work, but not regularly tested on ARM (due to lack of CI).
Yes

#### "Can I run non-Ubuntu guests?"
AlmaLinux, Alpine, Arch Linux, Debian, Fedora, openSUSE, Oracle Linux, and Rocky are also known to work.
Expand Down Expand Up @@ -231,9 +231,9 @@ mounts:

Run `limactl edit <INSTANCE>` to open the YAML editor for an existing instance.

#### "Filesystem is unmounted after upgrading Lima to v1.0 (pre-release)"
#### "Filesystem is unmounted after upgrading Lima to v1.0"

Lima v1.0 (pre-release) changed the default mount type for QEMU from `reverse-sshfs` to `9p`.
Lima v1.0 changed the default mount type for QEMU from `reverse-sshfs` to `9p`.

The `9p` mount type is known to be incompatible with the following guest operating systems:
- AlmaLinux, CentOS Stream, Oracle Linux, and RockyLinux
Expand Down
File renamed without changes.
3 changes: 0 additions & 3 deletions website/content/en/docs/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: Installation
weight: 1
---
> **NOTE**
> Lima is not regularly tested on ARM Mac (due to lack of CI).
Prerequisite:

- QEMU 7.0 or later (Required, only if QEMU driver is used)
Expand Down
16 changes: 16 additions & 0 deletions website/content/en/docs/security/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Security
weight: 350
---

## Security model

See <https://github.com/cncf/tag-security/blob/main/community/assessments/projects/lima/self-assessment.md>.

## Reporting vulnerabilities

See <https://github.com/lima-vm/.github/blob/main/SECURITY.md>.

## Past vulnerabilities

See <https://github.com/lima-vm/lima/security>.
2 changes: 1 addition & 1 deletion website/content/en/docs/talks/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Talks
weight: 10
weight: 450
---

## 2022
Expand Down

0 comments on commit 97ef064

Please sign in to comment.