KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

immuni-backend-otp

★ 36 Open GitHub ↗

Repository for the OTP service

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Immuni Backend OTP Service</h1>

<br />

<div align="center">
  <h3>
    </span>
    <a href="https://github.com/immuni-app/immuni-documentation">
      Documentation
    </a>
    <span> | </span>    
    <a href="CONTRIBUTING.md">
      Contributing
    </a>
  </h3>
</div>

# Table of contents

- [Context](#context)
- [Installation](#installation)
- [Contributing](#contributing)
  - [Contributors](#contributors)
- [Licence](#licence)
  - [Authors / Copyright](#authors--copyright)
  - [Third-party component licences](#third-party-component-licences)
  - [Licence details](#licence-details)

# Context
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](https://github.com/immuni-app/documentation/blob/master/README.md)
- [Product Description](https://github.com/immuni-app/documentation/blob/master/Product%20Description.md)
- [Technology Description](https://github.com/immuni-app/documentation/blob/master/Technology%20Description.md)
- [Traffic Analysis Mitigation](https://github.com/immuni-app/immuni-documentation/blob/master/Traffic%20Analysis%20Mitigation.md)

**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.**

# Installation

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

```bash
git clone --recurse-submodules git@github.com: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.

```bash
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](#contributing) section below.

# Contributing
Contributions are most welcome. Before proceeding, please read the [Code of Conduct](./CODE_OF_CONDUCT.md) for guidance on how to approach the community and create a positive environment. Additionally, please read our [CONTRIBUTING](./CONTRIBUTING.md) 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](https://github.com/immuni-app/immuni-documentation). 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.

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

# Licence

## Authors / Copyright

Please check the [AUTHORS](AUTHORS) file for extended reference.

## Third-party component licences

Please see the Technology Description’s [Backend Services Technologies](https://github.com/immuni-app/documentation/blob/master/Technology%20Description.md#backend-services-technologies) section, which also lists the corresponding licences.

## Licence details

The licence for this repository is a [GNU Affero General Public Licence version 3](https://www.gnu.org/licenses/agpl-3.0.html) (SPDX: AGPL-3.0). Please see the [LICENSE](LICENSE) file for full reference.

immuni-backend-otp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README