Redhat community server connector vscode extension configs

redhat-community-server-connector-extension.md

Here are all available "rsp-ui.rsp.*" settings you can use in your VS Code User or Workspace settings.json, as provided by the Runtime Server Protocol UI extension (marketplace.visualstudio.com):

---

⚙️ General Extension Flags

• rsp-ui.rsp.java.home Specifies the path to a JDK (11+) to launch the RSP server and default Java-based runtimes. ‣ Example:

  "rsp-ui.rsp.java.home": "/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home"

• rsp-ui.enableStartServerOnActivation Controls which RSP servers auto-start when the extension activates. Accepts an array of objects: { id, name, startOnActivation }.

  "rsp-ui.enableStartServerOnActivation": [
    {
      "id": "redhat.vscode-community-server-connector",
      "name": "Community Server Connector",
      "startOnActivation": true
    }
  ]

• rsp-ui.enableAsyncPublish Enables asynchronous publishing of deployables. ‣ Default: false. ‣ Set to true to offload publishing operations from the main thread.

---

🔧 Server Parameters (via “Edit Server” UI or JSON)

These settings go inside each server’s configuration under .servers.*.server.*:

Parameter	Description
server.autopublish.enabled	Enables auto-publishing of deployables.
server.autopublish.inactivity.limit	How long (ms) to wait before running autopublish.
server.timeout.startup	Timeout (ms) for startup to be recognized by RSP.
server.timeout.shutdown	Timeout (ms) for shutdown to complete.
vm.install.path	Optional JDK path for this server; falls back to rsp-ui.rsp.java.home.
deployables	Array describing each artifact to deploy.

---

🔬 Provisional Server Parameters (May Evolve in Future)

These are advanced, opted-in flags—and could be renamed or removed later:

• args.override.boolean (boolean) Enables overriding program and VM arguments.

• args.vm.override.string (string) A custom VM argument string (requires args.override.boolean = true).

• args.program.override.string (string) A custom program argument string (requires above override enabled).

• mapProperty.launch.env (object) Key/value pairs to override or inject environment variables on launch.

---

🧩 How To Configure in settings.json

Below is a combined example of User-level settings:

{
  // Path to JDK used by RSP and default servers
  "rsp-ui.rsp.java.home": "/usr/lib/jvm/java-17",

  // Auto-start certain RSP server providers on activation
  "rsp-ui.enableStartServerOnActivation": [
    {
      "id": "redhat.vscode-community-server-connector",
      "name": "Community Server Connector",
      "startOnActivation": true
    }
  ],

  // Enable async deployment publishing
  "rsp-ui.enableAsyncPublish": true
}

Per-server configurations—like timeouts or VM overrides—are edited via the “Edit Server” popup, not directly in settings.json.

---

✅ TL;DR

• rsp-ui.rsp.java.home → JDK path
• rsp-ui.enableStartServerOnActivation → list of servers to auto-start
• rsp-ui.enableAsyncPublish → deploy asynchronously
• Per-server settings (publish, timeouts, overrides, env) → inside server config JSON

Let me know if you want sample server JSON or help with a specific setup!