Compare commits

..

4 Commits
main ... main

Author SHA1 Message Date
Christian Galo a7ff392dd1 rename volumes 2023-11-03 21:41:51 +00:00
Christian Galo d059b04de0 replace var where fixed name is. Update README. 2023-10-17 04:17:26 +00:00
Christian Galo 10d66575cf update to cc commit a7bda15182 2023-10-16 23:16:59 +00:00
Christian Galo 826a25edb3 un-abra 2023-09-09 05:21:00 +00:00
13 changed files with 37 additions and 142 deletions

View File

@ -1,41 +0,0 @@
---
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

View File

@ -1,24 +0,0 @@
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
# Disable SSL encryption (not recommended)
#COMPOSE_FILE="$COMPOSE_FILE:compose.insecure.yml"

2
.gitignore vendored
View File

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

View File

@ -1,26 +1,24 @@
# Federated Wiki
# Fedwiki
Share pages circulating within a creative commons
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/).
<!-- 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 -->
## Basic usage
## Deploying the app with Docker Swarm
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`
Set the environment variables from the .env file during the shell session.
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik
```
set -a && source .env && set +a
```
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 -c compose.yaml -c compose.lib.yaml -c compose.wikicafe.yaml
```

View File

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

View File

@ -1,11 +0,0 @@
---
version: "3.8"
services:
app:
deploy:
labels:
- "traefik.http.services.${STACK_NAME}-non-tls.loadbalancer.server.port=3000"
- "traefik.http.routers.${STACK_NAME}-non-tls.rule=Host(`${DOMAIN}`) || HostRegexp(`{subdomain:\\w+}.${DOMAIN}`) || HostRegexp(`{subsubdomain:\\w+}.{subdomain:\\w+}.${DOMAIN}`)"
- "traefik.http.routers.${STACK_NAME}-non-tls.entrypoints=web"
- "caddy=https://${DOMAIN}, https://*.${DOMAIN}, https://*.*.${DOMAIN}, https://*.*.*.${DOMAIN}, http://${DOMAIN}, http://*.${DOMAIN}, http://*.*.${DOMAIN}, http://*.*.*.${DOMAIN}"

7
compose.lib.yaml Normal file
View File

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

View File

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

View File

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

View File

@ -1,12 +1,9 @@
---
version: "3.8"
services:
app:
image: dobbs/farm:1.0.24
image: dobbs/farm:1.0.20
command: /bin/sh entrypoint.sh
volumes:
- "${FEDWIKI_VOLUME}:/home/node/.wiki"
- "data:/home/node/.wiki"
networks:
- proxy
configs:
@ -35,12 +32,14 @@ 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`)))"
- "traefik.http.routers.${STACK_NAME}_auth.entrypoints=web-secure"
- "traefik.http.routers.${STACK_NAME}_auth.tls.certresolver=${LETS_ENCRYPT_ENV}"
- "caddy=https://${DOMAIN}, https://*.${DOMAIN}, https://*.*.${DOMAIN}, https://*.*.*.${DOMAIN}"
- "caddy.reverse_proxy={{upstreams 3000}}"
- "caddy.tls.on_demand="
- "backupbot.backup=true"
- "backupbot.backup.path=/home/node/.wiki"
- "coop-cloud.${STACK_NAME}.version=2.1.0+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');
@ -51,7 +50,7 @@ process.exit(1); }); request.end();'"
start_period: 30s
volumes:
fedwiki:
data:
networks:
proxy:
@ -60,13 +59,13 @@ networks:
secrets:
cookie_secret:
external: true
name: ${STACK_NAME}_cookie_secret_${SECRET_COOKIE_SECRET_VERSION}
name: ${STACK_NAME}_cookie_secret
configs:
entrypoint_sh_conf:
name: ${STACK_NAME}_entrypoint_sh_${ENTRYPOINT_SH_VERSION}
name: ${STACK_NAME}_entrypoint_sh
file: entrypoint.sh
config_json_initial_conf:
name: ${STACK_NAME}_config_initial_json_${CONFIG_INITIAL_JSON_VERSION}
name: ${STACK_NAME}_config_initial_json
file: config.initial.json.tmpl
template_driver: golang

View File

@ -3,4 +3,4 @@
"cookieSecret": "{{ secret "cookie_secret" }}",
"secure_cookie": true,
"security_type": "friends"
}
}

View File

@ -1,7 +0,0 @@
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

View File

@ -1,11 +0,0 @@
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.