Installation/Setup (Devel system)

1. Prepare your local system:

   $ sudo zypper in docker docker-compose gcc python3-devel
   

2. Check out the sources:

   $ git clone git@github.com:openSUSE/orthos2.git
   $ cd orthos2/
   

3. Create the virtual Python environment, activate it and update pip

   $ python3 -m venv .venv
   $ . .venv/bin/activate
   $ pip install --upgrade pip
   Collecting pip
   ...
   

4. Install the required Python modules for development:

   $ pip install -r requirements-devel.txt -r docs/requirements.docs.txt
   Collecting django
   ...
   

5. Generate the required secrets to bring up the Docker Compose Stack:

   python3 docker/manage-secrets.py
   

6. Run the test server:

   docker compose -f compose.common.yaml -f compose.dev.yaml -f compose.dev.override.yml up -d
   

   If you wish to test for the production environment instead, first bring up the dev stack once (as above) to obtain a Netbox API token, then supply it as a Docker secret: .. code-block:

   echo "<token from ORTHOS2_NETBOX_TOKEN in the running orthos2 container>" > docker/secrets/NetboxToken
   

   and run .. code-block:

   docker compose -f compose.common.yaml -f compose.testing.yaml -f compose.dev.override.yml up -d
   

7. Edit your /etc/hosts file and include the following line:

   127.0.0.1 authentik.orthos2.test orthos2.orthos2.test cobbler.orthos2.test netbox.orthos2.test testmachine.orthos2.test
   

8. Open your browser and go to http://orthos2.orthos2.test (use the superuser login here). The login password for the admin user you can find in docker/orthos/orthos2dev.env.