Skip to content

Qabel/qabel-accounting

Repository files navigation

# The Qabel Accounting Server

This project provides the accounting server for Qabel that manages Qabel-Accounts that authorize Qabel Box usage according to the Qabel Box Protocol.

Introduction

For a comprehensive documentation of the whole Qabel Platform use https://qabel.de as the main source of information. http://qabel.github.io/docs/ may provide additional technical information.

Qabel consists of multiple Projects:

Requirements

  • Docker
  • Docker-Compose

Bootstrap the Project for development

    $ git clone git@git.qabel.de/Qabel/accounting-cookiecutter.git
    to build run
    $ docker-compose -f local.yml build
    to run it
    $ docker-compose -f local.yml up
    to run tests
    $ docker-compose -f local.yml -f testing.yml up --exit-code-from django --abort-on-container-exit django

Production setup

The server exports prometheus metrics at /metrics. If those should not be public, you should block this location in the webserver.

If you have problems with CORS (Cross-Origin Resource Sharing), edit the 'CORS_ORIGIN_WHITELIST' in the configuration. For more information see [CORS middleware configuration options](https://github .com/zestedesavoir/django-cors-middleware#configuration).

Development

To use the dummy mail backend, see: django documentation for email

Insert this line in config/settings/default_settings.py :

EMAIL_BACKEND = 'django.core.mail.backends.dummy.EmailBackend'

In your django settings you have to set an API_SECRET that should be known only by the qabel-block server.

Contributing

Please refer to https://github.com/Qabel/qabel-core/blob/master/CONTRIBUTING.md