• Context
• Installation
• Contributing
  • Contributors
• Licence
  • Authors / Copyright
  • Third-party component licences
  • Licence details

This repository contains the source code of Immuni's OTP Service. More detailed information about Immuni can be found in the following documents:

• High-Level Description
• Product Description
• Technology Description
• Traffic Analysis Mitigation

Please take the time to read and consider the other repositories in full before digging into the source code or opening an Issue. They contain a lot of details that are fundamental to understanding the source code and this repository's documentation.

This backend service comes with an out-of-the-box installation, leveraging Docker containers. Please ensure that Docker is installed on your computer (docker-compose version >= 1.25.5).

git clone --recurse-submodules [email protected]:immuni-app/immuni-backend-otp.git
cd immuni-backend-otp/docker
docker-compose build \
    --build-arg GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD) \
    --build-arg GIT_SHA=$(git rev-parse --verify HEAD) \
    --build-arg GIT_TAG=$(git tag --points-at HEAD | cat) \
    --build-arg BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")

The backend service can then be launched.

docker-compose up

At this point, the service is available at http://0.0.0.0:5000/swagger.

For more information about how the project is generated and structured, please refer to the Contributing section below.

Contributions are most welcome. Before proceeding, please read the Code of Conduct for guidance on how to approach the community and create a positive environment. Additionally, please read our CONTRIBUTING file, which contains guidance on ensuring a smooth contribution process.

The Immuni project is composed of different repositories—one for each component or service. Please use this repository for contributions strictly relevant to Immuni's backend services. To propose a feature request, please open an issue in the Documentation repository. This lets everyone involved see it, consider it, and participate in the discussion. Opening an issue or pull request in this repository may slow down the overall process.

Here is a list of Immuni's contributors. Thank you to everyone involved for improving Immuni, day by day.

Copyright 2020 (c) Presidenza del Consiglio dei Ministri.

Please check the AUTHORS file for extended reference.

Please see the Technology Description’s Backend Services Technologies section, which also lists the corresponding licences.

The licence for this repository is a GNU Affero General Public Licence version 3 (SPDX: AGPL-3.0). Please see the LICENSE file for full reference.