configuration/channels.yml

Channels.yml

The configuration for channels.


defaultChannel
The channel a user joins when he logs in.
channel-managers
A list of provider for channels.
providers
A list of provider for user.
user-storage
The way how user are stored.
Don't change this value if you don't know what you are doing.

channel-managers

Each channel manager has usually the following form in the configuration:

channel-managers:
# [...]
- # The name of the object.
  name: "The name of the manager."
  # The type of the object.
  type: "The type of the object."

  # The configuration for the object.
  configuration: {} # Depends on the type.
# [...]

For a list of ChannelManagers, look at "docs/ChannelManager.yml" for a reference of available channel manager.
The default configuration values are added when they are missing.


providers

Each provider has usually this form:

providers:
# [...]
- # The name of the object.
  name: "The name of the manager."
  # The type of the object.
  type: "The type of the object."

  # The configuration for the object.
  configuration: {} # Depends on the type.
# [...]

For a list of ChannelManagers, look at "docs/UserProvider.yml" for a reference of available channel manager.
The default configuration values are added when they are missing.


For example configurations, please view the example profiles shipped with PulseChat.


Comments

Posts Quoted:
Reply
Clear All Quotes