feat(deploy): T399695 - Initial Deploy config/setup wizard (Web and CLI)

.eslintrc-whitespace.json

@@ -2,20 +2,23 @@
 	"root": true,
 	"parser": "any-eslint-parser",
 	"ignorePatterns": [
+		"node_modules",
 		"test/**/results",
 		"!.github",
-		"!deploy",
 		"package-lock.json",
 		"pnpm/**/**",
 		"pnpm-lock.yaml",
+		"deploy/config/extensions",
+		"cloud-init.yml",
 		"*.properties",
 		"*.ts",
 		"*.js",
 		"*.json",
 		"*.yml",
 		"*.yaml",
 		"*.json",
-		"*.png"
+		"*.png",
+		"*.ico"
 	],
 	"rules": {
 		"eol-last": [ "error", "always" ]

.eslintrc.json

@@ -6,9 +6,11 @@
 		"@wmde/wikimedia-typescript"
 	],
 	"ignorePatterns": [
+		"node_modules",
 		"**/results/result.json",
 		"!.github/**/**",
-		"!deploy",
+		"deploy/config/extensions",
+		"cloud-init.yml",
 		"package-lock.json",
 		"pnpm/**/**",
 		"pnpm-lock.yaml",

deploy/README.md

@@ -42,11 +42,30 @@ You need two DNS records that resolve to your machine's IP address:
 - Wikibase, e.g., "wikibase.example"
 - QueryService, e.g., "query.wikibase.example"
 
-## Setup
+## Installation
+
+### Option 1: Web-based Setup (Recommended for New Users)
+
+If you're setting up a new instance on a fresh VPS, you can use our web-based installer to simplify the process. This method installs all required dependencies, configures your environment, and launches the full Wikibase Suite via a browser-based setup wizard.
+
+1. **Log in to your VPS as root.**
+2. **Run the following one-liner:**
+
+   ```sh
+   bash -c "$(curl -fsSL https://raw.githubusercontent.com/wmde/wikibase-release-pipeline/refs/heads/deploy-setup-script/deploy/setup/setup.sh)"
+   ```
+
+3. **Follow the on-screen instructions.** The setup script will guide you through the rest of the process and provide a link to open the web-based installer in your browser.
+
+Once setup is complete, the installer shuts down automatically and your Wikibase Suite instance will be up and running.
+
+> 💡 This method takes care of installing Docker, Docker Compose, Git, and configuring everything correctly, making it ideal for first-time deployments.
 
 > 💡 If you want to run a quick test on a machine that has no public IP address (such as your local machine), check our [FAQ entry](#can-i-host-wbs-deploy-locally) below.
 
-### Download WBS Deploy
+### Option 2: Manually Setup
+
+#### Download WBS Deploy
 
 Check out the files from Github, move to the subdirectory `deploy`.
 
@@ -55,7 +74,7 @@ git clone https://github.com/wmde/wikibase-release-pipeline
 cd wikibase-release-pipeline/deploy
 ```
 
-### Initial configuration
+#### Configuration
 
 Make a copy of the [configuration template](./template.env) in the `wikibase-release-pipeline/deploy` directory.
 
@@ -65,7 +84,7 @@ cp template.env .env
 
 Follow the instructions in the comments in your newly created `.env` file to set domain names, usernames and passwords.
 
-### Starting
+#### Starting
 
 Run the following command from within `wikibase-release-pipeline/deploy`:
 
@@ -79,6 +98,8 @@ The first start can take a couple of minutes. You can check the status of the st
 
 > 💡 If anything goes wrong, you can run `docker logs <CONTAINER_NAME>` to see some helpful error messages.
 
+## Operating Deploy
+
 ### Stopping
 
 To stop, use
@@ -89,7 +110,7 @@ docker compose stop
 
 ### Resetting the configuration
 
-Most values set in `.env` are written into the respective containers after you run `docker compose up` for the first time.
+Most values set in `.env` are written into the respective containers after you run `docker compose up` for the first time, but will not reflect changes in the containers afterwards without resetting your configuration.
 
 If you want to reset the configuration while retaining your existing data:
 

deploy/setup/.gitignore

@@ -0,0 +1,3 @@
+certs
+server.js
+letsencrypt

deploy/setup/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:20-alpine
+
+WORKDIR /app
+
+COPY package.json package-lock.json tsconfig.json ./
+COPY public ./public
+COPY views ./views
+COPY server.ts ./server.ts
+
+RUN apk add --no-cache bash
+RUN npm ci && npx tsc
+
+CMD ["node", "server.js"]

deploy/setup/README.md

@@ -0,0 +1,52 @@
+Wikibase Suite Deploy Setup Tool
+
+The Wikibase Suite Deploy Setup Tool is a lightweight, zero-configuration installer for quickly launching a full Wikibase Suite instance on any freshly-created VPS instance. Designed for ease and speed, it combines a one-liner install script with a web-based configuration interface and automatic environment setup. No Docker or manual file editing is required upfront — everything is generated or guided in-browser, resulting in a running Wikibase Suite Deploy instance.
+
+Features
+
+- One-liner install via curl | bash or cloud-init script
+- Browser-based setup interface on port 8888 with live logs
+- Optional custom hostnames which otherwise default to <SERVER-IP>.nip.io names
+- Auto-generated secure passwords
+- Optional opt-in to list your instance with the Wikibase community, with a default of true
+- Clean shutdown of setup utility after installation completes (10 min timeout), including removal of passwords from .env
+
+Steps to Launch a New Wikibase Suite Deploy Instance
+
+1. Provision a VPS with the minimum recommended specification or greater
+2. SSH in to your new VPS instance as root user and copy/paste this command:
+
+    `curl -fsSL https://raw.githubusercontent.com/wmde/wikibase-release-pipeline/refs/heads/deploy-setup-script/deploy/setup/setup.sh | bash`
+
+3. Open the setup URL printed in the terminal once prompted
+4. On the webpage enter your MediaWiki admin email, base host name, and whether to advertise your instance. Advanced options also available, such as manually setting database password, etc.
+5. Click Save, and wait for services to boot
+
+---
+
+## Related Feature Stories
+
+### Implemented
+
+- User can easily setup WBS Deploy on a VPS provider of their choice
+- User can configure the initial WBS Deploy setup through a easy to use web based UI with inline documentation
+- User is clearly notified when WBS Deploy is done being configured and up and running
+- User can trust the access information (passwords) for the WBS services are stored in a secure way (not in plain text in a .env file)
+- User can create a WBS Deploy instance without having to register domain names
+- _User can use deploy/docker-compose.yml without modification in Dokploy or similiar Open Source PAAS provider which overlaps traefik configuration_
+
+### In Progress
+
+- User can configure the initial WBS Deploy setup through a easy to use text based CLI with inline documentation
+- User can setup WBS Deploy to run on localhost without external access and all services work as expected without warnings or errors
+
+### Won't be implemented
+
+- User has a clear indication when a service doesn't boot or is left in an unhealthy status, and is provided instructions for debugging / how to proceed
+- User can press a "Reset" button to stop all services, DESTROY ALL CURRENT DATA, change/re-apply configuration, and re-start services. 
+  - docker compose down --volumes`
+  - rm -rf config
+  - git checkout config
+- User can easily and reliably use all WBS Deploy services in a localhost configuration
+- User can monitor docker compose service status in a WBS provided dashboard
+- User can start/stop/reset docker compose service in a WBS provided dashboard

deploy/setup/cloud-init.yml

@@ -0,0 +1,10 @@
+#cloud-config
+
+package_update: true
+package_upgrade: true
+
+packages:
+  - git
+
+runcmd:
+  - bash -c "$(curl -fsSL https://raw.githubusercontent.com/wmde/wikibase-release-pipeline/refs/heads/deploy-setup-script/deploy/setup/setup.sh)" -- --cloud-init --verbose