chore: publish 2.0.4+1.0.24 release

.drone.yml

@@ -0,0 +1,41 @@
+---
+kind: pipeline
+name: deploy to swarm-test.autonomic.zone
+steps:
+  - name: deployment
+    image: git.coopcloud.tech/coop-cloud/stack-ssh-deploy:latest
+    settings:
+      host: swarm-test.autonomic.zone
+      stack: federatedwiki
+      generate_secrets: true
+      purge: true
+      deploy_key:
+        from_secret: drone_ssh_swarm_test
+      networks:
+        - proxy
+    environment:
+      DOMAIN: federatedwiki.swarm-test.autonomic.zone
+      STACK_NAME: federatedwiki
+      LETS_ENCRYPT_ENV: production
+      INSTALL_SH_VERSION: v1
+      CONFIG_JSON_VERSION: v1
+      CONFIG_OWNER_JSON_VERSION: v1
+trigger:
+  branch:
+    - main
+---
+kind: pipeline
+name: generate recipe catalogue
+steps:
+  - name: release a new version
+    image: plugins/downstream
+    settings:
+      server: https://build.coopcloud.tech
+      token:
+        from_secret: drone_abra-bot_token
+      fork: true
+      repositories:
+        - coop-cloud/auto-recipes-catalogue-json
+
+trigger:
+  event: tag

.env.sample

@@ -0,0 +1,21 @@
+TYPE=federatedwiki
+
+DOMAIN=federatedwiki.example.com
+## Domain aliases
+#EXTRA_DOMAINS=', `www.federatedwiki.example.com`'
+LETS_ENCRYPT_ENV=production
+
+COMPOSE_FILE="compose.yml"
+
+# Change to an absolute path to use a bind-mount, e.g. /opt/fedwiki
+FEDWIKI_VOLUME="fedwiki"
+
+# custom wiki.cafe image, for working oauth2 support
+#COMPOSE_FILE="$COMPOSE_FILE:compose.wikicafe.yml"
+
+# persistent lib volume / node_modules directory, e.g. for plugmatic
+#COMPOSE_FILE="$COMPOSE_FILE:compose.lib.yml"
+
+# Note(3wc): If you change this after initial deployment, you will need to
+# manually copy the new value from `conf/config.initial.json`
+SECRET_COOKIE_SECRET_VERSION=v1  # length=30

.gitignore

@@ -1 +1 @@
-.env*
+/.envrc

README.md

@@ -1,24 +1,26 @@
-# Fedwiki
+# Federated Wiki
 
-Wiki Cafe's configuration for a Nextcloud deployment. Originally slimmed down from an `abra` [recipe](https://git.coopcloud.tech/coop-cloud/federatedwiki) by [Co-op Cloud](https://coopcloud.tech/).
+Share pages circulating within a creative commons
 
+<!-- metadata -->
+* **Category**: Apps
+* **Status**: 0, work-in-progress
+* **Image**: [`dobbs/farm`](https://hub.docker.com/r/dobbs/farm/), 4, upstream 
+* **Healthcheck**: No
+* **Backups**: No
+* **Email**: No
+* **Tests**: No
+* **SSO**: No
+<!-- endmetadata -->
 
-## Deploying the app with Docker Swarm
+## Basic usage
 
-Set the environment variables from the .env file during the shell session.
+1. Set up Docker Swarm and [`abra`]
+2. Deploy [`coop-cloud/traefik`]
+3. `abra app new federatedwiki`
+4. `abra app config YOURAPPDOMAIN` - be sure to change `DOMAIN` to something that resolves to
+   your Docker swarm box
+5. `abra app deploy YOURAPPDOMAIN`
 
-```
+[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
-set -a && source .env && set +a
+[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik
-```
-
-Set the secrets.
-
-```
-printf "SECRET_HERE" | docker secret create SECRET_NAME -
-```
-
-Deploy using the `-c` flag to specify one or multiple compose files.
-
-```
-docker stack deploy fedwiki --detach=true -c compose.yaml -c compose.lib.yaml -c compose.wikicafe.yaml
-```

abra.sh

@@ -0,0 +1,2 @@
+export ENTRYPOINT_SH_VERSION=v1
+export CONFIG_INITIAL_JSON_VERSION=v1

compose.lib.yaml

@@ -1,7 +0,0 @@
-services:
-  app:
-    volumes:
-      - "lib:/home/node/lib"
-
-volumes:
-  lib:

compose.lib.yml

@@ -0,0 +1,10 @@
+---
+version: "3.8"
+
+services:
+  app:
+    volumes:
+      - "fedwiki_lib:/home/node/lib"
+
+volumes:
+  fedwiki_lib:

compose.wikicafe.yml

@@ -0,0 +1,6 @@
+---
+version: "3.8"
+
+services:
+  app:
+    image: git.coopcloud.tech/wiki-cafe/wiki-farm:latest

compose.yml

@@ -1,9 +1,12 @@
+---
+version: "3.8"
+
 services:
   app:
-    image: dobbs/farm:1.1.0
+    image: dobbs/farm:1.0.24
     command: /bin/sh entrypoint.sh
     volumes:
-      - "data:/home/node/.wiki"
+      - "${FEDWIKI_VOLUME}:/home/node/.wiki"
     networks:
       - proxy
     configs:
@@ -15,7 +18,6 @@ services:
       - cookie_secret
     environment:
       - DOMAIN
-      - DOMAINS
       - COOKIE_SECRET
       - AUTHOR
       - ADMIN_KEY
@@ -33,27 +35,23 @@ services:
         - "traefik.http.routers.${STACK_NAME}.tls.domains[0].main=${DOMAIN}"
         - "traefik.http.routers.${STACK_NAME}.tls.domains[0].sans=*.${DOMAIN}"
         - "traefik.http.routers.${STACK_NAME}.priority=1"
-        - "traefik.http.routers.${STACK_NAME}_auth.rule=(Host(`${DOMAIN}`) && (PathPrefix(`/auth`) || Path(`/security/dialog.css`)))"
+        - "caddy=https://${DOMAIN}, https://*.${DOMAIN}, https://*.*.${DOMAIN}, https://*.*.*.${DOMAIN}"
-        - "traefik.http.routers.${STACK_NAME}_auth.entrypoints=web-secure"
+        - "caddy.reverse_proxy={{upstreams 3000}}"
-        - "traefik.http.routers.${STACK_NAME}_auth.tls.certresolver=${LETS_ENCRYPT_ENV}"
+        - "caddy.tls.on_demand="
-        - "caddy_0=https://${DOMAIN}"
-        - "caddy_0.tls.on_demand="
-        - "caddy_0.@match.path=/auth/* /security/dialog.css"
-        - "caddy_0.reverse_proxy= @match {{upstreams 3000}}"
-        - ${DOMAINS}
-        - "caddy_1.reverse_proxy={{upstreams 3000}}"
-        - "caddy_1.tls.on_demand="
         - "backupbot.backup=true"
         - "backupbot.backup.path=/home/node/.wiki"
+        - "coop-cloud.${STACK_NAME}.version=2.0.4+1.0.24"
     healthcheck:
-      test: "node -e 'var http = require(\"http\"); var options = { host : \"localhost\", port : \"3000\", timeout : 2000, path : \"/view/welcome-visitors\", headers: { \"Host\": \"${DOMAIN}\" }  }; var request = http.request(options, (res) => { console.log(`STATUS: $${res.statusCode}`); if (res.statusCode == 200) {  process.exit(0); } else { process.exit(1); } }); request.on(\"error\", function(err) { console.log('ERROR'); process.exit(1); }); request.end();'"
+      test: "node -e 'var http = require(\"http\"); var options = { host : \"localhost\", port : \"3000\", timeout : 2000, path : \"/view/welcome-visitors\", headers: { \"Host\": \"${DOMAIN}\" }  }; var request = http.request(options, (res)
+ => { console.log(`STATUS: $${res.statusCode}`); if (res.statusCode == 200) {  process.exit(0); } else { process.exit(1); } }); request.on(\"error\", function(err) { console.log('ERROR'); 
+process.exit(1); }); request.end();'"
       interval: 10s
       timeout: 2s
       retries: 2
       start_period: 30s
 
 volumes:
-  data:
+  fedwiki:
 
 networks:
   proxy:
@@ -62,13 +60,13 @@ networks:
 secrets:
   cookie_secret:
     external: true
-    name: ${STACK_NAME}_cookie_secret
+    name: ${STACK_NAME}_cookie_secret_${SECRET_COOKIE_SECRET_VERSION}
 
 configs:
   entrypoint_sh_conf:
-    name: ${STACK_NAME}_entrypoint_sh
+    name: ${STACK_NAME}_entrypoint_sh_${ENTRYPOINT_SH_VERSION}
     file: entrypoint.sh
   config_json_initial_conf:
-    name: ${STACK_NAME}_config_initial_json
+    name: ${STACK_NAME}_config_initial_json_${CONFIG_INITIAL_JSON_VERSION}
     file: config.initial.json.tmpl
     template_driver: golang

release/1.0.0+1.0.18

@@ -0,0 +1,7 @@
+WARNING! 🚨
+
+There is a new mandatory config option, FEDWIKI_VOLUME -- please copy the
+default value from the recipe .env.sample to your .env file on upgrade.
+
+If you haven't done that yet, best to bail with Ctrl+C, then add the option,
+then re-run this `abra app upgrade ...` command

release/2.0.0+1.0.20

@@ -0,0 +1,11 @@
+COOKIE_SECRET is now a Docker secret, and several config options have been
+dropped from the recipe -- this shouldn't affect running deplyoments, as
+the recipe currently just installs the generated `config.json` if there isn't
+one already -- but you will likely still need to run 
+`abra app secret generate ...` before deploying, in preparation for moving to
+ennvironment variables for config in a future release.
+
+Additionally, there is now a healthcheck, which may require tuning, especially
+on slower systems; please open a ticket on [the issue
+tracker](https://git.coopcloud.tech/coop-cloud/federatedwiki/issues) if you
+notice problems with the containers starting up.