OS2mo Init

OS2mo Initialiser.

Build

docker build . -t os2mo-init

Which yields:

...
Successfully built ...
Successfully tagged os2mo-init:latest

After which you can run:

docker run --rm os2mo-init --help

Which yields:

Usage: __main__.py [OPTIONS]

Options:
  --lora-url TEXT              Address of the LoRa host  [env var: LORA_URL;
                               default: http://localhost:8080]

  --root-org-name TEXT         Name of the root organisation  [env var:
                               ROOT_ORG_NAME; default: Magenta Aps]

  --municipality-code INTEGER  Municipality code of the root organisation
                               [default: 1234]

  --help                       Show this message and exit.

  In addition to the listed environment variables, the program accepts
  parameters from environment variables using the format
  'OS2MO_INIT_<OPTION>'; for example 'OS2MO_INIT_MUNICIPALITY_CODE'.
  Furthermore, the following environment variables are used to establish a
  connection to LoRa:

  CLIENT_ID [default: mo]
  CLIENT_SECRET [required]
  AUTH_REALM [default: lora]
  AUTH_SERVER [default: http://localhost:8080/auth]

Usage

The primary usage of the tool is to initialise OS2mo's LoRa database.

docker run --rm os2mo-init --client-secret='hunter2'

Versioning

This project uses Semantic Versioning with the following strategy:

• MAJOR: Incompatible changes to existing commandline interface
• MINOR: Backwards compatible updates to commandline interface
• PATCH: Backwards compatible bug fixes

The fileformat is versioned directly, and the version is exported in the file itself.

License

• This project: MPL-2.0

This project uses REUSE for licensing. All licenses can be found in the LICENSES folder of the project.