From df8da7ba2cae7ce71d8561d06f289d8dcc09a4b1 Mon Sep 17 00:00:00 2001 From: Eric Dobbs Date: Sat, 15 Jul 2017 22:36:22 -0600 Subject: [PATCH] Federated Wiki farm Encapsulate a few specific parts of wiki configuration as a starting point for exploring wiki. --- Dockerfile | 17 ++++ LICENSE | 201 ++++++++++++++++++++++++++++++++++++++ README.md | 51 ++++++++++ configure-and-launch-wiki | 77 +++++++++++++++ 4 files changed, 346 insertions(+) create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100755 configure-and-launch-wiki diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..6503881 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +FROM node:4-slim + +RUN useradd --create-home app \ + && apt-get update \ + && apt-get install -y --no-install-recommends \ + jq +WORKDIR /home/app +RUN su app -c "npm install -g --prefix . wiki@0.11.4" +RUN su app -c "mkdir .wiki" +COPY configure-and-launch-wiki configure-and-launch-wiki +VOLUME "/home/app/.wiki" +ENV DOMAIN=localhost +ENV OWNER_NAME="The Owner" +ENV COOKIE=insecure +EXPOSE 3000 +USER app +CMD ["./configure-and-launch-wiki"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1177cb --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Federated Wiki Farm + +http://fed.wiki.org + +### Get acquainted with wiki. + +Launch the container: +``` bash +docker run -p 3000:3000 -it --rm \ + dobbs/farm +``` + +Visit http://localhost:3000 + +### Make your wiki survive a reboot + +Create a volume: + +``` bash +docker volume create dot-wiki +``` + +Launch the container: +``` bash +docker run -p 3000:3000 -it --rm \ + -v dot-wiki:/home/app/.wiki \ + dobbs/farm +``` + +Visit http://localhost:3000 + +### Make your wiki a local farm + +We're going to use http://localtest.me instead of localhost for our +domain name. See http://readme.localtest.me for more info. + +Let's also use a different volume for this one: +``` bash +docker volume create localtest.me +``` + +Specify the domain name when you launch your wiki +``` bash +docker run -p 3000:3000 -it --rm \ + -v localtest.me:/home/app/.wiki \ + -e DOMAIN=localtest.me \ + dobbs/farm +``` + +Open http://this.localtest.me:3000 in one tab. +Open http://that.localtest.me:3000 in another. diff --git a/configure-and-launch-wiki b/configure-and-launch-wiki new file mode 100755 index 0000000..18d4242 --- /dev/null +++ b/configure-and-launch-wiki @@ -0,0 +1,77 @@ +#!/bin/bash -eu +set -o pipefail + +main() { + initialize-environment-vars + assert-file-privileges || report-errors-and-exit + ensure-owner-file + ensure-config-file + show-configs + exec-wiki +} + +initialize-environment-vars() { + ERRORS='' + readonly OWNER_FILE=/home/app/.wiki/$DOMAIN.owner.json + readonly CONFIG_FILE=/home/app/.wiki/config.json +} + +assert-file-privileges() { + [ -w /home/app/.wiki ] \ + || ERRORS="app cannot write to /home/app/.wiki\n${ERRORS}" + + [ ${#ERRORS} == 0 ] +} + +report-errors-and-exit() { + echo -e $ERRORS + echo "exiting." + exit 1 +} + +ensure-owner-file() { + if [ ! -r "$OWNER_FILE" ]; then + jq -n --arg name "$OWNER_NAME" --arg secret $(random-string) \ + '.name = $name | .friend.secret = $secret' > $OWNER_FILE + fi +} + +ensure-config-file() { + if [ ! -r "$CONFIG_FILE" ]; then + > $CONFIG_FILE \ + jq -n -M \ + --arg admin $(jq -r .friend.secret $OWNER_FILE) \ + --arg random $(random-string) \ + --arg cookie $COOKIE \ + --arg domain $DOMAIN \ + --arg owner $OWNER_FILE \ + ' +.admin = $admin +| .autoseed = true +| .farm = true +| .cookieSecret = $random +| .secure_cookie = ("secure" == $cookie) +| .security_type = "friends" +| .wikiDomains[$domain].id = "/home/app/.wiki/\($domain).owner.json" +' + + fi +} + +random-string() { + node -e 'console.log(require("crypto").randomBytes(64).toString("hex"))' +} + +show-configs() { + set -x + ls -l $OWNER_FILE $CONFIG_FILE + cat $OWNER_FILE + cat $CONFIG_FILE + set +x +} + +exec-wiki() { + exec wiki +} + +main