|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
- The project requires python ^3.7 to run. Either setup a virtualenv beforehand with the proper version of python, or setup a more recent interpreter system-wide: https://framagit.org/synalp/olki/olki/snippets/3532.
|
|
|
- After sourcing into your virtualenv, install poetry with "pip install poetry"
|
|
|
- Install environ (warning: pip install environ does not give the correct version !) and other dependencies with "poetry install"
|
|
|
|
|
|
## Deploying
|
|
|
|
|
|
<details><summary>Deploy via Docker</summary>
|
... | ... | @@ -30,6 +24,18 @@ Your instance should be up and running on the specified port and domain, with a |
|
|
</p>
|
|
|
</details>
|
|
|
|
|
|
<details><summary>Deploy on your system</summary>
|
|
|
|
|
|
**This method is not supported in production, please use the the docker setup to avoid errors**
|
|
|
|
|
|
- The project requires python ^3.8 to run.
|
|
|
- After sourcing into your newly created virtualenv, install poetry with "pip install poetry"
|
|
|
- Install dependencies with "make deps-dev-be"
|
|
|
- Create your `.env` based on the `.env.default` template.
|
|
|
- Ensure you have redis and postgresql running. Create a `olki` database.
|
|
|
- Run OLKi with `make serve-dev-be`.
|
|
|
</details>
|
|
|
|
|
|
## Administrating
|
|
|
|
|
|
You can do most tasks from the CLI, using the `manage` task. Depending on wether your installation is local or via docker-compose, you will be calling that task differently: via `make` when local, via `docker-compose -f support/docker/docker-compose.yml run olki` when via docker-compose.
|
... | ... | |