From ce1e1f791347f435a609875543e6c30e049311a7 Mon Sep 17 00:00:00 2001 From: Niclas Dauster <83672752+NMD03@users.noreply.github.com> Date: Tue, 30 Jan 2024 09:15:50 +0100 Subject: [PATCH] Update README.md --- other_installers/LXD/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/other_installers/LXD/README.md b/other_installers/LXD/README.md index 59c779cf..2c504f9f 100644 --- a/other_installers/LXD/README.md +++ b/other_installers/LXD/README.md @@ -33,3 +33,36 @@ The following options are available: ## Configuration If you installed Lacus, you can configure AIL to use it as a crawler. For further information, please refer to the [HOWTO.md](https://github.com/ail-project/ail-framework/blob/master/HOWTO.md) + +## Using Images to run AIL +If you want to use images to install AIL, you can download them from the ail-project [image website](https://images.ail-project.org/) + +After downloading the images, you can import them into LXD using the following command: +```bash +lxc image import --alias +``` +Now you can use the image to create a container: +```bash +lxc launch +``` + +To log into the container you need to know the automatically generated password. You can get it with the following command: +```bash +lxc exec -- bash -c "grep '^password=' /home/ail/ail-framework/DEFAULT_PASSWORD | cut -d'=' -f2" +``` + +If you also want to use Lacus, you can do the same with the Lacus image. After that, you can configure AIL to use Lacus as a crawler. For further information, please refer to the [HOWTO.md](https://github.com/ail-project/ail-framework/blob/master/HOWTO.md). + +## Building the images locally +If you want to build the images locally, you can use the `build.sh` script: +```bash +bash build.sh [OPTIONS] +``` +| Flag | Default Value | Description | +| ------------------------------- | ------------- | --------------------------------------------------------------------------------- | +| `--ail` | `false` | Activates the creation of the AIL container. | +| `--lacus` | `false` | Activates the creation of the Lacus container. | +| `--ail-name ` | `AIL` | Specifies the name of the AIL container. The default is a generic name "AIL". | +| `--lacus-name ` | `Lacus` | Specifies the name of the Lacus container. The default is a generic name "Lacus". | +| `-o`, `--outputdir ` | `` | Sets the output directory for the LXD image files. | +| `-s`, `--sign` | `false` | Enables the signing of the generated LXD image files. |