|
|
The project requires python ^3.7 to run. Some systems are not yet using it as default, so we recommend either [pyenv](https://github.com/pyenv/pyenv) or setting manually the binary path of poetry via:
|
|
|
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.
|
|
|
|
|
|
## Deploying
|
|
|
|
|
|
<details><summary>Deploy via Docker</summary>
|
|
|
<p>
|
|
|
|
|
|
OLKi supports out of the box Docker Compose (extensively tested), Docker Stack (less tested), and has a Docker image you can reuse for your own deployment configurations. The former two are the basic deployment options, and for the sake of simplicity, we will only showcase Docker Compose:
|
|
|
|
|
|
/!\ Before all, edit `support/docker/.env` to set your docker-specific variables. Then create and edit a `.env` to set your olki-specific variables (example in `.env.default`).
|
|
|
|
|
|
```bash
|
|
|
apt install python3.7-dev python3.7-venv libsasl2-dev libldap2-dev python3-pip
|
|
|
make deps-prod
|
|
|
~/.poetry/bin/poetry env use /usr/bin/python3.7
|
|
|
``` |
|
|
\ No newline at end of file |
|
|
# refreshing images and starting services
|
|
|
# (binds to port 80/443, edit the file to bind to 5000 if you have your own reverse proxy)
|
|
|
docker-compose -f support/docker/docker-compose.yml pull
|
|
|
docker-compose -f support/docker/docker-compose.yml up -d
|
|
|
# create a superuser
|
|
|
docker-compose -f support/docker/docker-compose.yml run olki manage createsuperuser --email "superuser@example.org" --password superpass --username superuser
|
|
|
docker-compose -f support/docker/docker-compose.yml run olki manage listusers
|
|
|
# you should see a list of all users on your instance
|
|
|
```
|
|
|
|
|
|
Your instance should be up and running on the specified port and domain, with a user to log in!
|
|
|
|
|
|
</p>
|
|
|
</details> |
|
|
\ No newline at end of file |