Skip to content

Update dev-environment.md and docker-compose/README.md #537

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

Merged
dati18 merged 6 commits into from
Feb 16, 2026
+4 −4
Merged

Update dev-environment.md and docker-compose/README.md #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4d934af
Update dev-environment.md
dati18 Feb 16, 2026
b036562
Update dev-environment.md
dati18 Feb 16, 2026
37b3574
Revert "Update dev-environment.md"
dati18 Feb 16, 2026
c235f2b
update docker-compose/fake-api/README.md
dati18 Feb 16, 2026
d1c2dce
Use "blob" URLs
dati18 Feb 16, 2026
31d8a58
Use "blob" URL in docker-compose/fake-api/README.md
dati18 Feb 16, 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 docker-compose/fake-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This is a fake platform API used during local docker-compose based development & also using some CI.

The docker image simply serves PHP, and server.php is a very simple fake of the `getWikiForDomain` API responses.
The docker image simply serves PHP, and [index.php](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api/index.php) is a very simple fake of the `getWikiForDomain` API responses.
6 changes: 3 additions & 3 deletions docs/dev-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Development Environment

There is a [docker-compose file](../docker-compose.yml) in the root directory that allows for serving multiple development sites locally.
There is a [docker-compose file](https://github.com/wbstack/mediawiki/blob/main/docker-compose.yml) in the root directory that allows for serving multiple development sites locally.

These are currently not using the real API but instead get their settings from the static JSON files included in the data folder.
These are currently not using the real API but instead get their settings from static JSON files in [docker-compose/fake-api](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api).

The fake API is served by the [server.php](test/server.php) script and reads the corresponding [subdomain](data/WikiInfo-site1.json) from each request.
The fake API is served by [index.php](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api/index.php) and reads the JSON matching the requested subdomain (for example [WikiInfo-site1.json](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api/WikiInfo-site1.json)).

> [!NOTE]
> You may find you have to refresh the page a few times before changes are reflected in Elasticsearch. Unlike [wmde/wbaas-deploy](https://github.com/wmde/wbaas-deploy/), this setup doesn't have a dedicated job runner. Jobs queued up, such as ones from CirrusSearch and WikibaseCirrusSearch, are completed as part of web requests (see [wbstack/src/Settings/LocalSettings.php#L147-L151](https://github.com/wbstack/mediawiki/blob/ebac07a4a4096d8fd973ebd43ebe342f34b87803/dist-persist/wbstack/src/Settings/LocalSettings.php#L147-L151)), so refreshing the page ensures that all jobs in the queue are run.
Expand Down