Forked from https://github.com/immers-space/guppe

Find a file

Will Murphy b3c89db3f8 Merge branch 'main' of github.com:wmurphyrd/guppe		2022-11-09 22:10:36 -06:00
public/files	replace nunjucks profile rendering with vue, start listing of recent posts on profiel page, support full IRI object ids in object GET route so that remote origin objects can be fetched from local cache for display in Vue pages	2019-10-12 13:30:33 -05:00
test	add postman request library	2019-09-30 20:55:54 -05:00
web	add guppe server status to web views and explain active groups	2022-11-07 21:21:28 -06:00
.dockerignore	add docker deployment	2021-11-01 18:05:14 -05:00
.env.defaults	add docker deployment	2021-11-01 18:05:14 -05:00
.gitignore	add docker deployment	2021-11-01 18:05:14 -05:00
CHANGELOG.md	changelog	2022-05-15 14:27:12 -05:00
config-template.json	generate keys for local users	2019-09-14 21:49:33 -05:00
deliveryWorker.js	adjustable delivery timeout	2022-11-09 12:27:43 -06:00
docker-compose.dev.yml	add dev compose file now that main one is for swarm	2022-11-07 21:36:01 -06:00
docker-compose.yml	only healthcheck the webserver, update default worker replicas	2022-11-07 21:47:40 -06:00
Dockerfile	only healthcheck the webserver, update default worker replicas	2022-11-07 21:47:40 -06:00
index.js	add healthcheck and fix shutdown order	2022-11-07 21:35:16 -06:00
LICENSE	Create LICENSE	2019-09-21 17:03:29 -05:00
package-lock.json	update apex for shared inbox delivery	2022-11-09 22:07:33 -06:00
package.json	update apex for shared inbox delivery	2022-11-09 22:07:33 -06:00
README.md	Fix typo	2022-11-09 21:39:22 +01:00

README.md

Gup.pe

Social groups for the fediverse - making it easy to connect and meet new people based on shared interests without the manipulation of your attention to maximize ad revenue nor the walled garden lock-in of capitalist social media.

This server-2-server ActivityPub implementation adds decentralized, federated "groups" support across all ActivityPub compliant social media networks. Users join groups by following group-type actors on Guppe servers and contribute to groups by mentioning those same actors in a post. Guppe group actors will automatically forward posts they receive to all group members so that everyone in the group sees any post made to the group. Guppe group actors' profiles (e.g. outboxes) also serve as a group discussion history. Creation of new groups is automatic, users simply search for or mention a new group and it will be created.

Tech stack

Mostly powered by activitypub-express from Immers Space. The gup.pe server app, index.js is 200 lines of code, just adding the auto-create actor, auto-accept follow, and auto-boost from inbox behaviors to the base apex setup.

There's also an HTML front-end using Vue (/web) to display popular groups and provide fallback user profile discovery.

Installation

Guppe uses Docker Swarm for easy load balancing Web server replicas

git clone https://github.com/wmurphyrd/guppe.git
cd guppe
cp .env.defaults .env
echo DOMAIN=yourdomain.com >> .env
docker swarm init --advertise-addr 127.0.0.1
docker stack deploy --compose-file docker-compose.yml guppe

Updating

Backup database:

docker-compose exec -T mongodb sh -c 'mongodump --archive' > guppe.dump

Fetch latest code & restart server:

git pull
docker stack deploy --compose-file docker-compose.yml guppe

Optional configuration

Additional values can be set in .env file

Setting	Description
PROXY_MODE	Enable use behind an SSL-terminating proxy or load balancer, serves over http instead of https and sets Express `trust proxy` setting to the value of `PROXY_MODE` (e.g. `1`, other options) See note.

Notes on use with a reverse proxy: When setting proxyMode, you must ensure your reverse proxy sets the following headers: X-Forwarded-For, X-Forwarded-Host, and X-Forwarded-Proto (example for nginx below).

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Proto $scheme;