From 974a10e48c4c99266a77159cb52ef04cad00adb7 Mon Sep 17 00:00:00 2001 From: Robert Timm Date: Fri, 7 Feb 2025 09:21:14 +0100 Subject: [PATCH 1/4] chore: update wdqs frontend url in template to match common setups --- deploy-lts/.env | 2 +- deploy-lts/README.md | 4 ++-- deploy-lts/template.env | 2 +- deploy/README.md | 4 ++-- deploy/template.env | 2 +- test/test-services.env | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/deploy-lts/.env b/deploy-lts/.env index 216749c26..25331f74c 100644 --- a/deploy-lts/.env +++ b/deploy-lts/.env @@ -14,7 +14,7 @@ # deployed to. Note that you need three distinct names, e.g. three different # subdomains. Otherwise the reverse proxy cannot route properly. WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=wdqs-frontend.example +WDQS_FRONTEND_PUBLIC_HOST=query.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example # MediaWiki / Wikibase user configuration. diff --git a/deploy-lts/README.md b/deploy-lts/README.md index 7aaab8c26..80ca492a4 100644 --- a/deploy-lts/README.md +++ b/deploy-lts/README.md @@ -304,10 +304,10 @@ Removing the `traefik-letsencrypt-data` volume will request a new certificate fr ## 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`. +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 `query.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}` +`https://query.example/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}` ## FAQ diff --git a/deploy-lts/template.env b/deploy-lts/template.env index 216749c26..25331f74c 100644 --- a/deploy-lts/template.env +++ b/deploy-lts/template.env @@ -14,7 +14,7 @@ # deployed to. Note that you need three distinct names, e.g. three different # subdomains. Otherwise the reverse proxy cannot route properly. WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=wdqs-frontend.example +WDQS_FRONTEND_PUBLIC_HOST=query.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example # MediaWiki / Wikibase user configuration. diff --git a/deploy/README.md b/deploy/README.md index 7aaab8c26..80ca492a4 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -304,10 +304,10 @@ Removing the `traefik-letsencrypt-data` volume will request a new certificate fr ## 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`. +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 `query.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}` +`https://query.example/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}` ## FAQ diff --git a/deploy/template.env b/deploy/template.env index 216749c26..25331f74c 100644 --- a/deploy/template.env +++ b/deploy/template.env @@ -14,7 +14,7 @@ # deployed to. Note that you need three distinct names, e.g. three different # subdomains. Otherwise the reverse proxy cannot route properly. WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=wdqs-frontend.example +WDQS_FRONTEND_PUBLIC_HOST=query.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example # MediaWiki / Wikibase user configuration. diff --git a/test/test-services.env b/test/test-services.env index 30adab2e6..1f58280db 100644 --- a/test/test-services.env +++ b/test/test-services.env @@ -1,7 +1,7 @@ # Any of these can be overridden locally in ../local.env WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=wdqs-frontend.example +WDQS_FRONTEND_PUBLIC_HOST=query.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example MW_ADMIN_NAME=admin @@ -11,7 +11,7 @@ MW_ADMIN_PASS=change-this-password # URLs used by tests to access services from within the # docker network through traefik proxy WIKIBASE_URL=http://wikibase.example -WDQS_FRONTEND_URL=http://wdqs-frontend.example +WDQS_FRONTEND_URL=http://query.example QUICKSTATEMENTS_URL=http://quickstatements.example # URLs used by tests to access services from within the docker network directly From c491ff0ee48d7f59382df941a45f8b0d52f439b1 Mon Sep 17 00:00:00 2001 From: Robert Timm Date: Fri, 7 Feb 2025 08:42:32 +0000 Subject: [PATCH 2/4] fix: traefik aliases in tests --- test/suites/docker-compose.override.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/test/suites/docker-compose.override.yml b/test/suites/docker-compose.override.yml index 510c5d273..f92e77c95 100644 --- a/test/suites/docker-compose.override.yml +++ b/test/suites/docker-compose.override.yml @@ -68,9 +68,9 @@ services: networks: default: aliases: - - wikibase.example - - wdqs-frontend.example - - quickstatements.example + - ${WIKIBASE_PUBLIC_HOST} + - ${WDQS_FRONTEND_PUBLIC_HOST} + - ${QUICKSTATEMENTS_PUBLIC_HOST} volumes: wikibase-config: From aa41a3116eeca4ea2cbd6df1211fa5a6b740758b Mon Sep 17 00:00:00 2001 From: Robert Timm Date: Wed, 12 Feb 2025 10:19:53 +0000 Subject: [PATCH 3/4] chore: query.example -> query.wikibase.example --- build/wdqs-frontend/README.md | 2 +- deploy-lts/.env | 2 +- deploy-lts/README.md | 6 +++--- deploy-lts/template.env | 2 +- deploy/README.md | 6 +++--- deploy/template.env | 2 +- test/test-services.env | 4 ++-- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/build/wdqs-frontend/README.md b/build/wdqs-frontend/README.md index cd933d0da..752048103 100644 --- a/build/wdqs-frontend/README.md +++ b/build/wdqs-frontend/README.md @@ -151,7 +151,7 @@ services: - 8834:80 labels: - "traefik.enable=true" - - "traefik.http.routers.wdqs-frontend.rule=Host(`query.example`)" + - "traefik.http.routers.wdqs-frontend.rule=Host(`query.wikibase.example`)" - "traefik.http.routers.wdqs-frontend.entrypoints=websecure" - "traefik.http.routers.wdqs-frontend.tls.certresolver=letsencrypt" environment: diff --git a/deploy-lts/.env b/deploy-lts/.env index 25331f74c..b0aed87f9 100644 --- a/deploy-lts/.env +++ b/deploy-lts/.env @@ -14,7 +14,7 @@ # deployed to. Note that you need three distinct names, e.g. three different # subdomains. Otherwise the reverse proxy cannot route properly. WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=query.example +WDQS_FRONTEND_PUBLIC_HOST=query.wikibase.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example # MediaWiki / Wikibase user configuration. diff --git a/deploy-lts/README.md b/deploy-lts/README.md index 80ca492a4..e57359269 100644 --- a/deploy-lts/README.md +++ b/deploy-lts/README.md @@ -45,7 +45,7 @@ WBS Deploy consists of the following services: You need three DNS records that resolve to your machine's IP address, one for each user-facing service: - Wikibase, e.g., "wikibase.example" -- QueryService, e.g., "query.example" +- QueryService, e.g., "query.wikibase.example" - QuickStatements, e.g., "quickstatements.example" ### Initial setup @@ -304,10 +304,10 @@ Removing the `traefik-letsencrypt-data` volume will request a new certificate fr ## 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 `query.example`. +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 `query.wikibase.example`. Alternatively, send `GET` requests with your SPARQL query to the WDQS frontend endpoint: -`https://query.example/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}` +`https://query.wikibase.example/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}` ## FAQ diff --git a/deploy-lts/template.env b/deploy-lts/template.env index 25331f74c..b0aed87f9 100644 --- a/deploy-lts/template.env +++ b/deploy-lts/template.env @@ -14,7 +14,7 @@ # deployed to. Note that you need three distinct names, e.g. three different # subdomains. Otherwise the reverse proxy cannot route properly. WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=query.example +WDQS_FRONTEND_PUBLIC_HOST=query.wikibase.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example # MediaWiki / Wikibase user configuration. diff --git a/deploy/README.md b/deploy/README.md index 80ca492a4..e57359269 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -45,7 +45,7 @@ WBS Deploy consists of the following services: You need three DNS records that resolve to your machine's IP address, one for each user-facing service: - Wikibase, e.g., "wikibase.example" -- QueryService, e.g., "query.example" +- QueryService, e.g., "query.wikibase.example" - QuickStatements, e.g., "quickstatements.example" ### Initial setup @@ -304,10 +304,10 @@ Removing the `traefik-letsencrypt-data` volume will request a new certificate fr ## 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 `query.example`. +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 `query.wikibase.example`. Alternatively, send `GET` requests with your SPARQL query to the WDQS frontend endpoint: -`https://query.example/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}` +`https://query.wikibase.example/proxy/wdqs/bigdata/namespace/wdq/sparql?query={SPARQL}` ## FAQ diff --git a/deploy/template.env b/deploy/template.env index 25331f74c..b0aed87f9 100644 --- a/deploy/template.env +++ b/deploy/template.env @@ -14,7 +14,7 @@ # deployed to. Note that you need three distinct names, e.g. three different # subdomains. Otherwise the reverse proxy cannot route properly. WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=query.example +WDQS_FRONTEND_PUBLIC_HOST=query.wikibase.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example # MediaWiki / Wikibase user configuration. diff --git a/test/test-services.env b/test/test-services.env index 1f58280db..3de5e3b61 100644 --- a/test/test-services.env +++ b/test/test-services.env @@ -1,7 +1,7 @@ # Any of these can be overridden locally in ../local.env WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=query.example +WDQS_FRONTEND_PUBLIC_HOST=query.wikibase.example QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example MW_ADMIN_NAME=admin @@ -11,7 +11,7 @@ MW_ADMIN_PASS=change-this-password # URLs used by tests to access services from within the # docker network through traefik proxy WIKIBASE_URL=http://wikibase.example -WDQS_FRONTEND_URL=http://query.example +WDQS_FRONTEND_URL=http://query.wikibase.example QUICKSTATEMENTS_URL=http://quickstatements.example # URLs used by tests to access services from within the docker network directly From 765c3157bc7d72479f715f74e5b49d7b541f39e8 Mon Sep 17 00:00:00 2001 From: Robert Timm Date: Wed, 12 Feb 2025 10:20:51 +0000 Subject: [PATCH 4/4] chore: remove .env --- deploy-lts/.env | 37 ------------------------------------- 1 file changed, 37 deletions(-) delete mode 100644 deploy-lts/.env diff --git a/deploy-lts/.env b/deploy-lts/.env deleted file mode 100644 index b0aed87f9..000000000 --- a/deploy-lts/.env +++ /dev/null @@ -1,37 +0,0 @@ -# ############################################################################## -# Wikibase Suite Deploy - initial configuration -# -# This file is a template for the .env file used by the Wikibase Suite Deploy -# docker-compose setup. -# -# WARNING: Do not add comments on the same line as env vars: in some -# environments they will be included in the var! -# ############################################################################## - -# Public hostname configuration. -# These domain names for your Wikibase Suite services should be configured on -# your DNS server to point to the public IP address of the server being -# deployed to. Note that you need three distinct names, e.g. three different -# subdomains. Otherwise the reverse proxy cannot route properly. -WIKIBASE_PUBLIC_HOST=wikibase.example -WDQS_FRONTEND_PUBLIC_HOST=query.wikibase.example -QUICKSTATEMENTS_PUBLIC_HOST=quickstatements.example - -# MediaWiki / Wikibase user configuration. -# Password must be at least 10 characters, different from your username and not -# appear in the list of commonly used passwords this project uses. -MW_ADMIN_NAME=admin -MW_ADMIN_EMAIL=admin@wikibase.example -MW_ADMIN_PASS=change-this-password - -# MediaWiki / Wikibase database configuration. -# Those settings are used by the MariaDB container when creating a new -# database and by MediaWiki when generating a new LocalSettings.php. They will not -# be set on an existing database, nor will MediaWiki update those settings in -# your LocalSettings.php. To change those settings, either adjust them manually -# in MariaDB and your LocalSettings.php, or delete your MariaDB volume -# "mysql-data" and your LocalSettings.php from the ./config directory and -# restart. -DB_NAME=my_wiki -DB_USER=sqluser -DB_PASS=change-this-password