yggdrasil v3.3.1 Yggdrasil.Settings View Source

This module defines the available settings for Yggdrasil.

Link to this section Summary

Functions

Pub-sub adapter to use for channels. Default value is Phoenix.PubSub.PG2

Pub-sub name. By default is Yggdrasil.PubSub

Pub-sub options. By default are [pool_size: 1]

Process registry

Postgres database. Defaults to "postgres"

Postgres hostname. Defaults to "localhost"

Postgres password. Defaults to "postgres"

Postgres port. Defaults to 5432

Postgres username. Defaults to "postgres"

Yggdrasil publisher options. This options are for :poolboy. Defaults to [size: 5, max_overflow: 10]

RabbitMQ hostname. Defaults to "localhost"

RabbitMQ password. Defaults to "guest"

RabbitMQ port. Defaults to 5672

RabbitMQ subscriber options. They are options for :poolboy. Defaults to [size: 5, max_overflow: 10].

RabbitMQ username. Defaults to "guest"

RabbitMQ virtual host. Defaults to "/"

Redis database. Defaults to 0

Redis hostname. Defaults to "localhost"

Redis password. Defaults to nil

Redis port. Defaults to 6379

Link to this section Functions

Pub-sub adapter to use for channels. Default value is Phoenix.PubSub.PG2.

config :yggdrasil,
  pubsub_adapter: Phoenix.PubSub.PG2

Pub-sub name. By default is Yggdrasil.PubSub.

config :yggdrasil,
  pubsub_name: Yggdrasil.PubSub

Pub-sub options. By default are [pool_size: 1].

config :yggdrasil,
  pubsub_options: [pool_size: 1]

Process registry.

config :yggdrasil,
  registry: ExReg
Link to this function yggdrasil_postgres_database() View Source

Postgres database. Defaults to "postgres".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_POSTGRES_DATABASE.
  2. The configuration file.
  3. The default value "postgres".

If the database is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_POSTGRES_DATABASE where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  postgres: [database: "postgres"]
Link to this function yggdrasil_postgres_hostname() View Source

Postgres hostname. Defaults to "localhost".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_POSTGRES_HOSTNAME.
  2. The configuration file.
  3. The default value "localhost"

If the hostname is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_POSTGRES_HOSTNAME where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  potgres: [hostname: "localhost"]
Link to this function yggdrasil_postgres_password() View Source

Postgres password. Defaults to "postgres".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_POSTGRES_PASSWORD.
  2. The configuration file.
  3. The default value "postgres".

If the password is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_POSTGRES_PASSWORD where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  postgres: [password: "postgres"]
Link to this function yggdrasil_postgres_port() View Source

Postgres port. Defaults to 5432.

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_POSTGRES_PORT.
  2. The configuration file.
  3. The default value 5432.

If the port is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_POSTGRES_PORT where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  postgres: [port: 5432]
Link to this function yggdrasil_postgres_username() View Source

Postgres username. Defaults to "postgres".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_POSTGRES_USERNAME.
  2. The configuration file.
  3. The default value "postgres".

If the username is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_POSTGRES_USERNAME where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  postgres: [username: "postgres"]
Link to this function yggdrasil_publisher_options() View Source

Yggdrasil publisher options. This options are for :poolboy. Defaults to [size: 5, max_overflow: 10].

config :yggdrasil,
  publisher_options: [size: 5, max_overflow: 10]
Link to this function yggdrasil_rabbitmq_hostname() View Source

RabbitMQ hostname. Defaults to "localhost".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_RABBITMQ_HOSTNAME.
  2. The configuration file.
  3. The default value "localhost"

If the hostname is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_RABBITMQ_HOSTNAME where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  rabbitmq: [hostname: "localhost"]
Link to this function yggdrasil_rabbitmq_password() View Source

RabbitMQ password. Defaults to "guest".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_RABBITMQ_PASSWORD.
  2. The configuration file.
  3. The default value "guest".

If the password is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_RABBITMQ_PASSWORD where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  rabbitmq: [password: "guest"]
Link to this function yggdrasil_rabbitmq_port() View Source

RabbitMQ port. Defaults to 5672.

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_RABBITMQ_PORT.
  2. The configuration file.
  3. The default value 5672.

If the port is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_RABBITMQ_PORT where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  rabbitmq: [port: 5672]
Link to this function yggdrasil_rabbitmq_subscriber_options() View Source

RabbitMQ subscriber options. They are options for :poolboy. Defaults to [size: 5, max_overflow: 10].

config :yggdrasil, [NAMESPACE]
  rabbitmq: [subscriber_options: [size: 5, max_overflow: 10]]
Link to this function yggdrasil_rabbitmq_username() View Source

RabbitMQ username. Defaults to "guest".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_RABBITMQ_USERNAME.
  2. The configuration file.
  3. The default value "guest".

If the username is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_RABBITMQ_USERNAME where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  rabbitmq: [username: "guest"]
Link to this function yggdrasil_rabbitmq_virtual_host() View Source

RabbitMQ virtual host. Defaults to "/".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_RABBITMQ_VIRTUAL_HOST.
  2. The configuration file.
  3. The default value "/".

If the virtual host is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_RABBITMQ_VIRTUAL_HOST where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  rabbitmq: [virtual_host: "/"]
Link to this function yggdrasil_redis_database() View Source

Redis database. Defaults to 0.

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_REDIS_DATABASE.
  2. The configuration file.
  3. The default value 0.

If the database is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_REDIS_DATABASE where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  redis: [database: 0]
Link to this function yggdrasil_redis_hostname() View Source

Redis hostname. Defaults to "localhost".

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_REDIS_HOSTNAME.
  2. The configuration file.
  3. The default value "localhost"

If the hostname is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_REDIS_HOSTNAME where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  redis: [hostname: "localhost"]
Link to this function yggdrasil_redis_password() View Source

Redis password. Defaults to nil.

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_REDIS_PASSWORD.
  2. The configuration file.
  3. The default value nil.

If the password is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_REDIS_PASSWORD where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  redis: [password: nil]

Redis port. Defaults to 6379.

It looks for the value following this order:

  1. The OS environment variable $YGGDRASIL_REDIS_PORT.
  2. The configuration file.
  3. The default value 6379.

If the port is defined using a namespace, then the name of the OS variable should be $<NAMESPACE>_YGGDRASIL_REDIS_PORT where NAMESPACE is the snake case version of the actual namespace e.g MyApp.Namespace would be MYAPP_NAMESPACE.

config :yggdrasil, [NAMESPACE]
  redis: [port: 6379]