Kitto v0.3.0 Kitto

This is the documentation for the Kitto project.

You can find documentation about developing with Kitto and configuration options at the wiki

By default, Kitto applications depend on the following packages:

  • Plug - a specification and conveniences for composable modules in between web applications
  • Poison - an Elixir JSON library

Summary

Functions

Returns the binding ip of the assets watcher server

Returns the binding port of the assets watcher server

Returns the root path of the dashboard project

Called when an application is started

Functions

asset_server_host()

Returns the binding ip of the assets watcher server

asset_server_port()

Returns the binding port of the assets watcher server

root()

Returns the root path of the dashboard project

start(type, args)

Called when an application is started.

This function is called when an the application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another mode and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the pid of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the stop/2 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.

start_server()