History

Samuel Sloniker 8ea09771e8 Big refactor (#20 ) * First step of server redesign Only thing left is to re-add disconnect handling * Convert client to use img Removing the tiling feature allowed me to switch the client to use img instead of canvas. * Rename "canvas" to "img" "canvas" isn't a good variable name for an <img> element * Handle disconnects (again) I had removed disconnect handling when I started the partial rewrite. This commit re-adds it. * Remove obsolete code * Change dependency to websocket-server in requirements.txt * Fix Chrome click bug This should fix the Chrome click bug.		2021-07-19 12:09:42 -07:00
..
backends	Add SaaS backend	2021-07-10 18:51:15 -07:00
conf.txt	Add port config	2021-07-10 14:50:31 -07:00
imgproc.py	Big refactor (#20 )	2021-07-19 12:09:42 -07:00
parse_config.py	Configuration file (#15 )	2021-06-20 16:37:04 -07:00
pwhash.py	Document the server	2021-07-05 12:11:32 -07:00
README.md	Update server/README.md	2021-07-15 18:53:48 -07:00
requirements.txt	Big refactor (#20 )	2021-07-19 12:09:42 -07:00
ubuntu_pkgs.txt	Document the server	2021-07-05 12:11:32 -07:00
wss.py	Big refactor (#20 )	2021-07-19 12:09:42 -07:00

README.md

HCRA Server

This is the server for HamClock Remote Access. It is a Python web app written using Tornado.

On its own, the server is useless; it requires HamClock, available at http://clearskyinstitute.com/ham/HamClock/ (installed on the same machine as the HCRA server), and the HCRA client (see ../client).

Installation

The server itself does not need to be installed; it is simply run with python3 wss.py in this directory. However, it does have some dependencies (both Python packages and binaries).

Python packages

pip3 install -r requirements.txt

Binaries

Ubuntu, Mint, possibly Debian, etc.

sudo apt install $(cat ubuntu-pkgs.txt)

Other distros

Unfortunately, I only have Mint computers, so I can't help with other distros.

You will need the following:

ImageMagick 6
X11 development headers
Xvfb
xdotool
xwd

Backends

The server can connect to HamClock in one of two ways; it can either use HamClock's built-in port 8080 service, or it can use X11. The X11 method is highly recommended when it can be used, because it does not occasionally freeze when HamClock is on certain screens like the port 8080 backend does.

A variant on the X11 backend, called the SaaS backend, is also available. It works the same way, except it starts HamClock on its own and stops it when the user disconnects. This is intended for cloud/SaaS environments that may run multiple HamClocks for different users.

Port 8080

The Port 8080 backend just requires a running instance of 800x480 HamClock.

X11

The X11 backend requires 800x480 HamClock to be running on Xvfb at a resolution of 800x480x24.

For example:

Xvfb :1 -screen 0 800x480x24
DISPLAY=:1 path-to-hamclock

Replace :1 with the desired display number.

SaaS

The SaaS backend

Custom

If you write your own backend, just put it in the backends folder and specify its file name (without .py) in conf.txt. Make sure you don't accidentally commit it if you don't want to!

`conf.txt`

The server will not work without a conf.txt file. This file is a space-separated table of configuration data. See the included file for a reference. (That file will work for testing, but should not be used on an Internet-accessible server. The password is Testing123. It uses the X11 backend, DISPLAY=:1.)

`backend`

Use x11 for the X11 backend, or port8080 for the port 8080 backend.

`display`

X11 display to use, such as :1. Must be the same as the one used for Xvfb and HamClock. Has no effect with the port8080 backend.

`password_argon2`

Argon2-hashed password. Use pwhash.py to generate a hashed password.