Skip to content

moved environment variables #3476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions website/content/en/docs/config/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ weight: 80

This page documents the environment variables used in Lima.

### `LIMA_HOME`

- **Description**: Specifies the Lima home directory.
- **Default**: `~/.lima`
- **Usage**:
```sh
export LIMA_HOME=~/.lima-custom
lima
```

### `LIMA_INSTANCE`

- **Description**: Specifies the name of the Lima instance to use.
Expand Down Expand Up @@ -107,3 +117,57 @@ This page documents the environment variables used in Lima.
```
- **Note**: It is an experimental setting and has no guarantees being ever promoted to stable. It may be removed
or changed at any stage of project development.

### `QEMU_SYSTEM_AARCH64`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the variables should be listed in alphabetical order.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do the changes , thanks


- **Description**: Path to the `qemu-system-aarch64` binary.
- **Default**: `qemu-system-aarch64` found in `$PATH`
- **Usage**:
```sh
export QEMU_SYSTEM_AARCH64=/usr/local/bin/qemu-system-aarch64
```

### `QEMU_SYSTEM_ARM`

- **Description**: Path to the `qemu-system-arm` binary.
- **Default**: `qemu-system-arm` found in `$PATH`
- **Usage**:
```sh
export QEMU_SYSTEM_ARM=/usr/local/bin/qemu-system-arm
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are also riscv64 and s390x

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will add and push.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

### `QEMU_SYSTEM_PPC64`

- **Description**: Path to the `qemu-system-ppc64` binary.
- **Default**: `qemu-system-ppc64` found in `$PATH`
- **Usage**:
```sh
export QEMU_SYSTEM_PPC64=/usr/local/bin/qemu-system-ppc64
```

### `QEMU_SYSTEM_RISCV64`

- **Description**: Path to the `qemu-system-riscv64` binary.
- **Default**: `qemu-system-riscv64` found in `$PATH`
- **Usage**:
```sh
export QEMU_SYSTEM_RISCV64=/usr/local/bin/qemu-system-riscv64
```

### `QEMU_SYSTEM_S390X`

- **Description**: Path to the `qemu-system-s390x` binary.
- **Default**: `qemu-system-s390x` found in `$PATH`
- **Usage**:
```sh
export QEMU_SYSTEM_S390X=/usr/local/bin/qemu-system-s390x
```

### `QEMU_SYSTEM_X86_64`

- **Description**: Path to the `qemu-system-x86_64` binary.
- **Default**: `qemu-system-x86_64` found in `$PATH`
- **Usage**:
```sh
export QEMU_SYSTEM_X86_64=/usr/local/bin/qemu-system-x86_64
```
28 changes: 1 addition & 27 deletions website/content/en/docs/dev/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,32 +130,6 @@ The directory contains the following files:
- `<ALGO>.digest`: digest of the data, in OCI format.
e.g., file name `sha256.digest`, with content `sha256:5ba3d476707d510fe3ca3928e9cda5d0b4ce527d42b343404c92d563f82ba967`

## Environment variables

- `$LIMA_HOME`: The "Lima home directory" (see above).
- Default : `~/.lima`

- `$LIMA_INSTANCE`: `lima ...` is expanded to `limactl shell ${LIMA_INSTANCE} ...`.
- Default : `default`

- `$LIMA_SHELL`: `lima ...` is expanded to `limactl shell --shell ${LIMA_SHELL} ...`.
- No default : will use the user's shell configured inside the instance

- `$LIMA_TEMPLATES_PATH`: A list of directories to locate templates via
the `template://` schema.
- Default: the `/usr/local/share/lima/templates` directory.

- `$LIMA_WORKDIR`: `lima ...` is expanded to `limactl shell --workdir ${LIMA_WORKDIR} ...`.
- No default : will attempt to use the current directory from the host

- `$QEMU_SYSTEM_X86_64`: path of `qemu-system-x86_64`
- Default: `qemu-system-x86_64` in `$PATH`

- `$QEMU_SYSTEM_AARCH64`: path of `qemu-system-aarch64`
- Default: `qemu-system-aarch64` in `$PATH`

- `$QEMU_SYSTEM_ARM`: path of `qemu-system-arm`
- Default: `qemu-system-arm` in `$PATH`

## Ansible
The instance directory contains an inventory file, that might be used with Ansible playbooks and commands.
Expand Down Expand Up @@ -213,4 +187,4 @@ The volume label is "cidata", as defined by [cloud-init NoCloud](https://docs.cl

![](/images/internals/lima-sequence-diagram.png)

(based on Lima 0.8.3)
(based on Lima 0.8.3)