37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# Iottb
|
|
|
|
## Installation
|
|
There are a few different ways to install `iottb`.
|
|
|
|
In Linux, to install to a users local bin directory using poetry or pip:
|
|
- Move into the project root `cd path/to/iottb-project`, so that you are in the directory which contains the `pyproject.toml` file.
|
|
```bash
|
|
poetry install --editable
|
|
# or with pip
|
|
pip install -e .
|
|
```
|
|
Currently, this is the recommended method.
|
|
Alternatively install with pip into any activated environment:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
It is possible to make a single executable for you machine which you can just put in your path using pyinstaller.
|
|
1. Install pyinstaller
|
|
```bash
|
|
pip install pyinstaller
|
|
```
|
|
2. Make the executable
|
|
```bash
|
|
pyinstaller --onefile --name iottb --distpath ~/opt iottb/main.py
|
|
```
|
|
to be able to run it as `iottb` if `~/opt' is a directory on your PATH.
|
|
A executable which should be able to run on linux is included in the repo.
|
|
## Basic Invocation
|
|
|
|
## Configuration
|
|
### Env Vars
|
|
- IOTTB_CONF_HOME
|
|
|
|
By setting this variable you control where the basic iottb application
|
|
configuration should be looked for |