├── .gitignore ├── SSL.md ├── CONTRIBUTING.md ├── Domains.md ├── README.md ├── Setup.md ├── Configuration.md ├── Nginx.md ├── Hosting.md └── LICENSE.md /.gitignore: -------------------------------------------------------------------------------- 1 | # ================================= # 2 | # THIS FILE IS NOT PART OF PROXDOCS # 3 | # PLEASE IGNORE THIS FILE # 4 | # ================================= # 5 | 6 | # Ignore files auto-generated by IDEs 7 | .replit 8 | .vscode 9 | .idea -------------------------------------------------------------------------------- /SSL.md: -------------------------------------------------------------------------------- 1 | # SSL/TLS 2 | This will require that you have followed the ProxDocs guide to install and use [Nginx](https://github.com/Degen-dev/ProxDocs/blob/master/Nginx.md). 3 | 4 | SSL will allow users to access your instance in a secure manner. Using Nginx and Certbot will allow you to generate and use SSL certificates for free. To install Certbot, run the following command: 5 | ```sh 6 | $ sudo apt install certbot 7 | ``` 8 | After installing Certbot run the following command to add SSL to your site: 9 | ```sh 10 | $ certbot --nginx -d your.domain.com 11 | ``` 12 | Don't forget to replace `your.domain.com` with your actual domain. 13 | 14 | ## Authors 15 | - [Degen-dev (Degenerate)](https://github.com/Degen-dev) 16 | - [EnderKingJ](https://github.com/EnderKingJ) 17 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to ProxDocs 2 | ProxDocs can't write itself, thank you for wanting to contribute to ProxDocs! 3 | 4 | ## Issues 5 | There is no out of the ordinary guidelines for making an issue to ProxDocs. Just be sure to include a brief description of the issue you are having in your issue. 6 | 7 | ### Suggestions/Proposals 8 | To contribute a suggestion or proposal, please open an issue. The issue should include what you want changed and why you want it to be changed. 9 | 10 | ## Commit Message Guidelines 11 | For commit messages, please capitalize the first letter of your commit message and don't include any swears or slurs in the commit message. An example of an appropriate commit message can be found below: 12 | ``` 13 | Fix a typo in SSL.md 14 | ``` 15 | 16 | ## Pull Requests 17 | Pull requests are the easiest and most effective way to contribute to ProxDocs. In your pull request, make sure it is against the `master` branch, you don't have merges, and that no merge conflicts are present. If a merge conflict is present, please rebase by running `git rebase -i`. -------------------------------------------------------------------------------- /Domains.md: -------------------------------------------------------------------------------- 1 | # Domains 2 | Once you've got hosting down, you need to purchase domains for your instance of a site. This will list some of, what I believe to be, the most useful places to register a domain. 3 | 4 | | Registar | Reasons to Use and Reasons Not to Use | 5 | | -------- | ------------------------------------- | 6 | | [Porkbun](https://porkbun.com) | Porkbun is notoriously known for being very inexpensive. At some points, domains ending in `.xyz` or `.top` will be sold by porkbun for less than a dollar. 7 | | [Njalla](https://njal.la) | Njalla is the most expensive option on this list. For some, it is worth the price for the benefits that come with it, but for most, it is not recommended. The cheapest domains that they offer start at ~$15 USD. | 8 | | [Namecheap](https://www.namecheap.com/) | Namecheap is cheap. You can purchase a `.com` domain for as little as $0.98 USD, however they are usually not that inexpensive. Porkbun beats them in price for some TLDs. | 9 | | [Freenom](https://www.freenom.com) | Freenom offers some domains for free for 1 year. The problem with Freenom Domains, however, is that the free TLDs that they offer are blocked by most web filters by default. I would only recommend Freenom as a last resort if all other option aren't viable for your uses. | 10 | 11 | ## Authors 12 | - [Degen-dev (Degenerate)](https://github.com/Degen-dev) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ProxDocs 2 | ProxDocs is a highly detailed and useful guide to hosting a web proxy site. 3 | 4 | ## Why? 5 | Making "sufficient" documentation for a proxy site is difficult and lengthy. ProxDocs exists so that proxy site developers do not have to make lengthy documentation for their site, but can rather point users to this instead, allowing aspiring self-hosters to more easily be able to set up their own instance of your site! 6 | 7 | ## Table Of Contents 8 | - [Setup](https://github.com/Degen-dev/ProxDocs/blob/master/Setup.md) 9 | - [Configuration](https://github.com/Degen-dev/ProxDocs/blob/master/Configuration.md) 10 | - [Hosting](https://github.com/Degen-dev/ProxDocs/blob/master/Hosting.md) 11 | - [Domains](https://github.com/Degen-dev/ProxDocs/blob/master/Domains.md) 12 | - [Nginx](https://github.com/Degen-dev/ProxDocs/blob/master/Nginx.md) 13 | - [SSL/TLS](https://github.com/Degen-dev/ProxDocs/blob/master/SSL.md) 14 | ## Authors 15 | The authors of each file can be viewed in the "Authors" section of each file. 16 | 17 | ## Contributing 18 | See [CONTRIBUTING.md](https://github.com/Degen-dev/ProxDocs/blob/master/CONTRIBUTING.md) for information on contributing to ProxDocs. 19 | 20 | ## License 21 | ``` 22 | Copyright (C) 2022-present, Degen-dev 23 | 24 | Permission is granted to copy, distribute and/or modify this document 25 | under the terms of the GNU Free Documentation License, Version 1.3 26 | or any later version published by the Free Software Foundation; 27 | with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. 28 | A copy of the license is included in the file entitled "LICENSE.md". 29 | ``` 30 | 31 | ## TODO 32 | - Clean everything up 33 | - Possibly make a website for ProxDocs 34 | - Possible add docs to use Cloudflare -------------------------------------------------------------------------------- /Setup.md: -------------------------------------------------------------------------------- 1 | # Basic Setup 2 | Often times, a proxy site that is open source will include basic setup instructions for their site. These instructions normally include how to clone the repository, and how to run or "start" the backend web proxy, as well as serve the static files of the site. 3 | 4 | ## Cloning 5 | Cloning a proxy is as simple as running `git clone`, and then the link to the repository. See an example below: 6 | ```sh 7 | $ git clone https://github.com/Degen-dev/Degeneracy 8 | ``` 9 | 10 | Be sure to replace `Degen-dev/Degeneracy` with the repo to the proxy you are trying to clone, assuming you are not trying to clone Degeneracy. 11 | 12 | ## Installing Dependencies 13 | Web proxies and proxy sites will have dependencies in order to get them up and running. In general, a proxy site will use a Node.js framework to serve static files and [NPM](https://www.npmjs.com) to install dependencies. To install dependencies, you will need to cd into the repository you just cloned and then run `npm install` The commands can be seen below: 14 | ```sh 15 | $ cd RepoName 16 | $ npm install 17 | ``` 18 | 19 | Be sure to change "RepoName" to the actual name of the repo you just cloned. 20 | 21 | ## Starting the Site 22 | Sometimes the creator of a site will include a start script in npm that makes it as simple as possible to start the proxy. See the command below: 23 | ```sh 24 | $ npm start 25 | ``` 26 | 27 | Assuming the site does not include a start script, you will have to find the index file manually. In general, the file name will be something along the lines of `main.js`, `index.js` or `start.js`. To run the file, simply run the following command: 28 | ```sh 29 | $ node {filename}.js 30 | ``` 31 | 32 | Be sure to exclude the curly brackets and change `filename` to the actual name of the file you are trying to run. 33 | 34 | ## Authors 35 | - [Degen-dev (Degenerate)](https://github.com/Degen-dev) -------------------------------------------------------------------------------- /Configuration.md: -------------------------------------------------------------------------------- 1 | # Basic Configuration 2 | Different proxies have different ways to configure them. This will go over how to configure [Ultraviolet](https://github.com/titaniumnetwork-dev/Ultraviolet). 3 | ## Ultraviolet 4 | Ultraviolet has its configuration in a file called `uv.config.js`. In this case of Degeneracy, this file can be found in `public/uv/uv.config.js`. See the default configuration below: 5 | ```js 6 | self.__uv$config = { 7 | prefix: '/service/', 8 | bare: '/bare/', 9 | encodeUrl: Ultraviolet.codec.xor.encode, 10 | decodeUrl: Ultraviolet.codec.xor.decode, 11 | handler: '/uv/uv.handler.js', 12 | bundle: '/uv/uv.bundle.js', 13 | config: '/uv/uv.config.js', 14 | sw: '/uv/uv.sw.js', 15 | }; 16 | ``` 17 | The meaning for each configurable option can be found below: 18 | | Configuration | Options and Explanation | 19 | | ------------- | ----------------------- | 20 | | Prefix | The prefix is the prefix that you want users to see. Ex: `https://example.com/service.` The default prefix is `service`. | 21 | | Bare | Bare Servers can run on directories. For example, if the directory was /bare/ then the bare origin would look like `http://example.org/bare/`. The bare origin is passed to clients. | 22 | | encodeUrl| EncodeUrl is how you want the URL a proxy site's visitors has to be encoded. Options include `Ultraviolet.codec.base64.encode`, `Ultraviolet.codec.plain.encode`, or `Ultraviolet.codec.xor.encode`. It is recommended that you use `xor` or `base64` as it hides the queries your visitors are searching and visiting. 23 | | decodeUrl | DecodeUrl is how you want the url to be decoded. It is recommended you keep it the same as `encodeUrl`. | 24 | | Handler | Handler is the path to the UV handler. The default name and path to this file is `/uv/uv.handler.js`. | 25 | | Bundle | Bundle is the path to the UV bundle file. The default name and path to this file is `uv/uv.bundle.js`. | 26 | | Config | Config is the path to the UV config file. The default name and path to this file is `uv/uv.bundle.js`. | 27 | | SW | SW is the path to the UV Service Worker file. The default name and path to this file is `uv/uv.sw.js`. | 28 | 29 | ## Authors 30 | - [Degen-dev (Degenerate)](https://github.com/Degen-dev) 31 | -------------------------------------------------------------------------------- /Nginx.md: -------------------------------------------------------------------------------- 1 | # Nginx 2 | Nginx is a common tool used for load balancing as well as reverse-proxying. We will be using Nginx to pass your instance to your domains as well as to add SSL to your site. 3 | 4 | Assuming you are running a Linux system based off of Debian, run the following command to install nginx: 5 | ```sh 6 | $ sudo apt install nginx 7 | ``` 8 | 9 | After you have Nginx installed, configure it in `/etc/nginx/nginx.conf`. The configuration I would recommend can be found below: 10 | ```nginx 11 | user root; # change this to be the user you are hosting your instance on 12 | worker_processes auto; 13 | pid /run/nginx.pid; 14 | include /etc/nginx/modules-enabled/*.conf; 15 | 16 | events { 17 | worker_connections 1024; 18 | } 19 | 20 | http { 21 | include /etc/nginx/mime.types; 22 | default_type application/octet-stream; 23 | map_hash_bucket_size 128; 24 | 25 | sendfile on; 26 | tcp_nopush on; 27 | 28 | tcp_nodelay on; 29 | 30 | reset_timedout_connection on; 31 | 32 | access_log off; 33 | error_log off; 34 | 35 | server { 36 | listen 80 default_server; 37 | listen [::]:80 default_server; 38 | server_name your.domain.com; # replace with your actual domain 39 | 40 | location / { 41 | # Upgrade WebSockets 42 | proxy_set_header Upgrade $http_upgrade; 43 | proxy_set_header Connection 'Upgrade'; 44 | # Increase header buffer 45 | proxy_connect_timeout 10; 46 | proxy_send_timeout 90; 47 | proxy_read_timeout 90; 48 | proxy_buffer_size 128k; 49 | proxy_buffers 4 256k; 50 | proxy_busy_buffers_size 256k; 51 | proxy_temp_file_write_size 256k; 52 | proxy_pass http://127.0.0.1:8080; # change this to the port UltraViolet is listening on 53 | 54 | # The small block below will block googlebot 55 | if ($http_user_agent ~ (Googlebot)) { 56 | return 403; 57 | } 58 | } 59 | } 60 | } 61 | ``` 62 | 63 | ## Authors 64 | - [Degen-dev (Degenerate)](https://github.com/Degen-dev) 65 | - [EnderKingJ](https://github.com/EnderKingJ) 66 | -------------------------------------------------------------------------------- /Hosting.md: -------------------------------------------------------------------------------- 1 | # Hosting 2 | This will provide a list of free and paid hosting providers. 3 | 4 | ## Free Options 5 | | Hosting Provider | Pros and Cons of each provider | 6 | | ---------------- | ------------------------------ | 7 | | [Oracle Cloud Free Tier](https://www.oracle.com/cloud/free) | Oracle Cloud is remarkable in that it is free. You can pretty much get a full VPS (virtual private server) experience for no cost to you. | 8 | | [Repl.it](https://repl.it) | Replit is a well known hosting option. It provides free hosting as well as a web code editor. However, hosting proxies violates Replit's terms of service and can result in your account getting suspended or permanently banned. | 9 | | [Heroku](https://heroku.com) | Heroku, much like Replit, is a well known free hosting option. Hosting proxies on Heroku can also result in your account being suspended or permenantly banned. | 10 | | [Glitch](https://glitch.com) | Glitch is very similar to Replit in that it is well known and provides a web code editor. As far as I am aware, hosting proxies on Glitch is not a violation of their terms of service, however, assuming hosting proxies is a violation of Glitch's terms of service, it is still largely unenforced. | 11 | 12 | ## Paid Options 13 | | Hosting Provider | Pros and Cons of each provider | 14 | | ---------------- | ------------------------------ | 15 | | [Contabo](https://contabo.com) | Contabo is a widely used hosting service that has very good specs for the cheapest prices. There are many issues with Contabo though, such as bad customer service and port speeds. | 16 | | [Dedipath](https://dedipath.com) | Dedipath is a great hosting provider in all categories. With fairly cheap servers with good specs, they are a go-to solution for many. | 17 | | [OVH Cloud](https://ovhcloud.com) | OVH Cloud is a well-known hosting provider, with cheap and good servers and speeds. Some issues are that customer support is more on the poor side, and servers may take some time to be set up. | 18 | | [Scaleway](https://scaleway.com) | Scaleway is a decently well-known hosting provider. They have services like Dedicated Servers, Web Hosting, Domain Registration, and more! The prices for their services are very reasonable. | 19 | 20 | ## Authors 21 | - [Degen-dev (Degenerate)](https://github.com/Degen-dev) 22 | - [EnderKingJ](https://github.com/EnderKingj) 23 | - [ActuallyVys](https://github.com/ActuallyVys) 24 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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. 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 | . 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. --------------------------------------------------------------------------------