Skip to content

hackclub/wiki

hack club wiki

yo, this is the repo for the hack club wiki. it's running on mediawiki but we gave it a custom neobrutalist vibe.

btw, the mediawiki core and database aren't actually in this repo. we just use docker to spin them up and then inject our custom css, js, and config into the main mediawiki and database. :)

how to run it locally

make sure you have docker installed on your computer. then just open your terminal here and run:

docker compose up -d

it might take a hot minute the first time cause it has to download the official mediawiki and mariadb images. once it's done, go to http://localhost:8080 in your browser and you'll see the wiki running.

editing the skin

all our custom styling is in the skins/HackClub/ folder.

  • resources/skin.css is where the hard shadows and theme colors live
  • resources/skin.js is for any interactive client side stuff
  • templates/skin.mustache is the actual html template for the site layout

if you edit these files, they should update instantly when you refresh your browser cause docker volume-mounts the folder directly into the container.

deploying on coolify

to put this live on the server:

  1. add this repo to coolify and choose docker compose as the build pack
  2. go to the environment variables tab and add these (just make up secure values for them, docker will use them to automatically set up the fresh database):
    • DB_NAME (like hackclub_wiki)
    • DB_USER (like wiki_admin)
    • DB_PASSWORD (make this long)
    • DB_ROOT_PASSWORD (for maintenance/install commands)
    • WG_SERVER (your full wiki url like https://wiki.example.com)
    • ADMIN_USER (optional, defaults to admin)
    • ADMIN_PASSWORD (optional, defaults to wikiadmin123)
    • SECRET_KEY (literally just mash your keyboard)
    • UPGRADE_KEY (mash it again)
  3. deploy it. coolify spins up the images, configures the database with your made up passwords, and injects our custom skin straight in.

About

Hack Club's community wiki

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors