Skip to content

Commit d500b84

Browse files
Add installation instructions to README.md
1 parent b2b12a7 commit d500b84

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Under the hood, it uses direct (peer-to-peer) connections between the participan
77
This was recently made possible by the advanced holepunching techniques, made by the HolePunch company.
88

99
# Why peer-to-peer?
10+
1011
Traditionally, when you use network apps such as TeamViewer, place audio and video calls or share files, your data is going through intermediate servers which are expensive to host, can harm your privacy, increase latency and consume additional bandwidth.
1112

1213
Peer-to-peer solutions such as PeerViewer have the advantage of:
@@ -26,6 +27,40 @@ Here's a list of some key, free and open-source technologies that make this poss
2627
- Electron, for building standalone applications using open web standards.
2728
- Bitcoin and Lightning, for accepting payments without needing anyone's permission or approval.
2829

30+
# Installation instructions
31+
32+
## All-in-one bundles
33+
34+
The .AppImage and .zip releases are all-in-one bundles that don't require any dependency installation.
35+
36+
- Use the .AppImage if you want an all-in-one portable file that just works when you make it executable and start it.
37+
- Same for the .zip; just extract it where you like and double-click the "peerviewer" file.
38+
- If you use the AppImage or the .zip, you need to create your own shortcut on the desktop or in the start menu, if you want one.
39+
40+
## Debian/Ubuntu
41+
42+
To install the dependencies for the Debian/Ubuntu Linux .deb package, you may need to run or install something like:
43+
44+
`sudo apt install libgtk-3-0 libnotify4 libnss3 libxss1 libxtst6 xdg-utils libatspi2.0-0 libuuid1 libsecret-1-0 libsecret-common libnspr4`
45+
46+
And then install the PeerViewer_version_amd64.deb file by double-clicking it or running something like:
47+
48+
`sudo dpkg -i PeerViewer_version_amd64.deb`
49+
50+
## Redhat/Fedora/OpenSuse/CentOS
51+
52+
To install the dependencies for the Redhat/Fedora/OpenSuse/CentOS .rpm package, you may need to run something like (untested):
53+
54+
`sudo yum install at-spi2-core gtk3 libnotify libuuid nss xdg-utils`
55+
56+
And then install the PeerViewer_version_amd64.rpm file by double-clicking it or running something like:
57+
58+
`sudo rpm -i PeerViewer_version_amd64.deb`
59+
60+
## Snap package
61+
62+
The .snap package is untested as of yet but it should just work. If you're into snap, try it out and give some feedback!
63+
2964
# Development
3065

3166
## Install dependencies
@@ -57,7 +92,7 @@ To build a release, have a look at the interactive script:
5792
## Run as webapp
5893

5994
To run it as a webapp on http://localhost:8000/, do:
60-
95+
6196
`./serve_dev_website.sh`
6297

6398
Note that HolePunch and the VNC client and server binaries don't work in the webapp.

0 commit comments

Comments
 (0)