mix phoenix_sync.install (Phoenix.Sync v0.6.1)

View Source

Install Phoenix.Sync into an existing Phoenix or Plug application

Usually invoked using igniter.install:

mix igniter.install phoenix_sync --sync-mode embedded

But can be invoked directly if :phoenix_sync is already a dependency:

mix phoenix_sync.install --sync-mode embedded

Options

  • --sync-mode - How to connect to Electric, either embedded or http.
    • embedded - :electric will be added as a dependency and will connect to the database your repo is configured for.
    • http - You'll need to specify the --sync-url to the remote Electric server.

Options for embedded mode

  • --no-sync-sandbox - Disable the test sandbox

Options for http mode

  • --sync-url (required) - The URL of the Electric server, required for http mode.