Skip to content

Commit

Permalink
Merge pull request #428 from stgraber/doc
Browse files Browse the repository at this point in the history
Improve installation instructions
  • Loading branch information
brauner authored Jan 24, 2024
2 parents 2476be2 + 0f4fa65 commit f9d7e39
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 58 deletions.
91 changes: 43 additions & 48 deletions doc/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,33 +32,50 @@ Packages are available for a number of Linux distributions, either in their main

````{tabs}
```{group-tab} Debian and Ubuntu
Currently the easiest way to install Incus is to use the Debian or Ubuntu packages provided by [Zabbly](https://zabbly.com).
```{group-tab} Arch Linux
Incus and all of its dependencies are available in Arch Linux's main repository as `incus`.
There are two repositories available, one for the current stable release and one for daily (untested) builds.
Install Incus with:
Installation instructions may be found here: [`https://github.com/zabbly/incus`](https://github.com/zabbly/incus)
pacman -S incus
1. Allow your user to control Incus
Please report packaging issues [here](https://gitlab.archlinux.org/archlinux/packaging/packages/incus).
```
Access to Incus in the packages above is controlled through two groups:
```{group-tab} Debian
There are two options currently available to Debian users.
- `incus` allows basic user access, no configuration and all actions restricted to a per-user project.
- `incus-admin` allows full control over Incus.
1. Native `incus` package
To control Incus without having to run all commands as root, you can add yourself to the `incus-admin` group:
A native `incus` package is currently available in the Debian testing and unstable repositories.
This package will be featured in the upcoming Debian 13 (`trixie`) release.
sudo adduser YOUR-USERNAME incus-admin
newgrp incus-admin
On such systems, just running `apt install incus` will get Incus installed.
The `newgrp` step is needed in any terminal that interacts with Incus until you restart your user session.
1. Zabbly package repository
1. Initialize Incus with:
[Zabbly](https://zabbly.com) provides up to date and supported Incus packages for Debian stable releases (11 and 12).
Those packages contain everything needed to use all Incus features.
incus admin init --minimal
Up to date installation instructions may be found here: [`https://github.com/zabbly/incus`](https://github.com/zabbly/incus)
```
```{group-tab} Fedora
RPM packages of Incus and its dependencies are not yet available via official Fedora repositories but via the [`ganto/lxc4`](https://copr.fedorainfracloud.org/coprs/ganto/lxc4/) Community Project (COPR) repository.
Install the COPR plugin for `dnf` and then enable the COPR repository:
This will create a minimal setup with default options.
If you want to tune the initialization options, see {ref}`initialize` for more information.
dnf install 'dnf-command(copr)'
dnf copr enable ganto/lxc4
Install Incus with:
dnf install incus
For the additional setup steps see [Getting started with Incus on Fedora](https://github.com/ganto/copr-lxc4/wiki/Getting-Started-with-Incus-on-Fedora).
Note that this is not an official project of Incus nor Fedora.
Please report packaging issues [here](https://github.com/ganto/copr-lxc4/issues).
```
```{group-tab} Gentoo
Expand Down Expand Up @@ -88,18 +105,6 @@ Start the daemon:
- **`openrc`**: `rc-service incus start`
- **`systemd`**: `systemctl start incus`
Initialize Incus, needs to be done once after a new installation:
incus admin init
or
incus admin init --minimal
which will just use default settings without prompting for choices. See {ref}`initialize` for more information.
Log in to your user and start using Incus through `incus` command.
```
```{group-tab} NixOS
Expand All @@ -120,32 +125,22 @@ Finally, you can add users to the `incus-admin` group to provide non-root access
For any NixOS specific issues, please [file an issue](https://github.com/NixOS/nixpkgs/issues/new/choose) in the package repository.
```
```{group-tab} Fedora
RPM packages of Incus and its dependencies are not yet available via official Fedora repositories but via the [`ganto/lxc4`](https://copr.fedorainfracloud.org/coprs/ganto/lxc4/) Community Project (COPR) repository.
```{group-tab} Ubuntu
There are two options currently available to Ubuntu users.
Install the COPR plugin for `dnf` and then enable the COPR repository:
1. Native `incus` package
dnf install 'dnf-command(copr)'
dnf copr enable ganto/lxc4
A native `incus` package is currently available in the Ubuntu development repository.
This package will be featured in the upcoming Ubuntu 24.04 (noble) release.
Install Incus with:
On such systems, just running `apt install incus` will get Incus installed.
dnf install incus
1. Zabbly package repository
For the additional setup steps see [Getting started with Incus on Fedora](https://github.com/ganto/copr-lxc4/wiki/Getting-Started-with-Incus-on-Fedora).
[Zabbly](https://zabbly.com) provides up to date and supported Incus packages for Ubuntu LTS releases (20.04 and 22.04).
Those packages contain everything needed to use all Incus features.
Note that this is not an official project of Incus nor Fedora.
Please report packaging issues [here](https://github.com/ganto/copr-lxc4/issues).
```
```{group-tab} Arch Linux
Incus and all of its dependencies are available in Arch Linux's main repository as `incus`.
Install Incus with:
pacman -S incus
Please report packaging issues [here](https://gitlab.archlinux.org/archlinux/packaging/packages/incus).
Up to date installation instructions may be found here: [`https://github.com/zabbly/incus`](https://github.com/zabbly/incus)
```
````
Expand Down
24 changes: 14 additions & 10 deletions doc/tutorial/first_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ After going through these steps, you will have a general idea of how to use Incu

## Install and initialize Incus

Currently the easiest way to install Incus is to use the Debian or Ubuntu packages provided by [Zabbly](https://zabbly.com).
There are two repositories available, one for the current stable release and one for daily (untested) builds.
1. Install the Incus package

Installation instructions may be found here: [`https://github.com/zabbly/incus`](https://github.com/zabbly/incus)
Incus is available on most common Linux distributions.

If you prefer a different installation method, see {ref}`installing`.
For detailed distribution-specific instructions, refer to {ref}`installing`.

1. Allow your user to control Incus

Expand All @@ -29,17 +28,22 @@ If you prefer a different installation method, see {ref}`installing`.

The `newgrp` step is needed in any terminal that interacts with Incus until you restart your user session.

1. Initialize Incus with:

incus admin init --minimal

This will create a minimal setup with default options.
If you want to tune the initialization options, see {ref}`initialize` for more information.
1. Initialize Incus

```{note}
If you are migrating from an existing LXD installation, skip this step and refer to {ref}`server-migrate-lxd` instead.
```

Incus requires some initial setup for networking and storage. This can be done interactively through:

incus admin init

Or a basic automated configuration can be applied with just:

incus admin init --minimal

If you want to tune the initialization options, see {ref}`initialize` for more information.

## Launch and inspect instances

Incus is image based and can load images from different image servers.
Expand Down

0 comments on commit f9d7e39

Please sign in to comment.