Updated readme

This commit is contained in:
2022-11-27 19:18:24 +01:00
parent a11567dcf6
commit 92441a41f3

View File

@@ -1 +1,42 @@
# transatlanticTorrentExpress
# 🚅 Transatlantic Torrent Express
> Agent for transporting files from remote host.
## Install
Download repo:
```bash
git clone https://github.com/kevinmidboe/transatlanticTorrentExpress
cd transatlanticTorrentExpress
```
Also setup to require [delugeClient](https://github.com/KevinMidboe/delugeClient) to remove after transfered. Install the package using pip command:
```bash
pip3 install delugeClient-kevin
```
## Configure
Create copy of config and edit following values:
```bash
cp config.ini.default config.ini
```
```ini
[SSH]
host=
user=
[FILES]
remote=
local=
[ELASTIC]
host=
port=
```
## Run
```bash
python3 src/transatlanticTorrentExpress.py
```