chiark / gitweb /
Can compact ids and remove obsolete commodities
[ypp-sc-tools.db-test.git] / yarrg / README.privacy
1 Communications with servers - and your privacy
2 ==============================================
3
4 The Special Circumstances YPP yarrg client talks to several different
5 servers for different purposes.
6
7 (The information below is true if you invoke the system using the main
8 `yarrg' program.  If you want to know the relationships between it and
9 its various helper programs, and the specific behaviours of the
10 helpers, you'll have to read the source.  Sorry.)
11
12
13 1. YARRG and PCTB servers
14 =========================
15
16 These servers records everyone's uploads of commodity prices and
17 allows you to search for routes using the PCTB and YARRG websites.
18
19 The YARRG data upload server may also distribute the uploaded data to
20 other searching site operators for inclusion in their databases; your
21 IP address is not passed on to those other operators.
22
23 We upload to the PCTB and YARRG servers if you select one of the
24 --upload options, and not otherwise - but note that this is the
25 default.
26
27 We also query the PCTB server to determine possible island names, if
28 we don't recognise the island and want to ask you about it.  It is not
29 currently possible to disable this behaviour, but if you don't select
30 an operating mode (like --upload) which needs to know your island, it
31 won't happen.
32
33
34 2. YPP SC YARRG dictionary server
35 =================================
36
37 This server maintains the master copies of various databases which are
38 used to assist the OCR and upload process.  Collectively I call these
39 `dictionaries'.  There are dictionaries of character and island name
40 images, of (existing and new) commodity names, of notable known OCR
41 misrecognitions, and of islands and archipelagoes.  These are used for
42 the commodity screen OCR, for determining your island name, and for
43 checking whether commodities missing on the servers are real.
44
45 By default, we ask the YARRG disctionary server for appropriate
46 updated dictionaries every time we run; this is done with the rsync
47 protocol (indeed, by invoking rsync).  You can disable this with
48 --dict-local-only.
49
50 If we find a screen display we don't understand, we will ask you about
51 it by popping up a window which allows you to select the island (or
52 provide character set information - see README.charset).  Your answers
53 to these questions are recorded locally and will be used by your
54 client in future.
55
56 By default, these dictionary updates are also submitted to my server.
57 That allows me to check them; if they are correct, I will include them
58 in the master database so that everyone gets the benefit of them.
59 If there are any incorrect submissions, I can contradict them in the
60 master database so that your client will automatically behave
61 correctly anyway.
62
63 So, thanks for your help!
64
65
66 Dictionary submissions (uploads) include your pirate name by default
67 --------------------------------------------------------------------
68
69 These dictionary submissions are reported to me along with the ocean
70 name and your pirate name.
71
72 I will only use this to talk to you about your dictionary submissions
73 (for example, to let you know if you have made a mistake, or to thank
74 you for your contributions).
75
76 However, if you prefer to be anonymous, you can tell your yarrg client
77 not to mention your pirate name (in the GUI, or with the --dict-anon
78 option).  In this case I won't see your ocean or your pirate name,
79 although of course the actual images in your submissions may reveal
80 your island and thus your ocean.
81
82
83 User interface for privacy
84 --------------------------
85
86 The dictionary submission feature, and whether to quote your pirate
87 identity, is exposed in and controllable from the dictionary update
88 GUI, for maximum visibility.  The settings in the GUI are not recorded
89 anywhere from one run to the next.  If you want to consistently
90 increase your privacy setting, use the --dict-* privacy options.
91 See the table of options in the README for details.
92
93 Having said all that, please do not upload data to the YARRG and PCTB
94 servers without also participating in dictionary sharing.  If you
95 don't update your dictionary, your parses may be wrong and thus the
96 data you uploads may be wrong.  If you don't submit your dictionary
97 entries, any mistakes you make will remain uncorrected.
98
99
100 Records kept
101 ------------
102
103 I keep a permanent log of all the dictionary submissions, including
104 date, time, submitting pirate or IP address, and YPP SC yarrg client
105 version.  This is so that I have enough information to go back and fix
106 the dictionary if anything goes badly wrong (for example, if a
107 particular client is broken).
108
109 I keep a log of the data uploads including date, time, submitting IP
110 address, YPP SC yarrg client version but NOT including your pirate
111 name.  This information (except your IP address) is passed on to any
112 third parties who've asked to get copies of data updates.
113
114 My rsync server (file server) also records your IP address when your
115 client fetches new master dictionaries; those logs are used only for
116 debugging the rsync server (which also serves many other files), and
117 they are routinely expired, currently after about two months.
118
119 The information about the source of a submissions doesn't appear in
120 the dictionaries as available for download, so other people won't
121 know you're using my program.
122
123 I don't know what records the actual PCTB server keeps, but the upload
124 process tells the server your ocean and island name, and your PCTB
125 upload client version number (including the fact that it's this Linux
126 client).  The PCTB server is not told your pirate name.