updated docs (rename)

This commit is contained in:
17ms 2023-04-01 20:25:17 +03:00
parent 845cb46881
commit adad15aefa
8 changed files with 25 additions and 133 deletions

34
Cargo.lock generated
View File

@ -579,6 +579,23 @@ dependencies = [
"crossbeam-utils",
]
[[package]]
name = "contego"
version = "0.3.0"
dependencies = [
"aes-gcm",
"base64",
"eframe",
"egui",
"local-ip-address",
"ntest",
"rand 0.7.3",
"sha256",
"tokio",
"tokio-test",
"x25519-dalek",
]
[[package]]
name = "core-foundation"
version = "0.9.3"
@ -955,23 +972,6 @@ dependencies = [
"percent-encoding",
]
[[package]]
name = "fragilebyte"
version = "0.3.0"
dependencies = [
"aes-gcm",
"base64",
"eframe",
"egui",
"local-ip-address",
"ntest",
"rand 0.7.3",
"sha256",
"tokio",
"tokio-test",
"x25519-dalek",
]
[[package]]
name = "futures-core"
version = "0.3.28"

View File

@ -1,7 +1,6 @@
[package]
name = "fragilebyte"
authors = ["Arttu Einistö"]
description = "TCP socket pair for file transfer, backend for https://github.com/einisto/leightbox"
name = "contego"
description = "GUI tool for secure file transfer"
version = "0.3.0"
edition = "2021"

View File

@ -1,47 +1,7 @@
## Socket pair for FTP like file transfer
Single binary containing both server and client.
## GUI tool for secure file transfer
<p align="left">
<a href="https://github.com/einisto/fragilebyte/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/17ms/fragilebyte/ci.yml?branch=main"></a>
<a href="https://github.com/einisto/fragilebyte/tags"><img src="https://img.shields.io/github/v/tag/17ms/fragilebyte"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/github/license/17ms/fragilebyte"></a>
<a href="https://github.com/17ms/contego/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/17ms/contego/ci.yml?branch=main"></a>
<a href="https://github.com/17ms/contego/tags"><img src="https://img.shields.io/github/v/tag/17ms/contego"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/github/license/17ms/contego"></a>
</p>
### Installation and usage
Quickly run with:
```shell
cargo run -- <OPTIONS>
```
or create and run an optimized, independent binary:
```shell
cargo build --release
./target/release/fragilebyte <OPTIONS>
```
If no options are specified the app starts as a server by default. It can be started as a client by defining a target address:
```
USAGE:
fragilebyte [OPTIONS]
OPTIONS:
-b, --chunksize <CHUNKSIZE> Chunksize used in the file transfer (bytes) [default: 8192]
-f, --fileroot <FILEROOT> Path to the folder where the files are outputted as a client or
served from as a server [default: './output' / './data']
-h, --help Print help information
--localhost Run only in the local network
-p, --port <PORT> Port where the service is hosted [default: 8080]
-t, --target <TARGET> Server's address when connecting as a client
--timeout <TIMEOUT> Seconds of inactivity after which the server closes itself
[default: 30]
-V, --version Print version information
```
### Dependencies
![DependenciesGraph](docs/structure.svg)

View File

@ -1,66 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 5.0.0 (0)
-->
<!-- Pages: 1 -->
<svg width="421pt" height="116pt"
viewBox="0.00 0.00 420.69 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<polygon fill="white" stroke="transparent" points="-4,4 -4,-112 416.69,-112 416.69,4 -4,4"/>
<!-- fragilebyte -->
<g id="node1" class="node">
<title>fragilebyte</title>
<ellipse fill="none" stroke="black" cx="227.9" cy="-90" rx="61.99" ry="18"/>
<text text-anchor="middle" x="227.9" y="-86.3" font-family="Times,serif" font-size="14.00">fragilebyte</text>
</g>
<!-- clap -->
<g id="node2" class="node">
<title>clap</title>
<ellipse fill="none" stroke="black" cx="29.9" cy="-18" rx="29.8" ry="18"/>
<text text-anchor="middle" x="29.9" y="-14.3" font-family="Times,serif" font-size="14.00">clap</text>
</g>
<!-- fragilebyte&#45;&gt;clap -->
<g id="edge1" class="edge">
<title>fragilebyte&#45;&gt;clap</title>
<path fill="none" stroke="black" d="M187.02,-76.48C154.7,-66.32 108.56,-51.22 68.9,-36 66.82,-35.2 64.7,-34.36 62.57,-33.49"/>
<polygon fill="black" stroke="black" points="63.84,-30.23 53.27,-29.59 61.13,-36.69 63.84,-30.23"/>
</g>
<!-- local&#45;ip&#45;address -->
<g id="node3" class="node">
<title>local&#45;ip&#45;address</title>
<ellipse fill="none" stroke="black" cx="160.9" cy="-18" rx="83.39" ry="18"/>
<text text-anchor="middle" x="160.9" y="-14.3" font-family="Times,serif" font-size="14.00">local&#45;ip&#45;address</text>
</g>
<!-- fragilebyte&#45;&gt;local&#45;ip&#45;address -->
<g id="edge2" class="edge">
<title>fragilebyte&#45;&gt;local&#45;ip&#45;address</title>
<path fill="none" stroke="black" d="M212.02,-72.41C203.71,-63.73 193.39,-52.95 184.2,-43.34"/>
<polygon fill="black" stroke="black" points="186.57,-40.76 177.13,-35.96 181.51,-45.6 186.57,-40.76"/>
</g>
<!-- rand -->
<g id="node4" class="node">
<title>rand</title>
<ellipse fill="none" stroke="black" cx="294.9" cy="-18" rx="32.49" ry="18"/>
<text text-anchor="middle" x="294.9" y="-14.3" font-family="Times,serif" font-size="14.00">rand</text>
</g>
<!-- fragilebyte&#45;&gt;rand -->
<g id="edge3" class="edge">
<title>fragilebyte&#45;&gt;rand</title>
<path fill="none" stroke="black" d="M243.78,-72.41C252.53,-63.26 263.54,-51.76 273.09,-41.78"/>
<polygon fill="black" stroke="black" points="275.67,-44.16 280.05,-34.51 270.61,-39.31 275.67,-44.16"/>
</g>
<!-- tokio -->
<g id="node5" class="node">
<title>tokio</title>
<ellipse fill="none" stroke="black" cx="378.9" cy="-18" rx="33.6" ry="18"/>
<text text-anchor="middle" x="378.9" y="-14.3" font-family="Times,serif" font-size="14.00">tokio</text>
</g>
<!-- fragilebyte&#45;&gt;tokio -->
<g id="edge4" class="edge">
<title>fragilebyte&#45;&gt;tokio</title>
<path fill="none" stroke="black" d="M259.55,-74.33C284.55,-62.74 319.36,-46.6 344.94,-34.74"/>
<polygon fill="black" stroke="black" points="346.65,-37.81 354.25,-30.43 343.71,-31.46 346.65,-37.81"/>
</g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 3.1 KiB

0
src/gui.rs Normal file
View File

View File

@ -2,5 +2,5 @@ pub mod common;
pub mod comms;
pub mod connector;
pub mod crypto;
//pub mod gui;
pub mod gui;
pub mod listener;

View File

@ -1,4 +1,3 @@
//use fragilebyte::gui;
use std::error::Error;
use tokio;

View File

@ -1,4 +1,4 @@
use fragilebyte::{common::Message, connector::Connector, listener::Listener};
use contego::{common::Message, connector::Connector, listener::Listener};
use ntest::timeout;
use rand::{distributions::Alphanumeric, thread_rng, Rng};
use std::{