ArchiveBox/good-karma-kit

Fork 0

mirror of https://github.com/ArchiveBox/good-karma-kit.git synced 2024-09-20 16:25:55 +08:00

Nick Sweeting d1ed2fee5e

Update README.md

2021-04-14 01:36:22 -04:00

3.8 KiB

Raw Blame History

good-karma-kit

A Docker Compose project to run on servers with spare CPU, RAM, and bandwidth to help the world.

Contribute your unused cpu power to good causes.

Download docker-compose.yml into an empty directory
mkdir data
docker-compose up
Finish setting up projects through their respective web dashboards exposed on localhost

You can also comment out any containers you don't want to run in the compose file.

Unless otherwise specified or restricted to 127.0.0.1 in the compose file, all ports should be made available to the public internet. The nature of most of these containers is that you're contributing resources to the public or to specific causes running on the public internet, so make sure you understand the risks involved with exposing your machine to WAN. It may be worth running this in an isolated VM on an isolated subnet if it's on your home or corporate network.

Autoupdater

watchtower

image: containrrr/watchtower

Automatically updates & restarts the containers when they have new versions available

https://containrrr.dev/watchtower/
https://github.com/containrrr/watchtower

Notes: requires access to system docker socket, and will autoupdate all running containers on the host unless scoped with labels.

Distributed networking projects

tor

image: thetorproject/obfs4-bridge:latest

https://www.torproject.org/
https://hub.docker.com/r/thetorproject/obfs4-bridge

i2p

image: divax/i2p:i2p-tor

https://geti2p.net/en/
https://hub.docker.com/r/divax/i2p

Distribued storage projects

ipfs

image: ipfs/go-ipfs:latest

https://ipfs.io
https://hub.docker.com/r/ipfs/go-ipfs

storj

image: storjlabs/storagenode:latest

https://www.storj.io/
https://hub.docker.com/r/storjlabs/storagenode

Notes: 💰 This one earns you money for your storage! Set up your WALLET address for payouts.

sia

image: nebulouslabs/sia

https://sia.tech/
https://hub.docker.com/r/nebulouslabs/sia

Distributed computing projects

boinc

image: ghcr.io/linuxserver/boinc

https://boinc.berkeley.edu/
https://hub.docker.com/r/linuxserver/boinc

Notes: if you have a GPU, it will help computations greatly, please uncomment the /dev/dri line.

foldingathome

image: ghcr.io/linuxserver/foldingathome

https://foldingathome.org/
https://hub.docker.com/r/linuxserver/foldingathome

Internet Archiving projects

archivewarrior

image: archiveteam/warrior-dockerfile

http://warrior.archiveteam.org/
https://hub.docker.com/r/archiveteam/warrior-dockerfile/

zimfarm

image: openzim/zimfarm-worker-manager

https://github.com/openzim/zimfarm
https://hub.docker.com/r/openzim/zimfarm-worker-manager

Notes: this one requires a static IP! You must contact Kiwix to get your worker set up, and get your static IP whitelisted.

kiwix

image: kiwix/kiwix-serve:latest

https://www.kiwix.org/en/
https://hub.docker.com/r/kiwix/kiwix-serve

Notes: this one requires you download some ZIM archives to serve into ./data/kiwix, get those from here: https://wiki.kiwix.org/wiki/Content_in_all_languages

archivebox

image: archivebox/archivebox:latest

https://archivebox.io
https://hub.docker.com/r/archivebox/archivebox/

Notes: this one is empty by default, add some sites to archive or crawl regulary using the web UI or CLI.

pywb

image: webrecorder/pywb:latest

https://github.com/webrecorder/pywb
https://hub.docker.com/r/webrecorder/pywb