Skip to content

user.md

Latest commit

 

History

History
51 lines (34 loc) · 1.67 KB

user.md

File metadata and controls

51 lines (34 loc) · 1.67 KB

👥 User documentation

Presentation

Eurydice provides a solution to transfer information between two networks of different security level through a physical diode and ensuring data integrity.

In Eurydice, a file transfered through the diode is called a Transferable.

Workflow

Eurydice has two sides:

  • The sender side, also called origin ;
  • The receiver side, also called destination ;

A file can be sent from the sender side to the receiver side in three steps:

  1. Users link the sender side and the receiver side using an association token (a passphrase). The token must be copied from the sender side to the receiver side. association-token
  2. From the sender side, users can either import files or paste text directly in the text editor (the text is then sent as a .txt file). file-transfert
  3. Files are received on the receiver side associated with the sender side. Files can be downloaded, deleted and visualized through the interface. The status of each transfer is also available on the receiver side. destination

API

A user can get its API token from the GUI by clicking on its username in the header.

get_api_token

The API documentation is accessible at <https://<EURYDICE_URL>/api/docs/>

Using curl

An example using curl :

curl \
  -H "Accept: application/json" \
  -H "Authorization: Token <TOKEN>" \
  "https://<EURYDICE_URL>" \
  --request-target "/api/v1/user/me/"

Using the cli

eurydice-origin workspace create prod https://<EURYDICE_URL> <API_TOKEN>
eurydice-origin workspace use prod
eurydice-origin me