summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJesusaves <cpntb1@ymail.com>2020-12-18 22:42:18 -0300
committerJesusaves <cpntb1@ymail.com>2020-12-18 22:42:18 -0300
commit89904cc625fc6904a602dd67f118c005eaad4b6e (patch)
tree9333733309303e98f6d47b8e1132d2ffed0d556a /README.md
parenteb79fc54ddde0c85cf1c936f9453eab04f97d152 (diff)
downloadserver-89904cc625fc6904a602dd67f118c005eaad4b6e.tar.gz
server-89904cc625fc6904a602dd67f118c005eaad4b6e.tar.bz2
server-89904cc625fc6904a602dd67f118c005eaad4b6e.tar.xz
server-89904cc625fc6904a602dd67f118c005eaad4b6e.zip
Update instructions about Update Server
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index 514b381..7420245 100644
--- a/README.md
+++ b/README.md
@@ -86,16 +86,16 @@ Client auto-updater is not provided, but is possible.
# The Update Server
The client will request images missing on it to the update server.
-Simply download it from the repository.
-Workflow is: First you use comp.py, and then, fixit.sh
+It should be served at 443 port of the main host, under the assets/ folder.
+HTTPS support is mandatory, but the certificate is not validated.
-After that, the Update Server is ready to be enabled, and you can do so by running
-`./server.py` on the relevant folder.
+The user token will also be sent as a GET parameter on every request. While the
+update server may safely ignore this parameter, verifying the token allows you to
+limit who can download the data to only authenticated users. The benefits of doing
+this are still not proven.
-Update Server should already be running when this server is running.
-Failure to do so might lead to infinite hangs on clients as they await for a reply.
-Caution doesn't hurt.
+If you use Apache or Nginx, remember to disable directory listing.
# Limitations