diff --git a/server/README.md b/server/README.md index c782794..315e719 100644 --- a/server/README.md +++ b/server/README.md @@ -7,6 +7,10 @@ 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`). +The server code is in the `ws_server` directory; unless otherwise noted, all +commands and instructions assume you have `cd`ed into that directory. +Utilities for server configuration etc. are in the `utils` directory. + ## Installation The server itself does not need to be installed; it is simply run with @@ -25,13 +29,15 @@ The server itself does not need to be installed; it is simply run with #### Other distros -Unfortunately, I only have Mint computers, so I can't help with other -distros. +I only have Mint and Ubuntu computers, so I can't give package names for other +distros. If you get it working on another distro, please create a pull request +adding instructions to this file! You will need the following: +* Python 3 +* `pip` (for Python 3) * ImageMagick 6 -* X11 development headers * `Xvfb` * `xdotool` * `xwd` @@ -94,4 +100,5 @@ and HamClock. Has no effect with the `port8080` backend. ### `password_argon2` -Argon2-hashed password. Use `pwhash.py` to generate a hashed password. +Argon2-hashed password. Use `pwhash.py` (in `utils`, not `ws_server`) to +generate a hashed password. diff --git a/server/pwhash.py b/server/utils/pwhash.py similarity index 100% rename from server/pwhash.py rename to server/utils/pwhash.py diff --git a/server/backends/port8080.py b/server/ws_server/backends/port8080.py similarity index 100% rename from server/backends/port8080.py rename to server/ws_server/backends/port8080.py diff --git a/server/backends/saas.py b/server/ws_server/backends/saas.py similarity index 100% rename from server/backends/saas.py rename to server/ws_server/backends/saas.py diff --git a/server/backends/x11.py b/server/ws_server/backends/x11.py similarity index 100% rename from server/backends/x11.py rename to server/ws_server/backends/x11.py diff --git a/server/conf.txt b/server/ws_server/conf.txt similarity index 100% rename from server/conf.txt rename to server/ws_server/conf.txt diff --git a/server/imgproc.py b/server/ws_server/imgproc.py similarity index 100% rename from server/imgproc.py rename to server/ws_server/imgproc.py diff --git a/server/parse_config.py b/server/ws_server/parse_config.py similarity index 100% rename from server/parse_config.py rename to server/ws_server/parse_config.py diff --git a/server/requirements.txt b/server/ws_server/requirements.txt similarity index 100% rename from server/requirements.txt rename to server/ws_server/requirements.txt diff --git a/server/ubuntu_pkgs.txt b/server/ws_server/ubuntu_pkgs.txt similarity index 100% rename from server/ubuntu_pkgs.txt rename to server/ws_server/ubuntu_pkgs.txt diff --git a/server/wss.py b/server/ws_server/wss.py similarity index 100% rename from server/wss.py rename to server/ws_server/wss.py