chiark / gitweb /
in-building find island works
[ypp-sc-tools.main.git] / pctb / 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 database of character and island name
33 images, which is used for the commodity screen OCR and also for
34 determining your island name.
35
36 By default, we ask the server for an updated set of dictionaries every
37 time we run; this is done with the rsync protocol (indeed, by invoking
38 rsync).  You can disable this with --dict-local-only.
39
40 If we find a screen display we don't understand, we will ask you about
41 it by popping up a window which allows you to select the island (or
42 provide character set information - see README.charset).  Your answers
43 to these questions are recorded locally and will be used by your
44 client in future.
45
46 By default, these dictionary updates are also submitted to my server.
47 That allows me to check them; if they are correct, I will include them
48 in the master database so that everyone gets the benefit of them.
49 If there are any incorrect submissions, I can contradict them in the
50 master database so that your client will automatically behave
51 correctly anyway.
52
53 So, thanks for your help!
54
55
56 Dictionary submissions (uploads) include your pirate name by default
57 --------------------------------------------------------------------
58
59 These dictionary submissions are reported to me along with the ocean
60 name and your pirate name.
61
62 I will only use this to talk to you about your dictionary submissions
63 (for example, to let you know if you have made a mistake, or to thank
64 you for your contributions).
65
66 However, if you prefer to be anonymous, you can tell your PCTB client
67 not to mention your pirate name (in the GUI, or with the --dict-anon
68 option).  In this case I won't see your ocean or your pirate name,
69 although of course the actual images in your submissions may reveal
70 your island and thus your ocean.
71
72
73 User interface for privacy
74 --------------------------
75
76 The dictionary submission feature, and whether to quote your pirate
77 identity, is exposed in and controllable from the dictionary update
78 GUI, for maximum visibility.  The settings in the GUI are not recorded
79 anywhere from one run to the next.  If you want to consistently
80 increase your privacy setting, use the --dict-* privacy options.
81 See the table of options in the README for details.
82
83 Having said all that, please do not upload data to the PCTB server
84 without also participating in dictionary sharing.  If you don't update
85 your dictionary, your parses may be wrong and thus the data you upload
86 to PCTB may be wrong.  If you don't submit your dictionary entries,
87 any mistakes you make will remain uncorrected.
88
89
90 Records kept
91 ------------
92
93 I keep a permanent log of all the submissions, including date, time,
94 submitting pirate or IP address, and YPP SC PCTB client version.
95 This is so that I have enough information to go back and fix the
96 dictionary if anything goes badly wrong (for example, if a particular
97 client is broken).
98
99 My rsync server (file server) also records your IP address when your
100 client fetches new master dictionaries; those logs are used only for
101 debugging the rsync server (which also serves many other files), and
102 they are routinely expired, currently after about two months.
103
104 The information about the source of a submissions doesn't appear in
105 the dictionaries as available for download, so other people won't
106 know you're using my program.
107
108 I don't know what records the actual PCTB server keeps, but the upload
109 process tells the server your ocean and island name, and your PCTB
110 upload client version number (including the fact that it's this Linux
111 client).  The PCTB server is not told your pirate name.