Skip to content

Commit

Permalink
Merge pull request #205 from NMD03/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Terrtia authored Jan 30, 2024
2 parents 6751592 + ce1e1f7 commit 04d29f4
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions other_installers/LXD/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path_to_image> --alias <image_alias>
```
Now you can use the image to create a container:
```bash
lxc launch <image_alias> <container_name>
```

To log into the container you need to know the automatically generated password. You can get it with the following command:
```bash
lxc exec <container_name> -- 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 <container_name>` | `AIL` | Specifies the name of the AIL container. The default is a generic name "AIL". |
| `--lacus-name <container_name>` | `Lacus` | Specifies the name of the Lacus container. The default is a generic name "Lacus". |
| `-o`, `--outputdir <directory>` | `<none>` | Sets the output directory for the LXD image files. |
| `-s`, `--sign` | `false` | Enables the signing of the generated LXD image files. |

0 comments on commit 04d29f4

Please sign in to comment.