core: extend new vars and pocketbase values (#16313)

* Let docker-install.sh take its three answers up front The script asked three questions with no way to answer them in advance, so a Docker container could not be deployed unattended: Portainer, the Portainer Agent, and whether to expose the TCP socket. Each now reads a variable and prompts only when it is unset, the same shape install/forgejo-runner-install.sh already uses: var_portainer yes | no var_portainer_agent yes | no var_docker_socket n | l (127.0.0.1) | a (0.0.0.0) Interactive behaviour is unchanged — with nothing set, all three still ask exactly as before. The matching declaration for the script's PocketBase record, which the website generator reads to offer these as form fields: "app_vars": [ {"name":"var_portainer","label":"Install Portainer","type":"boolean","default":"no"}, {"name":"var_portainer_agent","label":"Install Portainer Agent","type":"boolean","default":"no", "help":"Only used when Portainer itself is not installed"}, {"name":"var_docker_socket","label":"Expose Docker TCP socket","type":"select", "options":["n","l","a"],"default":"n", "help":"l = 127.0.0.1 only, a = all interfaces (insecure)"} ] CONTRIBUTING.md documents the convention so the next script follows it. * Let docker-install.sh take its three answers up front The script asked three questions with no way to answer them in advance, so a Docker container could not be deployed unattended: Portainer, the Portainer Agent, and whether to expose the TCP socket. Each now reads a variable and prompts only when it is unset, the same shape install/forgejo-runner-install.sh already uses: var_portainer yes | no var_portainer_agent yes | no var_docker_socket n | l (127.0.0.1) | a (0.0.0.0) Interactive behaviour is unchanged — with nothing set, all three still ask exactly as before. The matching declaration for the script's PocketBase record, which the website generator reads to offer these as form fields: "app_vars": [ {"name":"var_portainer","label":"Install Portainer","type":"boolean","default":"no"}, {"name":"var_portainer_agent","label":"Install Portainer Agent","type":"boolean","default":"no", "help":"Only used when Portainer itself is not installed"}, {"name":"var_docker_socket","label":"Expose Docker TCP socket","type":"select", "options":["n","l","a"],"default":"n", "help":"l = 127.0.0.1 only, a = all interfaces (insecure)"} ] CONTRIBUTING.md documents the convention so the next script follows it. * Let forgejo-runner and pangolin take their answers up front forgejo-runner already exported two of the three values its install script requires, but not var_forgejo_runner_uuid — so an unattended install passed the ct-level guard and then stopped at a prompt inside the container, which is the one place nobody can answer it. The guard missed it for the same reason. pangolin asked for its URL and email with no way to supply them. Both sides are needed: the read in install/ now only fires when the variable is unset, and ct/ exports it, because lxc-attach carries the caller's environment but only what was exported. Reverts the docker change from the previous commit; it is superseded by work on another branch. * Teach the PocketBase workflows the capability fields All three wrote fields the site no longer reads. The slash bot and the AI bot accepted has_arm=true and github=owner/repo; push-json mapped has_arm into the payload. After the schema change those writes would have gone to columns that are not there. architectures and platforms are multi-selects over a closed set, so both bots reject an unknown value instead of storing it — the same guarantee the field type gives in the admin UI. push-json still reads has_arm when architectures is absent, because ProxmoxVED's json files carry the old key until they are converted. * Drop the docker change again It came back through the merge in 35735dae: the branch was pushed before the revert, so merging the remote copy restored it. Removing it forward rather than rewriting history that is already published.
2026-08-07 13:19:14 +02:00 · 2026-08-07 04:49:45 +02:00
parent 63a91c8d93
commit 63e4ea1396
7 changed files with 124 additions and 11 deletions
@@ -103,6 +103,55 @@ Key rules at a glance:
 - Quote all variables: `"$VAR"` not `$VAR`
 - Use lowercase variable names
 - Do not hardcode credentials or sensitive values
+- Never prompt without an escape hatch — see below
+
+### Answering a prompt up front
+
+An install script that only asks cannot be deployed unattended. Read the
+variable first and prompt only when it is unset:
+
+```bash
+if [[ -z "${var_admin_user:-}" ]]; then
+  read -r -p "${TAB3}Admin username: " var_admin_user
+fi
+var_admin_user="${var_admin_user:-admin}"
+```
+
+Name them `var_<something>`, the same namespace the container variables use.
+`install/forgejo-runner-install.sh`, `install/pangolin-install.sh`, and `install/docker-install.sh` all
+follow this.
+
+The variable also has to be exported from `ct/<app>.sh`, or it never reaches
+the container — `lxc-attach` carries the caller's environment, but only for
+what was actually exported:
+
+```bash
+export var_admin_user="${var_admin_user:-}"
+```
+
+Declare them on the script's PocketBase record in `app_vars` so the website's
+generator can offer them as fields:
+
+```json
+"app_vars": [
+  {
+    "name": "var_admin_user",
+    "label": "Admin Username",
+    "type": "text",
+    "default": "admin"
+  },
+  {
+    "name": "var_admin_pass",
+    "label": "Admin Password",
+    "type": "password",
+    "secret": true
+  }
+]
+```
+
+`type` is one of `text`, `password`, `number`, `boolean` (`yes`/`no`) or
+`select` (with `options`). Mark anything credential-like `secret` — the
+generator keeps those out of shareable links and out of the on-screen summary.

 Full standards and examples: **[community-scripts.org/docs/contribution](https://community-scripts.org/docs/contribution)**