Skip to content

Commit

Permalink
docs: WBS specific usage of WDQS frontend (#790)
Browse files Browse the repository at this point in the history
Co-authored-by: rti <rti@users.noreply.github.com>
Co-authored-by: Dan Shick <dan.shick@wikimedia.de>
  • Loading branch information
3 people authored Oct 22, 2024
1 parent 3524ddc commit 99dd1ee
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
16 changes: 12 additions & 4 deletions build/wdqs-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

Frontend for the [Wikidata Query Service (WDQS)](https://www.mediawiki.org/wiki/Wikidata_Query_Service).

To interact with the WDQS frontend, navigate to the URL corresponding to the port allocated for it. In the example below, the WDQS frontend is available at `http://localhost:8834`.

When writing queries using the frontend interface, click "Code" to view the corresponding URL.

For general instructions on using WDQS, building SPARQL queries, and additional resources, see:
- [Wikidata Query Service User Manual](https://www.mediawiki.org/wiki/Wikidata_Query_Service/User_Manual)
- [What is SPARQL](https://www.wikidata.org/wiki/Wikidata:SPARQL_query_service)

> 💡 This image is part of Wikibase Suite (WBS). [WBS Deploy](https://github.com/wmde/wikibase-release-pipeline/deploy/README.md) provides everything you need to self-host a Wikibase instance out of the box.
## Requirements
Expand All @@ -21,11 +29,11 @@ We suggest using the [WBS Wikibase image](https://hub.docker.com/r/wikibase/wiki

### WDQS as server

We suggest using the [WBS Wikibase image](https://hub.docker.com/r/wikibase/wdqs).
We suggest using the [WBS WDQS image](https://hub.docker.com/r/wikibase/wdqs).

### WDQS as updater

We suggest using the [WBS Wikibase image](https://hub.docker.com/r/wikibase/wdqs), the same as used for WDQS server. Check out the [documentation](https://wikitech.wikimedia.org/wiki/Wikidata_Query_Service) to learn how to run it in updater mode.
We suggest using the [WBS WDQS image](https://hub.docker.com/r/wikibase/wdqs), the same as used for WDQS server. Check out the [documentation](https://wikitech.wikimedia.org/wiki/Wikidata_Query_Service) to learn how to run it in updater mode.

### Reverse proxy

Expand Down Expand Up @@ -185,7 +193,7 @@ volumes:
Official releases of this image can be found on [Docker Hub wikibase/wdqs-frontend](https://hub.docker.com/r/wikibase/wdqs-frontend).
## Tags and Versioning
## Tags and versioning
This WDQS Frontend image is using [semantic versioning](https://semver.org/spec/v2.0.0.html).
Expand All @@ -206,4 +214,4 @@ This image is built from this [Dockerfile](https://github.com/wmde/wikibase-rele
This image is maintained by the Wikibase Suite Team at [Wikimedia Germany (WMDE)](https://wikimedia.de).
If you have questions not listed above or need help, use this [bug report form](https://phabricator.wikimedia.org/maniphest/task/edit/form/129/) to start a conversation with the engineering team.
If you have questions not covered above or need further help, use this [bug report form](https://phabricator.wikimedia.org/maniphest/task/edit/form/129/) to start a conversation with the engineering team.
3 changes: 3 additions & 0 deletions build/wdqs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ We suggest using the [WBS Wikibase image](https://hub.docker.com/r/wikibase/wiki

You'll need one instance of the image to execute the actual WDQS daemon started using `/runBlazegraph.sh`.

You can send `GET` requests with your SPARQL query to the WDQS endpoint (following the example below):
`http://wdqs:9999/bigdata/namespace/wdq/sparql?query={SPARQL}`

### WDQS as updater

You'll need one instance of the image to execute the updater started using `/runUpdate.sh`. This polls changes from Wikibase.
Expand Down
9 changes: 9 additions & 0 deletions deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,15 @@ Removing the `traefik-letsencrypt-data` volume will request a new certificate fr
```yml
--certificatesresolvers.letsencrypt.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory
```

## WDQS Frontend

To interact with the WDQS frontend, navigate to the URL defined as `WDQS_FRONTEND_PUBLIC_HOST` in the `.env` file. By default, this is set to `wdqs-frontend.example`.

Alternatively, send `GET` requests with your SPARQL query to the WDQS frontend endpoint:
`https://wdqs-frontend.example.com/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}`


## FAQ

### Can I host WBS Deploy locally?
Expand Down

0 comments on commit 99dd1ee

Please sign in to comment.