Project-based configuration

Use a project-based configuration file to keep repeatable deployment settings with your application.

quickdeploy.json

You can create a quickdeploy.json file in your root directory. quickdeploy push will then use the configuration from the file. The global config file will be used as a fallback for unspecified options. You can also still override the config file with the command line flags.

{
  "domain": "test.quickdeploy.dev",
  "project": "test",
  "container": "web",
  "container_port": 3000,
  "user": "deploy",
  "ssh_key_path": "/home/your-local-user/.ssh/quickdeploy"
}

With this config file your project would be deployed to the domain test.quickdeploy.dev with the project name test, container name web, and internal application port 3000 using the command quickdeploy push.

Use an absolute path for ssh_key_path. The CLI passes this value directly to ssh and does not expand ~ or $HOME. The path is on the computer or CI runner where the QuickDeploy CLI runs, not on the VPS.

Currently the following options are available:

• ip: The IP address of your server.
• domain: The domain you want the project to be accessible on.
• project: The project name you want to deploy.
• container: The container name within the project.
• container_port: The port the application listens on inside its container.
• user: The user you want to use for the deployment.
• ssh_key_path: The path to the SSH key you want to use for the deployment.

Command-line flags take priority over the matching project values for domain, project, container, and port. Project values for IP, user, and SSH key take priority over the global configuration and environment variables.