Configuration reference

Set these with config :mishka_installer, key, value. In a release, put them in config/runtime.exs.

Allowlist keys

Local :path installs never use url_hosts or github_repos. Every refusal logs a warning and emits the [:mishka_installer, :installer, :blocked] telemetry event.

Downloader options and a proxy

A :url, :github_tag or :github_latest_release install downloads with Req. Both settings are keyword lists of Req options. The library builds each request, then merges :downloader_req_options and then :proxy into it, key by key. A key set in both takes the value of :proxy, and a nested option such as headers or connect_options is replaced as a whole. A GitHub install sends two requests, one to the GitHub API for the release and one for the asset, and both get the options.

config :mishka_installer, :downloader_req_options,
  receive_timeout: 60_000

config :mishka_installer, :proxy,
  connect_options: [proxy: {:http, "proxy.internal", 3128, []}]

Req waits 15 seconds for a response unless you set :receive_timeout, so raise it for a large artifact on a slow link. The proxy value is {scheme, host, port, options}. The proxy carries an http download as a proxied request and an https download through a CONNECT tunnel.

In 0.1.13 and 0.1.14 a request that cannot be made raises a Req exception out of install/1. A refused connection, a timeout and a proxy that refuses the tunnel all do this. An answer other than 200 comes back as {:error, [%{action: :download}]}.

Set these with config :mishka_installer, MishkaInstaller.MnesiaRepo, options.

MishkaInstaller.__information__/0 returns the resolved values as %{path: path, env: env}.

Read the store

MishkaInstaller.MnesiaRepo.state/0 returns a %MishkaInstaller.MnesiaRepo.State{}. It is a call to the store process, so it fails while that process is not running. MishkaInstaller.MnesiaRepo.schemas/0 lists every local table except :schema, read from Mnesia on each call, as {table, [storage_type: type, local_content: boolean]}.

Under MishkaInstaller.Supervisor, one-for-one:

1. Phoenix.PubSub named MishkaInstaller.PubSub.
2. MishkaInstaller.Installer.CompileHandler, the install queue and the replay on boot.
3. MishkaInstaller.Event.EventHandler, the queue that rebuilds event modules.
4. MishkaInstaller.MnesiaRepo, the store.

The library decides when it compiles. If its environment is :test, it starts only the PubSub, and the tables use RAM copies instead of disc copies. The periodic table check does not run. Start the three other processes yourself, in the order above. Mishka CMS does this for any of them the library did not start:

@installer_children [
  MishkaInstaller.Installer.CompileHandler,
  MishkaInstaller.Event.EventHandler,
  MishkaInstaller.MnesiaRepo
]

def installer_children,
  do: @installer_children -- MishkaInstaller.Application.supervised_children()

Because MIX_ENV wins over :project_env, a dependency built while MIX_ENV=test is exported starts only its PubSub, whatever your config says.

To start these processes in your own test suite and wait until the store is ready, read the documentation on testing plugins.

• Deploy to production.
• Install a library at runtime.
• Telemetry and log reference.
• Helper modules and your own tables: the :essential key with a table of your own.
• Test plugins and events: the test environment in practice.