caesar-transfer/README.md
2024-05-31 10:04:47 +02:00

2.2 KiB

Caesar-Transfer

caesar-gui-send-linux

This program provides a simple end-to_end encrypted filesharing system. Either the cli version or the gui version can be used for this.

Prerequisites

Rust toolchain installed

Installation

  1. Clone the repository:
git clone https://github.com/PatrykHegenberg/caesar-transfer.git
  1. Change to the project directory:
cd caesar-transfer
  1. Build the program:
cargo build --bin caesar --release

Usage

cli

The program offers the following commands: serve Starts the relay server.

./target/release/caesar serve

You can optionally specify the listening address and port using flags:

./target/release/caesar serve -p 8080 -l 192.168.1.100

By default, the server listens on 0.0.0.0:8000.

send Sends data through the relay server.

./target/release/caesar send

receive Receives data through the relay server.

./target/release/caesar receive

GUI

To use the Gui version of Ceasar-Transfer, you can download the version that suits you under Releases. Currently supported operating systems are Windows, Linux and Android.

Desktop

Copy the folder contained in the zip/tar file to a folder of your choice and add the path to it to your PATH variable.

Start the application and configure your relay server in the settings.

Android

As the Android version is currently in beta status, the APK must also be downloaded from the release page. Open it with your smartphone's file manager and install it.

Start the application and configure your relay server in the settings.

Help

For more information about the commands and arguments, use:

./target/release/caesar --help

Development

To start a test system, please follow these steps: Start the relay server:

./target/release/caesar serve

Open a send window in another terminal:

./target/release/caesar -r ws://0.0.0.0:8000 send

Open a receive window in another terminal:

./target/release/caesar -r ws://0.0.0.0:8000 receive

Now you can test the functionality of the relay server using the cli version.