This project provides the accounting server for that manages Qabel-Accounts that authorize Qabel Box usage according to the Qabel Box Protocol.
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:
- Qabel Android Client
- Qabel Desktop Client
- Qabel Core is a library that includes the common code between both clients to keep them consistent
- Qabel Drop Server is the target server for drop messages according to the Qabel Drop Protocol
- Qabel Accounting Server manages Qabel-Accounts that authorize Qabel Box usage according to the Qabel Box Protocol
- Qabel Block Server serves as the storage backend according to the Qabel Box Protocol
- Docker
- Docker-Compose
$ 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
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).
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.
Please refer to https://github.com/Qabel/qabel-core/blob/master/CONTRIBUTING.md