4 Commits

Author SHA1 Message Date
  biotorrents ddd90e9c0b Add GFDL license and info 4 years ago
  biotorrents 02ca03b707 Minor updates, less "note that" wording 4 years ago
  biotorrents 23b99bbb4e Final edits for now 4 years ago
  biotorrents 78ab6337d9 Redux 4 years ago
6 changed files with 73 additions and 943 deletions
  1. 0
    1
      .gitignore
  2. 0
    445
      docs/dl/license.md
  3. 48
    50
      docs/install.md
  4. 24
    445
      license.md
  5. 0
    1
      mkdocs.yml
  6. 1
    1
      readme.md

+ 0
- 1
.gitignore View File

1
 *.sw*
1
 *.sw*
2
-*~
3
 .DS_Store
2
 .DS_Store
4
 docs/dl/fonts.tgz
3
 docs/dl/fonts.tgz
5
 site/
4
 site/

+ 0
- 445
docs/dl/license.md View File

1
-# GNU Free Documentation License
2
-
3
-Version 1.3, 3 November 2008
4
-
5
-Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation,
6
-Inc. <https://fsf.org/>
7
-
8
-Everyone is permitted to copy and distribute verbatim copies of this
9
-license document, but changing it is not allowed.
10
-
11
-## 0. PREAMBLE
12
-
13
-The purpose of this License is to make a manual, textbook, or other
14
-functional and useful document "free" in the sense of freedom: to
15
-assure everyone the effective freedom to copy and redistribute it,
16
-with or without modifying it, either commercially or noncommercially.
17
-Secondarily, this License preserves for the author and publisher a way
18
-to get credit for their work, while not being considered responsible
19
-for modifications made by others.
20
-
21
-This License is a kind of "copyleft", which means that derivative
22
-works of the document must themselves be free in the same sense. It
23
-complements the GNU General Public License, which is a copyleft
24
-license designed for free software.
25
-
26
-We have designed this License in order to use it for manuals for free
27
-software, because free software needs free documentation: a free
28
-program should come with manuals providing the same freedoms that the
29
-software does. But this License is not limited to software manuals; it
30
-can be used for any textual work, regardless of subject matter or
31
-whether it is published as a printed book. We recommend this License
32
-principally for works whose purpose is instruction or reference.
33
-
34
-## 1. APPLICABILITY AND DEFINITIONS
35
-
36
-This License applies to any manual or other work, in any medium, that
37
-contains a notice placed by the copyright holder saying it can be
38
-distributed under the terms of this License. Such a notice grants a
39
-world-wide, royalty-free license, unlimited in duration, to use that
40
-work under the conditions stated herein. The "Document", below, refers
41
-to any such manual or work. Any member of the public is a licensee,
42
-and is addressed as "you". You accept the license if you copy, modify
43
-or distribute the work in a way requiring permission under copyright
44
-law.
45
-
46
-A "Modified Version" of the Document means any work containing the
47
-Document or a portion of it, either copied verbatim, or with
48
-modifications and/or translated into another language.
49
-
50
-A "Secondary Section" is a named appendix or a front-matter section of
51
-the Document that deals exclusively with the relationship of the
52
-publishers or authors of the Document to the Document's overall
53
-subject (or to related matters) and contains nothing that could fall
54
-directly within that overall subject. (Thus, if the Document is in
55
-part a textbook of mathematics, a Secondary Section may not explain
56
-any mathematics.) The relationship could be a matter of historical
57
-connection with the subject or with related matters, or of legal,
58
-commercial, philosophical, ethical or political position regarding
59
-them.
60
-
61
-The "Invariant Sections" are certain Secondary Sections whose titles
62
-are designated, as being those of Invariant Sections, in the notice
63
-that says that the Document is released under this License. If a
64
-section does not fit the above definition of Secondary then it is not
65
-allowed to be designated as Invariant. The Document may contain zero
66
-Invariant Sections. If the Document does not identify any Invariant
67
-Sections then there are none.
68
-
69
-The "Cover Texts" are certain short passages of text that are listed,
70
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
71
-the Document is released under this License. A Front-Cover Text may be
72
-at most 5 words, and a Back-Cover Text may be at most 25 words.
73
-
74
-A "Transparent" copy of the Document means a machine-readable copy,
75
-represented in a format whose specification is available to the
76
-general public, that is suitable for revising the document
77
-straightforwardly with generic text editors or (for images composed of
78
-pixels) generic paint programs or (for drawings) some widely available
79
-drawing editor, and that is suitable for input to text formatters or
80
-for automatic translation to a variety of formats suitable for input
81
-to text formatters. A copy made in an otherwise Transparent file
82
-format whose markup, or absence of markup, has been arranged to thwart
83
-or discourage subsequent modification by readers is not Transparent.
84
-An image format is not Transparent if used for any substantial amount
85
-of text. A copy that is not "Transparent" is called "Opaque".
86
-
87
-Examples of suitable formats for Transparent copies include plain
88
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
89
-or XML using a publicly available DTD, and standard-conforming simple
90
-HTML, PostScript or PDF designed for human modification. Examples of
91
-transparent image formats include PNG, XCF and JPG. Opaque formats
92
-include proprietary formats that can be read and edited only by
93
-proprietary word processors, SGML or XML for which the DTD and/or
94
-processing tools are not generally available, and the
95
-machine-generated HTML, PostScript or PDF produced by some word
96
-processors for output purposes only.
97
-
98
-The "Title Page" means, for a printed book, the title page itself,
99
-plus such following pages as are needed to hold, legibly, the material
100
-this License requires to appear in the title page. For works in
101
-formats which do not have any title page as such, "Title Page" means
102
-the text near the most prominent appearance of the work's title,
103
-preceding the beginning of the body of the text.
104
-
105
-The "publisher" means any person or entity that distributes copies of
106
-the Document to the public.
107
-
108
-A section "Entitled XYZ" means a named subunit of the Document whose
109
-title either is precisely XYZ or contains XYZ in parentheses following
110
-text that translates XYZ in another language. (Here XYZ stands for a
111
-specific section name mentioned below, such as "Acknowledgements",
112
-"Dedications", "Endorsements", or "History".) To "Preserve the Title"
113
-of such a section when you modify the Document means that it remains a
114
-section "Entitled XYZ" according to this definition.
115
-
116
-The Document may include Warranty Disclaimers next to the notice which
117
-states that this License applies to the Document. These Warranty
118
-Disclaimers are considered to be included by reference in this
119
-License, but only as regards disclaiming warranties: any other
120
-implication that these Warranty Disclaimers may have is void and has
121
-no effect on the meaning of this License.
122
-
123
-## 2. VERBATIM COPYING
124
-
125
-You may copy and distribute the Document in any medium, either
126
-commercially or noncommercially, provided that this License, the
127
-copyright notices, and the license notice saying this License applies
128
-to the Document are reproduced in all copies, and that you add no
129
-other conditions whatsoever to those of this License. You may not use
130
-technical measures to obstruct or control the reading or further
131
-copying of the copies you make or distribute. However, you may accept
132
-compensation in exchange for copies. If you distribute a large enough
133
-number of copies you must also follow the conditions in section 3.
134
-
135
-You may also lend copies, under the same conditions stated above, and
136
-you may publicly display copies.
137
-
138
-## 3. COPYING IN QUANTITY
139
-
140
-If you publish printed copies (or copies in media that commonly have
141
-printed covers) of the Document, numbering more than 100, and the
142
-Document's license notice requires Cover Texts, you must enclose the
143
-copies in covers that carry, clearly and legibly, all these Cover
144
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
145
-the back cover. Both covers must also clearly and legibly identify you
146
-as the publisher of these copies. The front cover must present the
147
-full title with all words of the title equally prominent and visible.
148
-You may add other material on the covers in addition. Copying with
149
-changes limited to the covers, as long as they preserve the title of
150
-the Document and satisfy these conditions, can be treated as verbatim
151
-copying in other respects.
152
-
153
-If the required texts for either cover are too voluminous to fit
154
-legibly, you should put the first ones listed (as many as fit
155
-reasonably) on the actual cover, and continue the rest onto adjacent
156
-pages.
157
-
158
-If you publish or distribute Opaque copies of the Document numbering
159
-more than 100, you must either include a machine-readable Transparent
160
-copy along with each Opaque copy, or state in or with each Opaque copy
161
-a computer-network location from which the general network-using
162
-public has access to download using public-standard network protocols
163
-a complete Transparent copy of the Document, free of added material.
164
-If you use the latter option, you must take reasonably prudent steps,
165
-when you begin distribution of Opaque copies in quantity, to ensure
166
-that this Transparent copy will remain thus accessible at the stated
167
-location until at least one year after the last time you distribute an
168
-Opaque copy (directly or through your agents or retailers) of that
169
-edition to the public.
170
-
171
-It is requested, but not required, that you contact the authors of the
172
-Document well before redistributing any large number of copies, to
173
-give them a chance to provide you with an updated version of the
174
-Document.
175
-
176
-## 4. MODIFICATIONS
177
-
178
-You may copy and distribute a Modified Version of the Document under
179
-the conditions of sections 2 and 3 above, provided that you release
180
-the Modified Version under precisely this License, with the Modified
181
-Version filling the role of the Document, thus licensing distribution
182
-and modification of the Modified Version to whoever possesses a copy
183
-of it. In addition, you must do these things in the Modified Version:
184
-
185
-- A. Use in the Title Page (and on the covers, if any) a title
186
-  distinct from that of the Document, and from those of previous
187
-  versions (which should, if there were any, be listed in the
188
-  History section of the Document). You may use the same title as a
189
-  previous version if the original publisher of that version
190
-  gives permission.
191
-- B. List on the Title Page, as authors, one or more persons or
192
-  entities responsible for authorship of the modifications in the
193
-  Modified Version, together with at least five of the principal
194
-  authors of the Document (all of its principal authors, if it has
195
-  fewer than five), unless they release you from this requirement.
196
-- C. State on the Title page the name of the publisher of the
197
-  Modified Version, as the publisher.
198
-- D. Preserve all the copyright notices of the Document.
199
-- E. Add an appropriate copyright notice for your modifications
200
-  adjacent to the other copyright notices.
201
-- F. Include, immediately after the copyright notices, a license
202
-  notice giving the public permission to use the Modified Version
203
-  under the terms of this License, in the form shown in the
204
-  Addendum below.
205
-- G. Preserve in that license notice the full lists of Invariant
206
-  Sections and required Cover Texts given in the Document's
207
-  license notice.
208
-- H. Include an unaltered copy of this License.
209
-- I. Preserve the section Entitled "History", Preserve its Title,
210
-  and add to it an item stating at least the title, year, new
211
-  authors, and publisher of the Modified Version as given on the
212
-  Title Page. If there is no section Entitled "History" in the
213
-  Document, create one stating the title, year, authors, and
214
-  publisher of the Document as given on its Title Page, then add an
215
-  item describing the Modified Version as stated in the
216
-  previous sentence.
217
-- J. Preserve the network location, if any, given in the Document
218
-  for public access to a Transparent copy of the Document, and
219
-  likewise the network locations given in the Document for previous
220
-  versions it was based on. These may be placed in the "History"
221
-  section. You may omit a network location for a work that was
222
-  published at least four years before the Document itself, or if
223
-  the original publisher of the version it refers to
224
-  gives permission.
225
-- K. For any section Entitled "Acknowledgements" or "Dedications",
226
-  Preserve the Title of the section, and preserve in the section all
227
-  the substance and tone of each of the contributor acknowledgements
228
-  and/or dedications given therein.
229
-- L. Preserve all the Invariant Sections of the Document, unaltered
230
-  in their text and in their titles. Section numbers or the
231
-  equivalent are not considered part of the section titles.
232
-- M. Delete any section Entitled "Endorsements". Such a section may
233
-  not be included in the Modified Version.
234
-- N. Do not retitle any existing section to be Entitled
235
-  "Endorsements" or to conflict in title with any Invariant Section.
236
-- O. Preserve any Warranty Disclaimers.
237
-
238
-If the Modified Version includes new front-matter sections or
239
-appendices that qualify as Secondary Sections and contain no material
240
-copied from the Document, you may at your option designate some or all
241
-of these sections as invariant. To do this, add their titles to the
242
-list of Invariant Sections in the Modified Version's license notice.
243
-These titles must be distinct from any other section titles.
244
-
245
-You may add a section Entitled "Endorsements", provided it contains
246
-nothing but endorsements of your Modified Version by various
247
-parties—for example, statements of peer review or that the text has
248
-been approved by an organization as the authoritative definition of a
249
-standard.
250
-
251
-You may add a passage of up to five words as a Front-Cover Text, and a
252
-passage of up to 25 words as a Back-Cover Text, to the end of the list
253
-of Cover Texts in the Modified Version. Only one passage of
254
-Front-Cover Text and one of Back-Cover Text may be added by (or
255
-through arrangements made by) any one entity. If the Document already
256
-includes a cover text for the same cover, previously added by you or
257
-by arrangement made by the same entity you are acting on behalf of,
258
-you may not add another; but you may replace the old one, on explicit
259
-permission from the previous publisher that added the old one.
260
-
261
-The author(s) and publisher(s) of the Document do not by this License
262
-give permission to use their names for publicity for or to assert or
263
-imply endorsement of any Modified Version.
264
-
265
-## 5. COMBINING DOCUMENTS
266
-
267
-You may combine the Document with other documents released under this
268
-License, under the terms defined in section 4 above for modified
269
-versions, provided that you include in the combination all of the
270
-Invariant Sections of all of the original documents, unmodified, and
271
-list them all as Invariant Sections of your combined work in its
272
-license notice, and that you preserve all their Warranty Disclaimers.
273
-
274
-The combined work need only contain one copy of this License, and
275
-multiple identical Invariant Sections may be replaced with a single
276
-copy. If there are multiple Invariant Sections with the same name but
277
-different contents, make the title of each such section unique by
278
-adding at the end of it, in parentheses, the name of the original
279
-author or publisher of that section if known, or else a unique number.
280
-Make the same adjustment to the section titles in the list of
281
-Invariant Sections in the license notice of the combined work.
282
-
283
-In the combination, you must combine any sections Entitled "History"
284
-in the various original documents, forming one section Entitled
285
-"History"; likewise combine any sections Entitled "Acknowledgements",
286
-and any sections Entitled "Dedications". You must delete all sections
287
-Entitled "Endorsements".
288
-
289
-## 6. COLLECTIONS OF DOCUMENTS
290
-
291
-You may make a collection consisting of the Document and other
292
-documents released under this License, and replace the individual
293
-copies of this License in the various documents with a single copy
294
-that is included in the collection, provided that you follow the rules
295
-of this License for verbatim copying of each of the documents in all
296
-other respects.
297
-
298
-You may extract a single document from such a collection, and
299
-distribute it individually under this License, provided you insert a
300
-copy of this License into the extracted document, and follow this
301
-License in all other respects regarding verbatim copying of that
302
-document.
303
-
304
-## 7. AGGREGATION WITH INDEPENDENT WORKS
305
-
306
-A compilation of the Document or its derivatives with other separate
307
-and independent documents or works, in or on a volume of a storage or
308
-distribution medium, is called an "aggregate" if the copyright
309
-resulting from the compilation is not used to limit the legal rights
310
-of the compilation's users beyond what the individual works permit.
311
-When the Document is included in an aggregate, this License does not
312
-apply to the other works in the aggregate which are not themselves
313
-derivative works of the Document.
314
-
315
-If the Cover Text requirement of section 3 is applicable to these
316
-copies of the Document, then if the Document is less than one half of
317
-the entire aggregate, the Document's Cover Texts may be placed on
318
-covers that bracket the Document within the aggregate, or the
319
-electronic equivalent of covers if the Document is in electronic form.
320
-Otherwise they must appear on printed covers that bracket the whole
321
-aggregate.
322
-
323
-## 8. TRANSLATION
324
-
325
-Translation is considered a kind of modification, so you may
326
-distribute translations of the Document under the terms of section 4.
327
-Replacing Invariant Sections with translations requires special
328
-permission from their copyright holders, but you may include
329
-translations of some or all Invariant Sections in addition to the
330
-original versions of these Invariant Sections. You may include a
331
-translation of this License, and all the license notices in the
332
-Document, and any Warranty Disclaimers, provided that you also include
333
-the original English version of this License and the original versions
334
-of those notices and disclaimers. In case of a disagreement between
335
-the translation and the original version of this License or a notice
336
-or disclaimer, the original version will prevail.
337
-
338
-If a section in the Document is Entitled "Acknowledgements",
339
-"Dedications", or "History", the requirement (section 4) to Preserve
340
-its Title (section 1) will typically require changing the actual
341
-title.
342
-
343
-## 9. TERMINATION
344
-
345
-You may not copy, modify, sublicense, or distribute the Document
346
-except as expressly provided under this License. Any attempt otherwise
347
-to copy, modify, sublicense, or distribute it is void, and will
348
-automatically terminate your rights under this License.
349
-
350
-However, if you cease all violation of this License, then your license
351
-from a particular copyright holder is reinstated (a) provisionally,
352
-unless and until the copyright holder explicitly and finally
353
-terminates your license, and (b) permanently, if the copyright holder
354
-fails to notify you of the violation by some reasonable means prior to
355
-60 days after the cessation.
356
-
357
-Moreover, your license from a particular copyright holder is
358
-reinstated permanently if the copyright holder notifies you of the
359
-violation by some reasonable means, this is the first time you have
360
-received notice of violation of this License (for any work) from that
361
-copyright holder, and you cure the violation prior to 30 days after
362
-your receipt of the notice.
363
-
364
-Termination of your rights under this section does not terminate the
365
-licenses of parties who have received copies or rights from you under
366
-this License. If your rights have been terminated and not permanently
367
-reinstated, receipt of a copy of some or all of the same material does
368
-not give you any rights to use it.
369
-
370
-## 10. FUTURE REVISIONS OF THIS LICENSE
371
-
372
-The Free Software Foundation may publish new, revised versions of the
373
-GNU Free Documentation License from time to time. Such new versions
374
-will be similar in spirit to the present version, but may differ in
375
-detail to address new problems or concerns. See
376
-<https://www.gnu.org/licenses/>.
377
-
378
-Each version of the License is given a distinguishing version number.
379
-If the Document specifies that a particular numbered version of this
380
-License "or any later version" applies to it, you have the option of
381
-following the terms and conditions either of that specified version or
382
-of any later version that has been published (not as a draft) by the
383
-Free Software Foundation. If the Document does not specify a version
384
-number of this License, you may choose any version ever published (not
385
-as a draft) by the Free Software Foundation. If the Document specifies
386
-that a proxy can decide which future versions of this License can be
387
-used, that proxy's public statement of acceptance of a version
388
-permanently authorizes you to choose that version for the Document.
389
-
390
-## 11. RELICENSING
391
-
392
-"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
393
-World Wide Web server that publishes copyrightable works and also
394
-provides prominent facilities for anybody to edit those works. A
395
-public wiki that anybody can edit is an example of such a server. A
396
-"Massive Multiauthor Collaboration" (or "MMC") contained in the site
397
-means any set of copyrightable works thus published on the MMC site.
398
-
399
-"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
400
-license published by Creative Commons Corporation, a not-for-profit
401
-corporation with a principal place of business in San Francisco,
402
-California, as well as future copyleft versions of that license
403
-published by that same organization.
404
-
405
-"Incorporate" means to publish or republish a Document, in whole or in
406
-part, as part of another Document.
407
-
408
-An MMC is "eligible for relicensing" if it is licensed under this
409
-License, and if all works that were first published under this License
410
-somewhere other than this MMC, and subsequently incorporated in whole
411
-or in part into the MMC, (1) had no cover texts or invariant sections,
412
-and (2) were thus incorporated prior to November 1, 2008.
413
-
414
-The operator of an MMC Site may republish an MMC contained in the site
415
-under CC-BY-SA on the same site at any time before August 1, 2009,
416
-provided the MMC is eligible for relicensing.
417
-
418
-# ADDENDUM: How to use this License for your documents
419
-
420
-To use this License in a document you have written, include a copy of
421
-the License in the document and put the following copyright and
422
-license notices just after the title page:
423
-
424
-        Copyright (C)  YEAR  YOUR NAME.
425
-        Permission is granted to copy, distribute and/or modify this document
426
-        under the terms of the GNU Free Documentation License, Version 1.3
427
-        or any later version published by the Free Software Foundation;
428
-        with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
429
-        A copy of the license is included in the section entitled "GNU
430
-        Free Documentation License".
431
-
432
-If you have Invariant Sections, Front-Cover Texts and Back-Cover
433
-Texts, replace the "with … Texts." line with this:
434
-
435
-        with the Invariant Sections being LIST THEIR TITLES, with the
436
-        Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
437
-
438
-If you have Invariant Sections without Cover Texts, or some other
439
-combination of the three, merge those two alternatives to suit the
440
-situation.
441
-
442
-If your document contains nontrivial examples of program code, we
443
-recommend releasing these examples in parallel under your choice of
444
-free software license, such as the GNU General Public License, to
445
-permit their use in free software.

+ 48
- 50
docs/install.md View File

1
 # Install
1
 # Install
2
 
2
 
3
-Thanks for your interest in BioTorrents.de's development!
4
-This guide, based on the
3
+Thanks for your interest in BioTorrents.de development!
4
+Gazelle is notoriously difficult to install and good docs are lacking.
5
+This page, based on the
5
 [original announcement protocol](https://github.com/biotorrents/announcement),
6
 [original announcement protocol](https://github.com/biotorrents/announcement),
6
-is an attempt at an evergreen install guide.
7
-It uses the format "one section per technology."
7
+is an attempt to make an evergreen install guide.
8
+It's fast paced and only covers the essentials.
8
 
9
 
9
 # Debian system profile
10
 # Debian system profile
10
 
11
 
33
 This section is done as root.
34
 This section is done as root.
34
 If you're in a user shell, preface commands with `sudo`.
35
 If you're in a user shell, preface commands with `sudo`.
35
 
36
 
36
-## Upgrading to Debian Sid
37
+## Upgrading to Debian unstable
37
 
38
 
38
 Install the most recent
39
 Install the most recent
39
 [Debian netinst image](https://www.debian.org/CD/netinst/)
40
 [Debian netinst image](https://www.debian.org/CD/netinst/)
59
 # reboot
60
 # reboot
60
 ```
61
 ```
61
 
62
 
62
-Further server setup, including DNS, email, etc., are beyond this guide's scope.
63
+Further server setup,
64
+including TLD considerations, DNS, email, etc.,
65
+are beyond this guide's scope.
63
 For more info about SSH, Unbound, NSD, OpenSMTPd, Dovecot, Unix users, etc.,
66
 For more info about SSH, Unbound, NSD, OpenSMTPd, Dovecot, Unix users, etc.,
64
 [please see the original launch announcement](https://github.com/biotorrents/announcement).
67
 [please see the original launch announcement](https://github.com/biotorrents/announcement).
65
 
68
 
68
 Install Nginx and Certbot with `apt install nginx certbot python3-certbot-nginx`.
71
 Install Nginx and Certbot with `apt install nginx certbot python3-certbot-nginx`.
69
 
72
 
70
 The basic Gazelle Nginx config should look similar to this.
73
 The basic Gazelle Nginx config should look similar to this.
71
-You'll likely have to change the file paths based on your setup.
72
-Also, PHP-FPM may need larger buffers to serve without 502 errors:
74
+Note that you'll likely have to change the file paths based on your setup.
75
+Also, PHP-FPM may need larger-than-default buffers to serve without 502 errors:
73
 
76
 
74
 ```nginx
77
 ```nginx
75
 server {
78
 server {
124
 ```
127
 ```
125
 
128
 
126
 The Nginx config for the Ocelot tracker should look like this.
129
 The Nginx config for the Ocelot tracker should look like this.
127
-Nginx acts as a TLS reverse proxy so Ocelot isn't directly exposed.
128
-Note the `Host` header (so tracker connections don't show up as localhost):
130
+Nginx acts as a TLS reverse proxy so that Ocelot isn't directly exposed.
131
+Note the additional caveats of Ocelot's listening port (34000 is default),
132
+and setting the correct `Host` header (so tracker connections don't show up as localhost):
129
 
133
 
130
 ```nginx
134
 ```nginx
131
 server {
135
 server {
159
 
163
 
160
 Please see the
164
 Please see the
161
 [Certbot docs](https://certbot.eff.org/docs/using.html)
165
 [Certbot docs](https://certbot.eff.org/docs/using.html)
162
-and
163
-[OWASP Secure Headers Project](https://owasp.org/www-project-secure-headers/)
164
 for more info.
166
 for more info.
167
+Also see the
168
+[OWASP Secure Headers Project](https://owasp.org/www-project-secure-headers/)
169
+for info on proper Nginx security.
165
 
170
 
166
 ## MariaDB
171
 ## MariaDB
167
 
172
 
168
 Install MariaDB with `apt install mariadb-server`
173
 Install MariaDB with `apt install mariadb-server`
169
 and initialize it with `mysql_secure_installation`.
174
 and initialize it with `mysql_secure_installation`.
170
 
175
 
171
-BioTorrents.de uses TLS connections to a dedicated database server.
176
+Note that BioTorrents.de uses TLS connections to a dedicated database server.
172
 Unix sockets are preferred for the database running on localhost.
177
 Unix sockets are preferred for the database running on localhost.
173
 The config should look similar to this, paying attention to `sql-mode`:
178
 The config should look similar to this, paying attention to `sql-mode`:
174
 
179
 
205
 They contain the necessary info to generate self-signed certs.
210
 They contain the necessary info to generate self-signed certs.
206
 
211
 
207
 Finally, load the Gazelle database schema in an SQL shell.
212
 Finally, load the Gazelle database schema in an SQL shell.
208
-I generate secure passphrases with `pwgen -s | encrypt`:
213
+I prefer to generate secure passphrases with `pwgen -s | encrypt`.
209
 
214
 
210
 ```mysql
215
 ```mysql
211
 CREATE DATABASE gazelle_development;
216
 CREATE DATABASE gazelle_development;
222
 `apt install php php-dev php-fpm`.
227
 `apt install php php-dev php-fpm`.
223
 
228
 
224
 The PHP extensions.
229
 The PHP extensions.
225
-There are two PHP memcached extensions.
230
+Note that there are two PHP memcached extensions.
226
 The correct one is just `php-memcache` without the "d."
231
 The correct one is just `php-memcache` without the "d."
227
 Your distro may require other extensions:
232
 Your distro may require other extensions:
228
 `php-apcu php-mbstring php-memcache php-mysql`.
233
 `php-apcu php-mbstring php-memcache php-mysql`.
229
 
234
 
230
 BioTorrents.de also supports the
235
 BioTorrents.de also supports the
231
 [Seqhash algorithm](https://blog.libredna.org/post/seqhash/)
236
 [Seqhash algorithm](https://blog.libredna.org/post/seqhash/)
232
-and requires Blake3 for this feature.
237
+and requires Blake3 hash support for this feature.
233
 Optionally, please install
238
 Optionally, please install
234
 [php-blake3](https://github.com/cypherbits/php-blake3).
239
 [php-blake3](https://github.com/cypherbits/php-blake3).
235
 
240
 
243
 Install memcached with `apt install memcached`.
248
 Install memcached with `apt install memcached`.
244
 
249
 
245
 BioTorrents.de supports separate production and development instances.
250
 BioTorrents.de supports separate production and development instances.
246
-If you with to run two instances, it's necessary to run memcached twice.
247
-Otherwise the sites will experience significant cross-contamination.
248
-The `/etc/memcached.conf` content:
251
+If you with to run two instances, it's necessary to run two memcached sockets.
252
+Otherwise the sites will experience significant data cross-contamination.
253
+The required `/etc/memcached.conf` content:
249
 
254
 
250
 ```
255
 ```
251
 -d
256
 -d
260
 A helper script to quickly bring up a second memcached as root:
265
 A helper script to quickly bring up a second memcached as root:
261
 
266
 
262
 ```shell
267
 ```shell
263
-#!/bin/sh
268
+#!/bin/bash
264
 memcached -d -m 5120 -s /var/run/memcached/memcached-dev.sock -a 0777 -t16 -C -u memcache
269
 memcached -d -m 5120 -s /var/run/memcached/memcached-dev.sock -a 0777 -t16 -C -u memcache
265
 ```
270
 ```
266
 
271
 
289
 # Application setup
294
 # Application setup
290
 
295
 
291
 This section should use a separate Unix user for each component.
296
 This section should use a separate Unix user for each component.
292
-Gazelle, Ocelot, IRC, and sitebot should each have their own home folder and shell.
293
-Otherwise the applications would be an insecure jumble and hard to maintain.
297
+Gazelle, Ocelot, IRC, and sitebot should each have a distinct home folder and full shell.
298
+The applications would otherwise be an insecure jumble and hard to maintain.
294
 
299
 
295
 ## Gazelle
300
 ## Gazelle
296
 
301
 
297
-Please use the
298
-[biotorrents/gazelle development branch](https://github.com/biotorrents/gazelle/tree/development)
299
-to grab the current working copy:
300
-
301
-```shell
302
-git clone --branch development https://github.com/biotorrents/gazelle.git
303
-git push origin development
304
-```
305
-
306
 First create the necessary files and folders.
302
 First create the necessary files and folders.
307
 Note that locations are arbitrary and may be one of:
303
 Note that locations are arbitrary and may be one of:
308
 home folder, subfolder of `/var/www`, etc.
304
 home folder, subfolder of `/var/www`, etc.
309
 
305
 
310
 ```shell
306
 ```shell
311
 # nginx(8) log location
307
 # nginx(8) log location
312
-mkdir -m 700 -p /var/www/log/{production,development}
313
-touch /var/www/log/{production,development/{peerupdate.log,schedule.log}
308
+mkdir -m 700 -p /var/www/log/{development,production}
309
+touch /var/www/log/production/{peerupdate.log,schedule.log}
310
+touch /var/www/log/development/{peerupdate.log,schedule.log}
314
 chown -R biotorrents:biotorrents /var/www/log
311
 chown -R biotorrents:biotorrents /var/www/log
315
 
312
 
316
 # files outside the web root
313
 # files outside the web root
317
-mkdir -m 700 -p /var/www/pictures /var/www/torrents /var/www/torrents-dev
314
+mkdir -m 700 -p /var/www/pictures /var/www/torrents
318
 chown -R www-data:www-data /var/www/pictures /var/www/torrents /var/www/torrents-dev
315
 chown -R www-data:www-data /var/www/pictures /var/www/torrents /var/www/torrents-dev
319
 ```
316
 ```
320
 
317
 
335
 find . -type d -print0 | xargs -0 chmod 0755
332
 find . -type d -print0 | xargs -0 chmod 0755
336
 ```
333
 ```
337
 
334
 
338
-### Application config
335
+### Gazelle app config
339
 
336
 
340
 [`classes/config.php`](https://github.com/biotorrents/gazelle/blob/development/classes/config.template.php)
337
 [`classes/config.php`](https://github.com/biotorrents/gazelle/blob/development/classes/config.template.php)
341
 warrants its own section.
338
 warrants its own section.
342
-When setting up Gazelle for the first time, set these options:
339
+When setting up Gazelle for the first time, these options must be enabled.
343
 
340
 
344
 - `'DEBUG_MODE' = false`
341
 - `'DEBUG_MODE' = false`
345
 - `'OPEN_REGISTRATION' = true`
342
 - `'OPEN_REGISTRATION' = true`
347
 
344
 
348
 Note the separate production and development values and the possibility of duplicate definitions.
345
 Note the separate production and development values and the possibility of duplicate definitions.
349
 BioTorrents.de uses a singleton class with extended recursive ArrayObject support invoked by
346
 BioTorrents.de uses a singleton class with extended recursive ArrayObject support invoked by
350
-[`$ENV = ENV::go()`](https://github.com/biotorrents/gazelle/blob/development/classes/env.class.php).
347
+[$ENV = ENV::go()](https://github.com/biotorrents/gazelle/blob/development/classes/env.class.php).
351
 
348
 
352
 There are some other values to set up.
349
 There are some other values to set up.
353
-Please pay attention to these values for proper functionality:
350
+Please pay attention to these values that Gazelle needs for proper function:
354
 
351
 
355
 - `SITE_DOMAIN` and `IMAGE_DOMAIN`
352
 - `SITE_DOMAIN` and `IMAGE_DOMAIN`
356
 - `WEB_ROOT` and `SERVER_ROOT`
353
 - `WEB_ROOT` and `SERVER_ROOT`
374
 ```
371
 ```
375
 
372
 
376
 Then add `/var/www/bin` to the Gazelle user's `$PATH` and run:
373
 Then add `/var/www/bin` to the Gazelle user's `$PATH` and run:
377
-`composer update`.
374
+`php composer.phar update`.
378
 
375
 
379
 ### SCSS and fonts
376
 ### SCSS and fonts
380
 
377
 
388
 This should be a for loop, to compile the CSS:
385
 This should be a for loop, to compile the CSS:
389
 
386
 
390
 ```shell
387
 ```shell
391
-#!/bin/sh
388
+#!/bin/bash
392
 styles="/var/www/html/dev.biotorrents.de/static/styles"
389
 styles="/var/www/html/dev.biotorrents.de/static/styles"
393
 sassc "$styles/beluga/beluga.scss" > "$styles/beluga.css"
390
 sassc "$styles/beluga/beluga.scss" > "$styles/beluga.css"
394
 sassc "$styles/bookish/bookish.scss" > "$styles/bookish.css"
391
 sassc "$styles/bookish/bookish.scss" > "$styles/bookish.css"
407
 [10th anniversary mixtape patches](https://twitter.com/whatcd/status/923942203080273921)
404
 [10th anniversary mixtape patches](https://twitter.com/whatcd/status/923942203080273921)
408
 and developing TLS support.
405
 and developing TLS support.
409
 The patched version is available at
406
 The patched version is available at
410
-[biotorrents/ocelot](https://github.com/biotorrents/ocelot).
407
+[biotorrents/ocelot](/biotorrents/ocelot).
411
 
408
 
412
-First installed the dependencies like below.
413
-The specific dependencies may differ on your system.
409
+Then installed the dependencies like below.
410
+Note that specific dependencies may differ on your system.
414
 
411
 
415
 ```shell
412
 ```shell
416
 apt install \
413
 apt install \
440
 make install
437
 make install
441
 ```
438
 ```
442
 
439
 
443
-Copy and edit `ocelot/ocelot.conf.dist` to the Ocelot user's home folder.
440
+Copy `ocelot/ocelot.conf.dist`.
444
 The daemon runs on `localhost:34000` and Nginx TLS reverse proxies it to `localhost:443`.
441
 The daemon runs on `localhost:34000` and Nginx TLS reverse proxies it to `localhost:443`.
445
-The Ocelot daemon runs in a tmux window under as a user process.
442
+`ocelot.conf` lives in the Ocelot user's home folder and the daemon runs in a tmux window there.
446
 
443
 
447
 ## IRC and kana (sitebot)
444
 ## IRC and kana (sitebot)
448
 
445
 
449
 Docs pending the completion of sitebot API integration.
446
 Docs pending the completion of sitebot API integration.
450
 
447
 
451
-## Inside the Gazelle Toolbox
448
+## Inside the Gazelle admin panel
452
 
449
 
453
 At this point it should be possible to register for the site.
450
 At this point it should be possible to register for the site.
454
 The first account is the sysop so please act quickly here.
451
 The first account is the sysop so please act quickly here.
455
 Disable `DEBUG_MODE` and `FEATURE_SET_ENC_KEY_PUBLIC` as soon as you register!
452
 Disable `DEBUG_MODE` and `FEATURE_SET_ENC_KEY_PUBLIC` as soon as you register!
456
-Then do `apt install qrencode` for 2FA support and enable it with a GPG key on the sysop account.
453
+Do `apt install qrencode` for 2FA support and enable it with a GPG key on the sysop account.
457
 
454
 
458
 Configure a client whitelist on the Toolbox page by the
455
 Configure a client whitelist on the Toolbox page by the
459
 [BitTorrent spec's peer ID list](https://wiki.theory.org/index.php/BitTorrentSpecification#peer_id).
456
 [BitTorrent spec's peer ID list](https://wiki.theory.org/index.php/BitTorrentSpecification#peer_id).
460
 Please find a list of quality client peer IDs below.
457
 Please find a list of quality client peer IDs below.
461
-LibTorrent 0.1x.y also covers rTorrent/ruTorrent and other clients that use
458
+Note that LibTorrent 0.1x.y also covers rTorrent/ruTorrent and other clients that use
462
 [rakshasa's library](https://github.com/rakshasa/libtorrent):
459
 [rakshasa's library](https://github.com/rakshasa/libtorrent):
463
 
460
 
464
 | Client Name       | Peer ID |
461
 | Client Name       | Peer ID |
475
 | Transmission 2.xy | `-TR2`  |
472
 | Transmission 2.xy | `-TR2`  |
476
 | Transmission 3.xy | `-TR3`  |
473
 | Transmission 3.xy | `-TR3`  |
477
 
474
 
478
-For more BitTorrent info see
475
+Most of the Toolbox pages don't write to the database and all of them should work.
476
+For more BitTorrents info see
479
 [Calomel's rTorrent hacking guide](https://calomel.org/rtorrent_mods.html).
477
 [Calomel's rTorrent hacking guide](https://calomel.org/rtorrent_mods.html).
480
 
478
 
481
-## Building these docs
479
+## Building this documentation
482
 
480
 
483
 [biotorrents/documentation](https://github.com/biotorrents/documentation)
481
 [biotorrents/documentation](https://github.com/biotorrents/documentation)
484
 has the Mkdocs source code.
482
 has the Mkdocs source code.

+ 24
- 445
license.md View File

1
-# GNU Free Documentation License
2
-
3
-Version 1.3, 3 November 2008
4
-
5
-Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation,
6
-Inc. <https://fsf.org/>
7
-
8
-Everyone is permitted to copy and distribute verbatim copies of this
9
-license document, but changing it is not allowed.
10
-
11
-## 0. PREAMBLE
12
-
13
-The purpose of this License is to make a manual, textbook, or other
14
-functional and useful document "free" in the sense of freedom: to
15
-assure everyone the effective freedom to copy and redistribute it,
16
-with or without modifying it, either commercially or noncommercially.
17
-Secondarily, this License preserves for the author and publisher a way
18
-to get credit for their work, while not being considered responsible
19
-for modifications made by others.
20
-
21
-This License is a kind of "copyleft", which means that derivative
22
-works of the document must themselves be free in the same sense. It
23
-complements the GNU General Public License, which is a copyleft
24
-license designed for free software.
25
-
26
-We have designed this License in order to use it for manuals for free
27
-software, because free software needs free documentation: a free
28
-program should come with manuals providing the same freedoms that the
29
-software does. But this License is not limited to software manuals; it
30
-can be used for any textual work, regardless of subject matter or
31
-whether it is published as a printed book. We recommend this License
32
-principally for works whose purpose is instruction or reference.
33
-
34
-## 1. APPLICABILITY AND DEFINITIONS
35
-
36
-This License applies to any manual or other work, in any medium, that
37
-contains a notice placed by the copyright holder saying it can be
38
-distributed under the terms of this License. Such a notice grants a
39
-world-wide, royalty-free license, unlimited in duration, to use that
40
-work under the conditions stated herein. The "Document", below, refers
41
-to any such manual or work. Any member of the public is a licensee,
42
-and is addressed as "you". You accept the license if you copy, modify
43
-or distribute the work in a way requiring permission under copyright
44
-law.
45
-
46
-A "Modified Version" of the Document means any work containing the
47
-Document or a portion of it, either copied verbatim, or with
48
-modifications and/or translated into another language.
49
-
50
-A "Secondary Section" is a named appendix or a front-matter section of
51
-the Document that deals exclusively with the relationship of the
52
-publishers or authors of the Document to the Document's overall
53
-subject (or to related matters) and contains nothing that could fall
54
-directly within that overall subject. (Thus, if the Document is in
55
-part a textbook of mathematics, a Secondary Section may not explain
56
-any mathematics.) The relationship could be a matter of historical
57
-connection with the subject or with related matters, or of legal,
58
-commercial, philosophical, ethical or political position regarding
59
-them.
60
-
61
-The "Invariant Sections" are certain Secondary Sections whose titles
62
-are designated, as being those of Invariant Sections, in the notice
63
-that says that the Document is released under this License. If a
64
-section does not fit the above definition of Secondary then it is not
65
-allowed to be designated as Invariant. The Document may contain zero
66
-Invariant Sections. If the Document does not identify any Invariant
67
-Sections then there are none.
68
-
69
-The "Cover Texts" are certain short passages of text that are listed,
70
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
71
-the Document is released under this License. A Front-Cover Text may be
72
-at most 5 words, and a Back-Cover Text may be at most 25 words.
73
-
74
-A "Transparent" copy of the Document means a machine-readable copy,
75
-represented in a format whose specification is available to the
76
-general public, that is suitable for revising the document
77
-straightforwardly with generic text editors or (for images composed of
78
-pixels) generic paint programs or (for drawings) some widely available
79
-drawing editor, and that is suitable for input to text formatters or
80
-for automatic translation to a variety of formats suitable for input
81
-to text formatters. A copy made in an otherwise Transparent file
82
-format whose markup, or absence of markup, has been arranged to thwart
83
-or discourage subsequent modification by readers is not Transparent.
84
-An image format is not Transparent if used for any substantial amount
85
-of text. A copy that is not "Transparent" is called "Opaque".
86
-
87
-Examples of suitable formats for Transparent copies include plain
88
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
89
-or XML using a publicly available DTD, and standard-conforming simple
90
-HTML, PostScript or PDF designed for human modification. Examples of
91
-transparent image formats include PNG, XCF and JPG. Opaque formats
92
-include proprietary formats that can be read and edited only by
93
-proprietary word processors, SGML or XML for which the DTD and/or
94
-processing tools are not generally available, and the
95
-machine-generated HTML, PostScript or PDF produced by some word
96
-processors for output purposes only.
97
-
98
-The "Title Page" means, for a printed book, the title page itself,
99
-plus such following pages as are needed to hold, legibly, the material
100
-this License requires to appear in the title page. For works in
101
-formats which do not have any title page as such, "Title Page" means
102
-the text near the most prominent appearance of the work's title,
103
-preceding the beginning of the body of the text.
104
-
105
-The "publisher" means any person or entity that distributes copies of
106
-the Document to the public.
107
-
108
-A section "Entitled XYZ" means a named subunit of the Document whose
109
-title either is precisely XYZ or contains XYZ in parentheses following
110
-text that translates XYZ in another language. (Here XYZ stands for a
111
-specific section name mentioned below, such as "Acknowledgements",
112
-"Dedications", "Endorsements", or "History".) To "Preserve the Title"
113
-of such a section when you modify the Document means that it remains a
114
-section "Entitled XYZ" according to this definition.
115
-
116
-The Document may include Warranty Disclaimers next to the notice which
117
-states that this License applies to the Document. These Warranty
118
-Disclaimers are considered to be included by reference in this
119
-License, but only as regards disclaiming warranties: any other
120
-implication that these Warranty Disclaimers may have is void and has
121
-no effect on the meaning of this License.
122
-
123
-## 2. VERBATIM COPYING
124
-
125
-You may copy and distribute the Document in any medium, either
126
-commercially or noncommercially, provided that this License, the
127
-copyright notices, and the license notice saying this License applies
128
-to the Document are reproduced in all copies, and that you add no
129
-other conditions whatsoever to those of this License. You may not use
130
-technical measures to obstruct or control the reading or further
131
-copying of the copies you make or distribute. However, you may accept
132
-compensation in exchange for copies. If you distribute a large enough
133
-number of copies you must also follow the conditions in section 3.
134
-
135
-You may also lend copies, under the same conditions stated above, and
136
-you may publicly display copies.
137
-
138
-## 3. COPYING IN QUANTITY
139
-
140
-If you publish printed copies (or copies in media that commonly have
141
-printed covers) of the Document, numbering more than 100, and the
142
-Document's license notice requires Cover Texts, you must enclose the
143
-copies in covers that carry, clearly and legibly, all these Cover
144
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
145
-the back cover. Both covers must also clearly and legibly identify you
146
-as the publisher of these copies. The front cover must present the
147
-full title with all words of the title equally prominent and visible.
148
-You may add other material on the covers in addition. Copying with
149
-changes limited to the covers, as long as they preserve the title of
150
-the Document and satisfy these conditions, can be treated as verbatim
151
-copying in other respects.
152
-
153
-If the required texts for either cover are too voluminous to fit
154
-legibly, you should put the first ones listed (as many as fit
155
-reasonably) on the actual cover, and continue the rest onto adjacent
156
-pages.
157
-
158
-If you publish or distribute Opaque copies of the Document numbering
159
-more than 100, you must either include a machine-readable Transparent
160
-copy along with each Opaque copy, or state in or with each Opaque copy
161
-a computer-network location from which the general network-using
162
-public has access to download using public-standard network protocols
163
-a complete Transparent copy of the Document, free of added material.
164
-If you use the latter option, you must take reasonably prudent steps,
165
-when you begin distribution of Opaque copies in quantity, to ensure
166
-that this Transparent copy will remain thus accessible at the stated
167
-location until at least one year after the last time you distribute an
168
-Opaque copy (directly or through your agents or retailers) of that
169
-edition to the public.
170
-
171
-It is requested, but not required, that you contact the authors of the
172
-Document well before redistributing any large number of copies, to
173
-give them a chance to provide you with an updated version of the
174
-Document.
175
-
176
-## 4. MODIFICATIONS
177
-
178
-You may copy and distribute a Modified Version of the Document under
179
-the conditions of sections 2 and 3 above, provided that you release
180
-the Modified Version under precisely this License, with the Modified
181
-Version filling the role of the Document, thus licensing distribution
182
-and modification of the Modified Version to whoever possesses a copy
183
-of it. In addition, you must do these things in the Modified Version:
184
-
185
-- A. Use in the Title Page (and on the covers, if any) a title
186
-  distinct from that of the Document, and from those of previous
187
-  versions (which should, if there were any, be listed in the
188
-  History section of the Document). You may use the same title as a
189
-  previous version if the original publisher of that version
190
-  gives permission.
191
-- B. List on the Title Page, as authors, one or more persons or
192
-  entities responsible for authorship of the modifications in the
193
-  Modified Version, together with at least five of the principal
194
-  authors of the Document (all of its principal authors, if it has
195
-  fewer than five), unless they release you from this requirement.
196
-- C. State on the Title page the name of the publisher of the
197
-  Modified Version, as the publisher.
198
-- D. Preserve all the copyright notices of the Document.
199
-- E. Add an appropriate copyright notice for your modifications
200
-  adjacent to the other copyright notices.
201
-- F. Include, immediately after the copyright notices, a license
202
-  notice giving the public permission to use the Modified Version
203
-  under the terms of this License, in the form shown in the
204
-  Addendum below.
205
-- G. Preserve in that license notice the full lists of Invariant
206
-  Sections and required Cover Texts given in the Document's
207
-  license notice.
208
-- H. Include an unaltered copy of this License.
209
-- I. Preserve the section Entitled "History", Preserve its Title,
210
-  and add to it an item stating at least the title, year, new
211
-  authors, and publisher of the Modified Version as given on the
212
-  Title Page. If there is no section Entitled "History" in the
213
-  Document, create one stating the title, year, authors, and
214
-  publisher of the Document as given on its Title Page, then add an
215
-  item describing the Modified Version as stated in the
216
-  previous sentence.
217
-- J. Preserve the network location, if any, given in the Document
218
-  for public access to a Transparent copy of the Document, and
219
-  likewise the network locations given in the Document for previous
220
-  versions it was based on. These may be placed in the "History"
221
-  section. You may omit a network location for a work that was
222
-  published at least four years before the Document itself, or if
223
-  the original publisher of the version it refers to
224
-  gives permission.
225
-- K. For any section Entitled "Acknowledgements" or "Dedications",
226
-  Preserve the Title of the section, and preserve in the section all
227
-  the substance and tone of each of the contributor acknowledgements
228
-  and/or dedications given therein.
229
-- L. Preserve all the Invariant Sections of the Document, unaltered
230
-  in their text and in their titles. Section numbers or the
231
-  equivalent are not considered part of the section titles.
232
-- M. Delete any section Entitled "Endorsements". Such a section may
233
-  not be included in the Modified Version.
234
-- N. Do not retitle any existing section to be Entitled
235
-  "Endorsements" or to conflict in title with any Invariant Section.
236
-- O. Preserve any Warranty Disclaimers.
237
-
238
-If the Modified Version includes new front-matter sections or
239
-appendices that qualify as Secondary Sections and contain no material
240
-copied from the Document, you may at your option designate some or all
241
-of these sections as invariant. To do this, add their titles to the
242
-list of Invariant Sections in the Modified Version's license notice.
243
-These titles must be distinct from any other section titles.
244
-
245
-You may add a section Entitled "Endorsements", provided it contains
246
-nothing but endorsements of your Modified Version by various
247
-parties—for example, statements of peer review or that the text has
248
-been approved by an organization as the authoritative definition of a
249
-standard.
250
-
251
-You may add a passage of up to five words as a Front-Cover Text, and a
252
-passage of up to 25 words as a Back-Cover Text, to the end of the list
253
-of Cover Texts in the Modified Version. Only one passage of
254
-Front-Cover Text and one of Back-Cover Text may be added by (or
255
-through arrangements made by) any one entity. If the Document already
256
-includes a cover text for the same cover, previously added by you or
257
-by arrangement made by the same entity you are acting on behalf of,
258
-you may not add another; but you may replace the old one, on explicit
259
-permission from the previous publisher that added the old one.
260
-
261
-The author(s) and publisher(s) of the Document do not by this License
262
-give permission to use their names for publicity for or to assert or
263
-imply endorsement of any Modified Version.
264
-
265
-## 5. COMBINING DOCUMENTS
266
-
267
-You may combine the Document with other documents released under this
268
-License, under the terms defined in section 4 above for modified
269
-versions, provided that you include in the combination all of the
270
-Invariant Sections of all of the original documents, unmodified, and
271
-list them all as Invariant Sections of your combined work in its
272
-license notice, and that you preserve all their Warranty Disclaimers.
273
-
274
-The combined work need only contain one copy of this License, and
275
-multiple identical Invariant Sections may be replaced with a single
276
-copy. If there are multiple Invariant Sections with the same name but
277
-different contents, make the title of each such section unique by
278
-adding at the end of it, in parentheses, the name of the original
279
-author or publisher of that section if known, or else a unique number.
280
-Make the same adjustment to the section titles in the list of
281
-Invariant Sections in the license notice of the combined work.
282
-
283
-In the combination, you must combine any sections Entitled "History"
284
-in the various original documents, forming one section Entitled
285
-"History"; likewise combine any sections Entitled "Acknowledgements",
286
-and any sections Entitled "Dedications". You must delete all sections
287
-Entitled "Endorsements".
288
-
289
-## 6. COLLECTIONS OF DOCUMENTS
290
-
291
-You may make a collection consisting of the Document and other
292
-documents released under this License, and replace the individual
293
-copies of this License in the various documents with a single copy
294
-that is included in the collection, provided that you follow the rules
295
-of this License for verbatim copying of each of the documents in all
296
-other respects.
297
-
298
-You may extract a single document from such a collection, and
299
-distribute it individually under this License, provided you insert a
300
-copy of this License into the extracted document, and follow this
301
-License in all other respects regarding verbatim copying of that
302
-document.
303
-
304
-## 7. AGGREGATION WITH INDEPENDENT WORKS
305
-
306
-A compilation of the Document or its derivatives with other separate
307
-and independent documents or works, in or on a volume of a storage or
308
-distribution medium, is called an "aggregate" if the copyright
309
-resulting from the compilation is not used to limit the legal rights
310
-of the compilation's users beyond what the individual works permit.
311
-When the Document is included in an aggregate, this License does not
312
-apply to the other works in the aggregate which are not themselves
313
-derivative works of the Document.
314
-
315
-If the Cover Text requirement of section 3 is applicable to these
316
-copies of the Document, then if the Document is less than one half of
317
-the entire aggregate, the Document's Cover Texts may be placed on
318
-covers that bracket the Document within the aggregate, or the
319
-electronic equivalent of covers if the Document is in electronic form.
320
-Otherwise they must appear on printed covers that bracket the whole
321
-aggregate.
322
-
323
-## 8. TRANSLATION
324
-
325
-Translation is considered a kind of modification, so you may
326
-distribute translations of the Document under the terms of section 4.
327
-Replacing Invariant Sections with translations requires special
328
-permission from their copyright holders, but you may include
329
-translations of some or all Invariant Sections in addition to the
330
-original versions of these Invariant Sections. You may include a
331
-translation of this License, and all the license notices in the
332
-Document, and any Warranty Disclaimers, provided that you also include
333
-the original English version of this License and the original versions
334
-of those notices and disclaimers. In case of a disagreement between
335
-the translation and the original version of this License or a notice
336
-or disclaimer, the original version will prevail.
337
-
338
-If a section in the Document is Entitled "Acknowledgements",
339
-"Dedications", or "History", the requirement (section 4) to Preserve
340
-its Title (section 1) will typically require changing the actual
341
-title.
342
-
343
-## 9. TERMINATION
344
-
345
-You may not copy, modify, sublicense, or distribute the Document
346
-except as expressly provided under this License. Any attempt otherwise
347
-to copy, modify, sublicense, or distribute it is void, and will
348
-automatically terminate your rights under this License.
349
-
350
-However, if you cease all violation of this License, then your license
351
-from a particular copyright holder is reinstated (a) provisionally,
352
-unless and until the copyright holder explicitly and finally
353
-terminates your license, and (b) permanently, if the copyright holder
354
-fails to notify you of the violation by some reasonable means prior to
355
-60 days after the cessation.
356
-
357
-Moreover, your license from a particular copyright holder is
358
-reinstated permanently if the copyright holder notifies you of the
359
-violation by some reasonable means, this is the first time you have
360
-received notice of violation of this License (for any work) from that
361
-copyright holder, and you cure the violation prior to 30 days after
362
-your receipt of the notice.
363
-
364
-Termination of your rights under this section does not terminate the
365
-licenses of parties who have received copies or rights from you under
366
-this License. If your rights have been terminated and not permanently
367
-reinstated, receipt of a copy of some or all of the same material does
368
-not give you any rights to use it.
369
-
370
-## 10. FUTURE REVISIONS OF THIS LICENSE
371
-
372
-The Free Software Foundation may publish new, revised versions of the
373
-GNU Free Documentation License from time to time. Such new versions
374
-will be similar in spirit to the present version, but may differ in
375
-detail to address new problems or concerns. See
376
-<https://www.gnu.org/licenses/>.
377
-
378
-Each version of the License is given a distinguishing version number.
379
-If the Document specifies that a particular numbered version of this
380
-License "or any later version" applies to it, you have the option of
381
-following the terms and conditions either of that specified version or
382
-of any later version that has been published (not as a draft) by the
383
-Free Software Foundation. If the Document does not specify a version
384
-number of this License, you may choose any version ever published (not
385
-as a draft) by the Free Software Foundation. If the Document specifies
386
-that a proxy can decide which future versions of this License can be
387
-used, that proxy's public statement of acceptance of a version
388
-permanently authorizes you to choose that version for the Document.
389
-
390
-## 11. RELICENSING
391
-
392
-"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
393
-World Wide Web server that publishes copyrightable works and also
394
-provides prominent facilities for anybody to edit those works. A
395
-public wiki that anybody can edit is an example of such a server. A
396
-"Massive Multiauthor Collaboration" (or "MMC") contained in the site
397
-means any set of copyrightable works thus published on the MMC site.
398
-
399
-"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
400
-license published by Creative Commons Corporation, a not-for-profit
401
-corporation with a principal place of business in San Francisco,
402
-California, as well as future copyleft versions of that license
403
-published by that same organization.
404
-
405
-"Incorporate" means to publish or republish a Document, in whole or in
406
-part, as part of another Document.
407
-
408
-An MMC is "eligible for relicensing" if it is licensed under this
409
-License, and if all works that were first published under this License
410
-somewhere other than this MMC, and subsequently incorporated in whole
411
-or in part into the MMC, (1) had no cover texts or invariant sections,
412
-and (2) were thus incorporated prior to November 1, 2008.
413
-
414
-The operator of an MMC Site may republish an MMC contained in the site
415
-under CC-BY-SA on the same site at any time before August 1, 2009,
416
-provided the MMC is eligible for relicensing.
417
-
418
-# ADDENDUM: How to use this License for your documents
419
-
420
-To use this License in a document you have written, include a copy of
421
-the License in the document and put the following copyright and
422
-license notices just after the title page:
423
-
424
-        Copyright (C)  YEAR  YOUR NAME.
425
-        Permission is granted to copy, distribute and/or modify this document
426
-        under the terms of the GNU Free Documentation License, Version 1.3
427
-        or any later version published by the Free Software Foundation;
428
-        with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
429
-        A copy of the license is included in the section entitled "GNU
430
-        Free Documentation License".
431
-
432
-If you have Invariant Sections, Front-Cover Texts and Back-Cover
433
-Texts, replace the "with … Texts." line with this:
434
-
435
-        with the Invariant Sections being LIST THEIR TITLES, with the
436
-        Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
437
-
438
-If you have Invariant Sections without Cover Texts, or some other
439
-combination of the three, merge those two alternatives to suit the
440
-situation.
441
-
442
-If your document contains nontrivial examples of program code, we
443
-recommend releasing these examples in parallel under your choice of
444
-free software license, such as the GNU General Public License, to
445
-permit their use in free software.
1
+This is free and unencumbered software released into the public domain.
2
+
3
+Anyone is free to copy, modify, publish, use, compile, sell, or
4
+distribute this software, either in source code form or as a compiled
5
+binary, for any purpose, commercial or non-commercial, and by any
6
+means.
7
+
8
+In jurisdictions that recognize copyright laws, the author or authors
9
+of this software dedicate any and all copyright interest in the
10
+software to the public domain. We make this dedication for the benefit
11
+of the public at large and to the detriment of our heirs and
12
+successors. We intend this dedication to be an overt act of
13
+relinquishment in perpetuity of all present and future rights to this
14
+software under copyright law.
15
+
16
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+OTHER DEALINGS IN THE SOFTWARE.
23
+
24
+For more information, please refer to <http://unlicense.org>

+ 0
- 1
mkdocs.yml View File

2
 
2
 
3
 site_name: "Docs ⸬ BioTorrents.de"
3
 site_name: "Docs ⸬ BioTorrents.de"
4
 site_url: "https://docs.biotorrents.de"
4
 site_url: "https://docs.biotorrents.de"
5
-copyright: "© 2021 <a href='/dl/license'>GFDL 1.3</a>"
6
 
5
 
7
 repo_url: "https://github.com/biotorrents/gazelle"
6
 repo_url: "https://github.com/biotorrents/gazelle"
8
 edit_uri: ""
7
 edit_uri: ""

+ 1
- 1
readme.md View File

1
 MkDocs Markdown files for the JSON API documentation.
1
 MkDocs Markdown files for the JSON API documentation.
2
 Please see
2
 Please see
3
-[Docs ⸬ BioTorrents.de](https://docs.biotorrents.de)
3
+[API ⸬ BioTorrents.de](https://docs.biotorrents.de)
4
 for more info.
4
 for more info.
5
 Now includes a Gazelle install guide!
5
 Now includes a Gazelle install guide!

Loading…
Cancel
Save