vercel-vm-factory 0.1.0 → 0.1.1

package/README.md

@@ -6,6 +6,14 @@ Create a tiny Vercel Container deployment: copy `wsterm` from `ghcr.io/v1xingyue
 npx vercel-vm-factory create \
   --base ubuntu \
   --project ws-shell-ubuntu \
+  --auth-user admin \
+  --auth-password change-me
+```
+
+GitHub OAuth is optional:
+
+```bash
+npx vercel-vm-factory create \
   --client-id YOUR_GITHUB_CLIENT_ID \
   --client-secret YOUR_GITHUB_CLIENT_SECRET \
   --github-userid 12345678
@@ -27,7 +35,7 @@ The script checks `vercel --version` and `vercel whoami`; if you are not logged
 
 Use `--help` to show all flags.
 
-Entered GitHub values are reused from `~/.vercel-vm-factory/defaults.json`; press Enter to keep the placeholder value or skip an empty one.
+Entered auth values are reused from `~/.vercel-vm-factory/defaults.json`; press Enter to keep the placeholder value or skip an empty one.
 
 The generated project contains only `Dockerfile.vercel`.
 
@@ -56,4 +64,26 @@ Before deploying, set the GitHub OAuth callback URL to:
 https://PROJECT.vercel.app/auth/github/callback
 ```
 
+For example, if `--project x-shell`, set:
+
+```text
+https://x-shell.vercel.app/auth/github/callback
+```
+
+GitHub OAuth fields:
+
+- Username -> `--auth-user`
+- Password -> `--auth-password`
+- Client ID -> `--client-id`
+- Client Secret -> `--client-secret`
+- Numeric GitHub user ID -> `--github-userid`
+
+Get your numeric user ID:
+
+```text
+https://api.github.com/users/YOUR_LOGIN
+```
+
+The callback URL must match exactly. If you deploy under another project name or custom domain, update the GitHub OAuth App or pass `--redirect-url`.
+
 Use `--dry-run` to generate files without deploying.

package/deploy-vm.mjs

@@ -94,7 +94,10 @@ async function main() {
   }
 
   await ensureVercelReady();
+  printOAuthGuide(oauthRedirectUrl);
 
+  const authUsername = await secret("auth-user", "Basic auth username", process.env.AUTH_USERNAME ?? defaults["auth-user"]);
+  const authPassword = await secret("auth-password", "Basic auth password", process.env.AUTH_PASSWORD ?? defaults["auth-password"]);
   const githubClientId = await secret("client-id", "GitHub client id", process.env.GITHUB_CLIENT_ID ?? defaults["client-id"]);
   const githubClientSecret = await secret(
     "client-secret",
@@ -109,6 +112,8 @@ async function main() {
     scope: scope || undefined,
     project,
     from: wsShellImage,
+    "auth-user": authUsername,
+    "auth-password": authPassword,
     "client-id": githubClientId,
     "client-secret": githubClientSecret,
     "github-userid": allowedUserIds,
@@ -137,6 +142,8 @@ async function main() {
     `OAUTH_REDIRECT_URL=${oauthRedirectUrl}`,
   ];
 
+  if (authUsername) vercelArgs.push("--env", `AUTH_USERNAME=${authUsername}`);
+  if (authPassword) vercelArgs.push("--env", `AUTH_PASSWORD=${authPassword}`);
   if (githubClientId) vercelArgs.push("--env", `GITHUB_CLIENT_ID=${githubClientId}`);
   if (githubClientSecret) vercelArgs.push("--env", `GITHUB_CLIENT_SECRET=${githubClientSecret}`);
   if (allowedUserIds) vercelArgs.push("--env", `ALLOWED_USER_IDS=${allowedUserIds}`);
@@ -192,6 +199,8 @@ async function doctor() {
   printKeyValue("project", defaults.project || "not set");
   printKeyValue("scope", defaults.scope || "not set");
   printKeyValue("source image", defaults.from || "ghcr.io/v1xingyue/ws-shell:v1.1.alpine");
+  printKeyValue("auth user", defaults["auth-user"] ? mask(defaults["auth-user"]) : "not set");
+  printKeyValue("auth password", defaults["auth-password"] ? mask(defaults["auth-password"]) : "not set");
   printKeyValue("client id", defaults["client-id"] ? mask(defaults["client-id"]) : "not set");
   printKeyValue("client secret", defaults["client-secret"] ? mask(defaults["client-secret"]) : "not set");
   printKeyValue("github userid", defaults["github-userid"] ? mask(defaults["github-userid"]) : "not set");
@@ -381,6 +390,15 @@ function printSummary(items) {
   console.log("");
 }
 
+function printOAuthGuide(callbackUrl) {
+  console.log(color.bold("GitHub OAuth"));
+  console.log(`${color.yellow("!")} Set this callback URL in your GitHub OAuth App before deploying:`);
+  console.log(`  ${color.bold(callbackUrl)}`);
+  console.log(color.dim("  GitHub: Settings -> Developer settings -> OAuth Apps -> Authorization callback URL"));
+  console.log(color.dim("  User ID: open https://api.github.com/users/YOUR_LOGIN and copy the numeric id"));
+  console.log("");
+}
+
 function printKeyValue(key, value) {
   console.log(`${color.dim(`${key.padEnd(14)} `)}${value}`);
 }
@@ -414,6 +432,8 @@ Options:
   --project NAME       Vercel project name
   --scope SLUG         Optional Vercel team/user scope slug
   --from IMAGE         Source image for /app/bin/wsterm
+  --auth-user VALUE    Username/password auth user
+  --auth-password VAL  Username/password auth password
   --client-id VALUE    GitHub OAuth client id
   --client-secret VAL  GitHub OAuth client secret
   --github-userid VAL  Allowed GitHub numeric user id(s)
@@ -423,5 +443,9 @@ Options:
   --dry-run            Generate Dockerfile.vercel only
   --doctor             Check Vercel CLI/login and saved defaults
   --help               Show this help
+
+GitHub OAuth:
+  Callback URL must match the deployed project:
+  https://PROJECT.vercel.app/auth/github/callback
 `);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vercel-vm-factory",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Create Vercel Container deployments for ws-shell from selectable base images.",
   "license": "MIT",
   "type": "module",