Skip to content

Commit 34b9e9f

Browse files
ThomasFarstrikeThomasFarstrike
committed
Update documentation
1 parent 1118f79 commit 34b9e9f

File tree

2 files changed

+67
-39
lines changed

2 files changed

+67
-39
lines changed

‎INSTALL.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# PeerViewer Installation instructions
2+
3+
In the instructions below, x.y.z is the version number you want to install.
4+
5+
# Windows
6+
7+
Download and install one of the Windows builds:
8+
9+
- **PeerViewer Setup x.y.z.exe** is a regular assisted installer that creates shortcuts, allows you to choose the installation directory, etc.
10+
- **PeerViewer x.y.z.msi** is a Microsoft Windows Installer with additional commandline options (add /? for help) to support automated deployments and advanced usage.
11+
- **PeerViewer x.y.z.exe** is a portable executable - it works out of the box, without installation steps. You'll have to create your own shortcut if you want one.
12+
- **PeerViewer-x.y.z-win.zip** is an archive file that can be extracted to a manually created folder for do-it-yourself installations, including creating your own shortcut.
13+
14+
# Linux
15+
16+
## All-in-one bundles
17+
18+
These don't require any dependency installation.
19+
20+
- **PeerViewer-x.y.z.AppImage** is a portable binary that just works when you make it executable and start it. You'll have to create your own shortcut if you want one.
21+
- **PeerViewer-1.3.0.tar.gz** is an archive file that can be extracted to a manually created folder for do-it-yourself installations, including creating your own shortcut.
22+
23+
## Debian/Ubuntu
24+
25+
To install the dependencies for the Debian/Ubuntu Linux .deb package, you may need to run or install something like:
26+
27+
`sudo apt install libgtk-3-0 libnotify4 libnss3 libxss1 libxtst6 xdg-utils libatspi2.0-0 libuuid1 libsecret-1-0 libsecret-common libnspr4`
28+
29+
And then install the PeerViewer_x.y.z_amd64.deb file by double-clicking it or running something like:
30+
31+
`sudo dpkg -i PeerViewer_x.y.z_amd64.deb`
32+
33+
## Redhat/Fedora/OpenSuse/CentOS
34+
35+
To install the dependencies for the Redhat/Fedora/OpenSuse/CentOS .rpm package, you may need to run something like (untested):
36+
37+
`sudo yum install at-spi2-core gtk3 libnotify libuuid nss xdg-utils`
38+
39+
And then install the PeerViewer_x.y.z_amd64.rpm file by double-clicking it or running something like:
40+
41+
`sudo rpm -i PeerViewer_x.y.z_amd64.rpm`
42+
43+
## Snap package
44+
45+
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!
46+

‎README.md‎

Lines changed: 21 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Peer-to-peer solutions such as PeerViewer have the advantage of:
1616
- Ensuring maximum privacy for all participants.
1717
- Being low cost, making it possible to survive on a pay-what-you-can/voluntary/donation basis.
1818
- Minimizing time-to-market and allowing for quick MVP's without a lot of server-side datacenter setup work.
19-
- Building blocks
19+
20+
**Building blocks**
2021

2122
We're lucky to be standing on the shoulders of giants to pull this off.
2223

@@ -29,40 +30,12 @@ Here's a list of some key, free and open-source technologies that make this poss
2930

3031
# Installation instructions
3132

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!
33+
See INSTALL.md
6334

6435
# Development
6536

37+
Tested with node v16.17.1 and npm v8.15.0 but should work with more recent versions too.
38+
6639
## Install dependencies
6740

6841
To install the dependencies from package.json using the specific version from package-lock.json, run:
@@ -71,10 +44,16 @@ To install the dependencies from package.json using the specific version from pa
7144

7245
## Download and extract TigerVNC
7346

74-
Before starting the app, first make sure you have downloaded and extracted the TigerVNC software:
47+
Before starting the app, first make sure you have downloaded and extracted the VNC software.
48+
49+
On Linux:
7550

7651
`./vnc-software/download_tigervnc.sh`
7752

53+
On Windows:
54+
55+
`./vnc-software/download_uvnc.sh`
56+
7857
## Start the app
7958

8059
To start the PeerViewer standalone Electron app, do:
@@ -85,9 +64,10 @@ You can enable Chrome Developer Tools by setting "devTools: true" in src/main.js
8564

8665
## Build a release
8766

88-
To build a release, have a look at the interactive script:
67+
To build a release, have a look at the interactive scripts:
8968

90-
`./release.sh`
69+
`./build_release_linux.sh # only tested on a Linux machine`
70+
`./build_release_windows.sh # needs to be done on a Windows machine, more info in the script itself`
9171

9272
## Run as webapp
9373

@@ -100,9 +80,11 @@ Note that the VNC client and server binaries don't work in the webapp, and neith
10080
To get this working in a webbrowser as a webapp, it should be possible to integrate https://novnc.com/ as the VNC Client and use the HolePunch DHT websocket relay for connections.
10181
For the server-side, it might be possible to build a browser-based VNC server using https://developer.mozilla.org/en-US/docs/Web/API/Screen_Capture_API/
10282

103-
# Windows
83+
## Windows
84+
85+
Development can also be done on Windows, and it's also required to build releases for Windows.
86+
87+
Just install node and npm, for example using https://github.com/nodists/nodist/releases
10488

105-
Install git for Windows with those many handy Linux and Bash commands.
106-
Install https://github.com/nodists/nodist/releases
89+
And it's also recommdned to install Git For Windows to have bash and many more handy commandline tools that are used by the .sh scripts in this project.
10790

108-
$ nodist 16.17.1 # newer versions might also work

0 commit comments

Comments
 (0)