Update [README] add installer options

This commit is contained in:
niclas 2024-01-16 14:35:18 +01:00
parent 8159b10e5d
commit 45aae55691

View file

@ -20,5 +20,16 @@ If you want to install AIL without the interactive mode, you can use the followi
bash INSTALL.sh [OPTIONS]
```
The following options are available:
| Flag | Default Value | Description |
| ------------------------------- | ----------------------- | ------------------------------------------------------------------------ |
| `-i`, `--interactive` | N/A | Activates an interactive installation process. |
| `--project <project_name>` | `AIL-<creation_time>` | Name of the LXD project for organizing and running the containers. |
| `--ail-name <container_name>` | `AIL-<creation_time>` | The name of the container responsible for running the AIL application. |
| `--no-lacus` | `false` | Determines whether to install the Lacus container. |
| `--lacus-name <container_name>` | `LACUS-<creation_time>` | The name of the container responsible for running the Lacus application. |
| `--partition <partition>` | `<none>` | Dedicated partition for LXD-project storage. |
## Configuration
If you installed Lacus, you can configure AIL to use it as a crawler. For further information, please refer to the [HOWTO](https://github.com/ail-project/ail-framework/blob/master/HOWTO.md)
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)