diff options
-rw-r--r-- | README.md | 86 |
1 files changed, 63 insertions, 23 deletions
@@ -44,14 +44,21 @@ installed - | |||
44 | * gzip | 44 | * gzip |
45 | * ionice, on Debian based systems it'll be in the util-linux package. | 45 | * ionice, on Debian based systems it'll be in the util-linux package. |
46 | * luajit | 46 | * luajit |
47 | * lua-rrd | ||
47 | * LuaSocket, on Debian based systems it'll be in the lua-socket package. | 48 | * LuaSocket, on Debian based systems it'll be in the lua-socket package. |
48 | * md5sum and sha256, on Debian based systems they'll be in the coreutils package. | 49 | * md5sum and sha256, on Debian based systems they'll be in the coreutils package. |
49 | * rrdtool, may need to include lua-rrd. | 50 | * rrdtool |
50 | * xz, on Debian based systems it'll be in the xz-utils package. | 51 | * xz, on Debian based systems it'll be in the xz-utils package. |
51 | 52 | ||
52 | If you want to have lots of graphs, also install | 53 | If you want to have lots of graphs, also install |
53 | [https://sledjhamr.org/cgit/apt-panopticon_cgp/](https://sledjhamr.org/cgit/apt-panopticon_cgp/). | 54 | [https://sledjhamr.org/cgit/apt-panopticon_cgp/](https://sledjhamr.org/cgit/apt-panopticon_cgp/). |
54 | 55 | ||
56 | For the apt-panopticon_cgp package, which is used to show the detailed | ||
57 | graphs, you'll need a web server that supports PHP. apt-panopticon_cgp | ||
58 | includes some support files for running PHP via CGI, which more web | ||
59 | servers support. You'll need php-cgi for that. | ||
60 | |||
61 | |||
55 | Web installation. | 62 | Web installation. |
56 | ----------------- | 63 | ----------------- |
57 | 64 | ||
@@ -83,8 +90,8 @@ Note that two runs of apt-panopticon have to happen ten minutes apart at | |||
83 | least in order to see any data on the graphs. | 90 | least in order to see any data on the graphs. |
84 | 91 | ||
85 | If you had already been running apt-panopticon for a while and have lots | 92 | If you had already been running apt-panopticon for a while and have lots |
86 | of data collected, the apt-panopticon-RRD-rescue.lua script can go | 93 | of data collected, the apt-panopticon-update-data.lua script can go |
87 | through all of that and feed it to RRD. | 94 | through all of that and feed it to RRD / update the files. |
88 | 95 | ||
89 | Using it. | 96 | Using it. |
90 | --------- | 97 | --------- |
@@ -151,6 +158,8 @@ redirections. Unless a specific mirror is given on the command line, the | |||
151 | mirror_list.txt file from pkgmaster.devuan.org is used to select mirrors | 158 | mirror_list.txt file from pkgmaster.devuan.org is used to select mirrors |
152 | to test. | 159 | to test. |
153 | 160 | ||
161 | explanations.html explains the tests in more detail. | ||
162 | |||
154 | The --tests= option can be used to adjust the list of tests performed. | 163 | The --tests= option can be used to adjust the list of tests performed. |
155 | 164 | ||
156 | * IPv4, perform the tests with IPv4 addresses (A records) | 165 | * IPv4, perform the tests with IPv4 addresses (A records) |
@@ -159,11 +168,15 @@ The --tests= option can be used to adjust the list of tests performed. | |||
159 | * http, test HTTP protocol access. | 168 | * http, test HTTP protocol access. |
160 | * https, test HTTPS protocol access. | 169 | * https, test HTTPS protocol access. |
161 | * rsync, test RSYNC protocol access. | 170 | * rsync, test RSYNC protocol access. |
162 | * DNS-RR, ??????????????? | 171 | * DNS-RR, Checks if the IPs for this mirror are part of the DNS-RR. |
163 | * Protocol, warn if the protocol changed during a redirect. | 172 | * Protocol, warn if the protocol changed during a redirect. |
173 | * Redirects test bad redirects, redirecting /DEVUAN/ to deb.devuan.org. | ||
164 | * URL-Sanity, add gratuitous multiple slashes to the URLs. | 174 | * URL-Sanity, add gratuitous multiple slashes to the URLs. |
165 | * Integrity, check PGP signatures. | 175 | * Integrity, check hashes and PGP signatures. |
166 | * Updated, check Release dates. | 176 | * Updated, check Release dates and updated packages. |
177 | |||
178 | Note that apt-panopticon will detect if you have no IPv6 conectivity, and | ||
179 | disable IPv6 tests automatically. | ||
167 | 180 | ||
168 | The old tests include a "DNS-RR" test, I'm not sure what that is. I | 181 | The old tests include a "DNS-RR" test, I'm not sure what that is. I |
169 | guess it checks if the mirror responds properly if it's accessed via it's | 182 | guess it checks if the mirror responds properly if it's accessed via it's |
@@ -187,20 +200,6 @@ Print the help text. | |||
187 | 200 | ||
188 | Print the version. | 201 | Print the version. |
189 | 202 | ||
190 | --tests | ||
191 | |||
192 | Select which tests to run. The arguments are comma separated. A | ||
193 | negative argument deselects a test. Examples are given above. | ||
194 | |||
195 | --referenceSite | ||
196 | |||
197 | The mirror to use as a reference for the tests, the default is | ||
198 | pkgmaster.devuan.org. | ||
199 | |||
200 | --roundRobin | ||
201 | |||
202 | The name of the DNS round robin domain, the default is deb.devuan.org. | ||
203 | |||
204 | -v | 203 | -v |
205 | 204 | ||
206 | Print more verbose output. Normally only CRITICAL and ERROR message sare | 205 | Print more verbose output. Normally only CRITICAL and ERROR message sare |
@@ -214,11 +213,52 @@ Only print CRITICAL messages. | |||
214 | -k | 213 | -k |
215 | 214 | ||
216 | Keep any results from the previous runs, instead of deleting them before | 215 | Keep any results from the previous runs, instead of deleting them before |
217 | running the tests. | 216 | running the tests. This may or may not be obsolete. |
217 | |||
218 | -4 and -6 | ||
219 | |||
220 | Used internally to pass around flags to make sure curl only tries to use | ||
221 | IPv4 or IPv6 as appropriate. | ||
222 | |||
223 | -o and -r | ||
218 | 224 | ||
219 | -n | 225 | Used internally to keep track of -origin server and -redirect server. |
220 | 226 | ||
221 | Don't fork the tests. Normally each mirror is run in its own fork. | 227 | --bandwidth, --low, --medium, --high, --more, and --all |
228 | |||
229 | Enable and disable tests that use more or less bandwidth. --bandwidth=x | ||
230 | where x is a digit between 0 and 4, and the other options are aliases for | ||
231 | those numbers. So --bandwidth=0 is the same as --low. --bandwidth=2 or | ||
232 | --high is the default. | ||
233 | |||
234 | --cgi | ||
235 | |||
236 | Use the php.cgi versions of the URLs for the graphs. | ||
237 | |||
238 | --maxtime, --retries, --timeout, and --timeouts | ||
239 | |||
240 | Various paramaters to determine how long to wait for downloads to | ||
241 | complete, how many retries to attempt for downloads that fail, how long | ||
242 | to wait for a connection, and how many timeouts to tolerate. | ||
243 | |||
244 | --referenceSite | ||
245 | |||
246 | The mirror to use as a reference for the tests, the default is | ||
247 | pkgmaster.devuan.org. | ||
248 | |||
249 | --roundRobin | ||
250 | |||
251 | The name of the DNS round robin domain, the default is deb.devuan.org. | ||
252 | |||
253 | --reports | ||
254 | |||
255 | Select which reports to generate. The arguments are comma separated. A | ||
256 | negative argument deselects a report. | ||
257 | |||
258 | --tests | ||
259 | |||
260 | Select which tests to run. The arguments are comma separated. A | ||
261 | negative argument deselects a test. Examples are given above. | ||
222 | 262 | ||
223 | 263 | ||
224 | Theory of operation. | 264 | Theory of operation. |