Skip to content

Docs/local setup instructions #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RonaldRonnie wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Docs/local setup instructions #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ed52a8
Document local BugSigDB setup and troubleshooting
RonaldRonnie Dec 10, 2025
b8b6d27
Add comprehensive local setup documentation and configure compose.yml…
RonaldRonnie Dec 12, 2025
a2d27ba
Address PR feedback: Use compose.local.yml override instead of editin…
RonaldRonnie Dec 20, 2025
e4cf41b
Updates to the local setup
RonaldRonnie Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ BASIC_USERNAME=admin
BASIC_PASSWORD='$apr1$Okb14nu5$bkgxEqp/ym0UFBFKCQTEH/'

# Optional
MW_ADMIN_PASSWORD
MW_ADMIN_PASS=
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Containerized MediaWiki for bugsigdb.org

## Running BugSigDB Locally

**For detailed instructions on setting up and running BugSigDB locally, including troubleshooting and maintenance, see [docs/LOCAL_SETUP.md](docs/LOCAL_SETUP.md).**

The local setup guide covers:
- Getting started and prerequisites
- Database setup (with and without backups)
- Networking options (with and without Traefik)
- Common troubleshooting issues
- Updating images and maintenance tasks

## Briefly

This repo contains [Docker Compose](https://docs.docker.com/compose/) containers to run the [MediaWiki](https://www.mediawiki.org/) software.
Expand Down
26 changes: 26 additions & 0 deletions compose.local.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Local development override file
# Recommended usage:
# export COMPOSE_FILE=compose.yml:compose.local.yml
# docker compose up -d
# This file overrides settings for local development without Traefik.
#
# This file ensures:
# - Varnish is exposed on localhost:8081
# - MW_SITE_SERVER is set to http://localhost:8081 (if not set in .env)
# - Traefik-specific networks are removed for local development

services:
varnish:

@DanielButAtWork DanielButAtWork Feb 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the current compose.local.yml works for you, that is great, but I'm surprised that you didn't need to remove the other references to the traefik-public service, e.g.

varnish:
    networks: !reset []

matomo:
    networks: !reset []

# Expose varnish on localhost:8081 for local access
ports:
- "127.0.0.1:8081:80"

web:
# Override MW_SITE_SERVER for local development
# This can also be set via .env file (which takes precedence)
environment:
- MW_SITE_SERVER=${MW_SITE_SERVER:-http://localhost:8081}

# Reset networks from the base compose file so that
# local development does not depend on the traefik-public network.
networks: !reset []
7 changes: 5 additions & 2 deletions compose.yml
View file
Open in desktop
Comment thread
DanielButAtWork marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,15 @@ services:
- elasticsearch
command: bash /entrypoint.sh
environment:
- MW_SITE_SERVER=https://bugsigdb.org
- MW_SITE_SERVER=${MW_SITE_SERVER:-https://bugsigdb.org}
- MW_DB_NAME=mediawiki
- MW_DB_PASS=${MYSQL_ROOT_PASSWORD?Variable MYSQL_ROOT_PASSWORD not set}
- MW_DB_INSTALLDB_PASS=${MYSQL_ROOT_PASSWORD?Variable MYSQL_ROOT_PASSWORD not set}
- MW_NCBI_TAXONOMY_API_KEY=${MW_NCBI_TAXONOMY_API_KEY:-}
- MW_RECAPTCHA_SITE_KEY=${MW_RECAPTCHA_SITE_KEY:-}
- MW_RECAPTCHA_SECRET_KEY=${MW_RECAPTCHA_SECRET_KEY:-}
- MW_ADMIN_USER=admin
- MW_ADMIN_PASSWORD
- MW_ADMIN_PASS=${MW_ADMIN_PASS:-anyotherpassword}
Comment thread
DanielButAtWork marked this conversation as resolved.
- MW_SITE_NAME=BugSigDB
- MW_SITE_LANG=en
- MW_ENABLE_UPLOADS=1
Expand Down Expand Up @@ -179,6 +180,8 @@ services:
- traefik-public
depends_on:
- web
ports:

@DanielButAtWork DanielButAtWork Jan 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

like with the network changes, this should be done via a compose.local.yml override

@DanielButAtWork DanielButAtWork Feb 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this port change was added to the compose.local.yml override, but wasn't removed from here

- "${PORT:-127.0.0.1:8081}:80"
tmpfs:
- /var/lib/varnish:exec
environment:
Expand Down
Loading