Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 2.1 KB

README.md

File metadata and controls

63 lines (38 loc) · 2.1 KB
Eurydice icon

Eurydice

Eurydice (Emetteur Unidirectionnel Redondant de Yottabit pour le Dialogue Intergiciel avec Correction d'Erreur) provides an interface to transfer files through a physical diode using the [Lidi](https://github.com/ANSSI-FR/lidi/) utility.

📁 Project structure

See ARCHITECTURE.md.

📦 Versioning

This project adheres to the Semantic Versioning specification. Versions are represented as git tags. You can view the release history with the accompanying changelog here.

🔨 Prerequisites

🐳 Docker images

The compiled docker image are publicly available on the docker hub.

Dockerfiles are provided for each component.

The following images are available:

  • anssi/eurydice-backend
    • docker image for the backend service (API, sender, database trimmer)
  • anssi/eurydice-frontend
    • docker image for the server responsible for serving the frontend

The following tags are available for the aforementioned docker images:

  • 0.x.x docker image built for a specific tagged release

🚧 Development

See docs/developers.md.

🚀 Deployment in production & administration

See docs/administrators.md.

▶️ Usage

👩‍💻 HTTP API

See documentation directories:

🙏 Credits