pierreozoux/eurydice

A user-friendly solution to transfer files through a physical diode using the Lidi utility, complete with data retention, file history, user accounts and admin management. Provides a scriptable API and a web interface.

โ˜… 0Forks 0GitHub โ†—Compare

README

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

Contributors

gmolveau-anssi

Issues