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