Back to Flutter Server Box

Bulk Import Servers

docs/src/content/docs/advanced/bulk-import.md

1.0.13902.0 KB
Original Source

Import multiple server configurations at once using a JSON file.

JSON Format

:::danger[Security Warning] Never store plaintext passwords in files! This JSON example shows a password field for demonstration only, but you should:

  • Prefer SSH keys (pubKeyId) instead of pwd - they're more secure
  • Use secret managers or environment variables if you must use passwords
  • Delete the file immediately after import - don't leave credentials lying around
  • Add to .gitignore - never commit credential files to version control :::
json
[
  {
    "name": "My Server",
    "ip": "example.com",
    "port": 22,
    "user": "root",
    "pwd": "password",
    "pubKeyId": "",
    "tags": ["production"],
    "autoConnect": false
  }
]

Fields

FieldRequiredDescription
nameYesDisplay name
ipYesDomain or IP address
portYesSSH port (usually 22)
userYesSSH username
pwdNoPassword (avoid - use SSH keys instead)
pubKeyIdNoPrivate key id (from Private Keys - recommended)
tagsNoOrganization tags
autoConnectNoAuto-connect on startup
idNoStable server id; omitted or empty values are generated on import

Import Steps

  1. Create JSON file with server configurations
  2. Settings → Backup → Bulk Import Servers
  3. Select your JSON file
  4. Confirm import

Example

json
[
  {
    "name": "Production",
    "ip": "prod.example.com",
    "port": 22,
    "user": "admin",
    "pubKeyId": "my-key",
    "tags": ["production", "web"]
  },
  {
    "name": "Development",
    "ip": "dev.example.com",
    "port": 2222,
    "user": "dev",
    "pubKeyId": "dev-key",
    "tags": ["development"]
  }
]

Tips

  • Use SSH keys instead of passwords when possible
  • Test connection after import
  • Organize with tags for easier management
  • Delete JSON file after import
  • Never commit JSON files with credentials to version control