VpsDeploy (VpsDeploy v0.1.7)

Copy Markdown View Source

Simple VPS deployment for Phoenix applications via rsync + SSH.

Configuration

Add to your config/config.exs:

config :vps_deploy,
  app_name: "my_app",
  service_name: "my-app",
  vps_user: "deploy",
  vps_host: "1.2.3.4",
  deploy_dir: "/home/deploy/www/my_app",
  excludes: ~w(.git _build deps .env),
  use_database: true, # set to false to skip Ecto migrations
  remote_script: "..." # optional, overrides the default Phoenix build script

Environment variables VPS_USER and VPS_HOST override config values at runtime.

Summary

Functions

config()

default_excludes()

default_remote_script(app_name, service_name, deploy_dir, use_database \\ true)

lock_command(deploy_dir)

merge_excludes(list)

overlay_config_source(existing, block)

safety_excludes()

shell_quote(value)

ssh_connect_args(user, host)

sudoers_setup_script(deploy_user, service_name, sudoers_file \\ nil)