chiark / gitweb /
Merge branch 'stable-5.x'
[ypp-sc-tools.main.git] / yarrg / README.privacy
index 957f680..769134f 100644 (file)
@@ -1,23 +1,28 @@
 Communications with servers - and your privacy
 ==============================================
 
-The Special Circumstances YPP PCTB client talks to two different
+The Special Circumstances YPP yarrg client talks to several different
 servers for different purposes.
 
 (The information below is true if you invoke the system using the main
-`ypp-commodities' program.  If you want to know the relationships
-between it and its various helper programs, and the specific
-behaviours of the helpers, you'll have to read the source.  Sorry.)
+`yarrg' program.  If you want to know the relationships between it and
+its various helper programs, and the specific behaviours of the
+helpers, you'll have to read the source.  Sorry.)
 
 
-1. PCTB server
-==============
+1. YARRG and PCTB servers
+=========================
 
-This records everyone's uploads of commodity prices and allows you to
-conveniently search for good trade routes using the PCTB website.
+These servers records everyone's uploads of commodity prices and
+allows you to search for routes using the PCTB and YARRG websites.
 
-We upload to the PCTB server if you select the --upload option, and
-not otherwise.
+The YARRG data upload server may also distribute the uploaded data to
+other searching site operators for inclusion in their databases; your
+IP address is not passed on to those other operators.
+
+We upload to the PCTB and YARRG servers if you select one of the
+--upload options, and not otherwise - but note that this is the
+default.
 
 We also query the PCTB server to determine possible island names, if
 we don't recognise the island and want to ask you about it.  It is not
@@ -26,20 +31,21 @@ an operating mode (like --upload) which needs to know your island, it
 won't happen.
 
 
-2. YPP SC PCTB client dictionary server
-=======================================
+2. YPP SC YARRG dictionary server
+=================================
 
 This server maintains the master copies of various databases which are
-used to assist the OCR process.  Collectively I call these
-`dictionaries'.  There is a dictionary of character and island name
-images, of new commodity names, and of notable known OCR
-misrecognitions.  These are used for the commodity screen OCR, for
-determining your island name, and for checking whether commodities not
-found on the PCTB server are real.
-
-By default, we ask the server for appropriate updated dictionaries
-every time we run; this is done with the rsync protocol (indeed, by
-invoking rsync).  You can disable this with --dict-local-only.
+used to assist the OCR and upload process.  Collectively I call these
+`dictionaries'.  There are dictionaries of character and island name
+images, of (existing and new) commodity names, of notable known OCR
+misrecognitions, and of islands and archipelagoes.  These are used for
+the commodity screen OCR, for determining your island name, and for
+checking whether commodities missing on the servers are real.
+
+By default, we ask the YARRG disctionary server for appropriate
+updated dictionaries every time we run; this is done with the rsync
+protocol (indeed, by invoking rsync).  You can disable this with
+--dict-local-only.
 
 If we find a screen display we don't understand, we will ask you about
 it by popping up a window which allows you to select the island (or
@@ -67,7 +73,7 @@ I will only use this to talk to you about your dictionary submissions
 (for example, to let you know if you have made a mistake, or to thank
 you for your contributions).
 
-However, if you prefer to be anonymous, you can tell your PCTB client
+However, if you prefer to be anonymous, you can tell your yarrg client
 not to mention your pirate name (in the GUI, or with the --dict-anon
 option).  In this case I won't see your ocean or your pirate name,
 although of course the actual images in your submissions may reveal
@@ -84,21 +90,26 @@ anywhere from one run to the next.  If you want to consistently
 increase your privacy setting, use the --dict-* privacy options.
 See the table of options in the README for details.
 
-Having said all that, please do not upload data to the PCTB server
-without also participating in dictionary sharing.  If you don't update
-your dictionary, your parses may be wrong and thus the data you upload
-to PCTB may be wrong.  If you don't submit your dictionary entries,
-any mistakes you make will remain uncorrected.
+Having said all that, please do not upload data to the YARRG and PCTB
+servers without also participating in dictionary sharing.  If you
+don't update your dictionary, your parses may be wrong and thus the
+data you uploads may be wrong.  If you don't submit your dictionary
+entries, any mistakes you make will remain uncorrected.
 
 
 Records kept
 ------------
 
-I keep a permanent log of all the submissions, including date, time,
-submitting pirate or IP address, and YPP SC PCTB client version.
-This is so that I have enough information to go back and fix the
-dictionary if anything goes badly wrong (for example, if a particular
-client is broken).
+I keep a permanent log of all the dictionary submissions, including
+date, time, submitting pirate or IP address, and YPP SC yarrg client
+version.  This is so that I have enough information to go back and fix
+the dictionary if anything goes badly wrong (for example, if a
+particular client is broken).
+
+I keep a log of the data uploads including date, time, submitting IP
+address, YPP SC yarrg client version but NOT including your pirate
+name.  This information (except your IP address) is passed on to any
+third parties who've asked to get copies of data updates.
 
 My rsync server (file server) also records your IP address when your
 client fetches new master dictionaries; those logs are used only for