README.md 1.99 KB
Newer Older
Tobias Bernard's avatar
Tobias Bernard committed
1 2
# Teleport
Teleport is a native GTK3 app to effortlessly share files on the local network.
Julian Sparber's avatar
Julian Sparber committed
3

4
![Screenshot of the Teleport application window](docs/screenshots/window.png)
Julian Sparber's avatar
Julian Sparber committed
5

6
Have you ever asked yourself why the easiest way to move a file between two computers in the same room involves sending it to a server in another country?
Julian Sparber's avatar
Julian Sparber committed
7

Tobias Bernard's avatar
Tobias Bernard committed
8 9
Teleport is designed to be a replacement for using USB keys or emailing stuff to yourself just so you have them on another device on your desk. The main user interface on the receiver's side are notifications:

10
![Screenshot of a Teleport notification](docs/screenshots/notification.png)
Tobias Bernard's avatar
Tobias Bernard committed
11

12
## Install
Tobias Bernard's avatar
Tobias Bernard committed
13
Teleport is currently in early development, but you can try it by installing it via [flatpak](http://flatpak.org). If you're running a modern GNU/Linux distro you should already have flatpak, or be able to install it from your repositories.
14

15
If you have GNOME Software (or another GUI app to install flatpaks), just [download this file](http://frac-tion.com/teleport-flatpak/teleport.flatpakref) and open it in Software (your browser should offer to do that before downloading).
16 17 18 19 20 21

Otherwise you can also install it from the command line:
```
flatpak install --from  http://frac-tion.com/teleport-flatpak/teleport.flatpakref
```

Tobias Bernard's avatar
Tobias Bernard committed
22
## Roadmap
23 24
It's still early days, but we have exciting plans for the future. While Teleport can currently only send individual files, longer term we are interested in doing things like:
* sending multiple files and folders
Tobias Bernard's avatar
Tobias Bernard committed
25 26
* sending text snippets
* file transfer progress bars
27
* encryption in transit
Tobias Bernard's avatar
Tobias Bernard committed
28 29 30
* native Android/iOS/macOS/Windows apps

## Build
Julian Sparber's avatar
Julian Sparber committed
31
#### Archlinux
Julian Sparber's avatar
Julian Sparber committed
32
```
33
  pacman -S base-devel libsoup avahi gtk3 meson
34
  git clone https://github.com/frac-tion/teleport.git
35 36
  cd teleport
  ./configure
Julian Sparber's avatar
Julian Sparber committed
37
  make
38
  ./_build/src/teleport
Julian Sparber's avatar
Julian Sparber committed
39
```
Julian Sparber's avatar
Julian Sparber committed
40
#### Ubuntu
41
```
42
  apt install pkg-config libsoup2.4-dev libavahi-client3 libgtk-3-dev meson
43
  git clone https://github.com/frac-tion/teleport.git
44 45
  cd teleport
  ./configure
46
  make
47
  ./_build/src/teleport
48 49
```

Tobias Bernard's avatar
Tobias Bernard committed
50 51 52

## License
AGPLv3, because freeeeeeedom