NOTI.YAML(5)

NAME

noti.yaml - noti configuration file

SYNOPSIS

noti.yaml

DESCRIPTION

File format is YAML.

If not explicitly set with --file, then noti will check the following paths, in the following order.

•   ./.noti.yaml

•   $XDG_CONFIG_HOME/noti/noti.yaml

If $XDG_CONFIG_HOME is empty, then $HOME/.config will be used as its default value and noti will check $HOME/.config/noti/noti.yaml.

NSUSER

soundName
    Banner success sound. Default is Ping. Possible options are Basso, Blow, Bottle, Frog, Funk, Glass, Hero, Morse, Ping, Pop, Purr, Sosumi, Submarine, Tink. See /System/Library/Sounds for available sounds.

soundNameFail
    Banner failure sound. Default is Basso. Possible options are Basso, Blow, Bottle, Frog, Funk, Glass, Hero, Morse, Ping, Pop, Purr, Sosumi, Submarine, Tink. See /System/Library/Sounds for available sounds.

SAY

voice
    Name of voice used for speech notifications.

ESPEAK

voiceName
    Name of voice used for speech notifications.

SPEECHSYNTHESIZER

voice
    Name of voice used for speech notifications.

BEARYCHAT

incomingHookURI
    BearyChat incoming URI.

HIPCHAT

accessToken
    HipChat access token. Log into your HipChat account and retrieve a token from the Room Notification Tokens page.

room
    HipChat message destination. Can be either a Room name or ID.

PUSHBULLET

accessToken
    Pushbullet access token. Log into your Pushbullet account and retrieve a token from the Account Settings page.

PUSHOVER

apiToken
    Pushover access token. Log into your Pushover account and create a token from the Create New Application/Plugin page.

userKey
    Pushover message destination. Should be your User Key.

PUSHSAFER

key Pushsafer private or alias key. Log into your Pushsafer account and note your private or alias key.

SIMPLEPUSH

key Simplepush key. Install the Simplepush app and retrieve your key there.

event
    Customize ringtone and vibration.

SLACK

token
    Slack access token. Log into your Slack account and retrieve a token from the Slack Web API page.

channel
    Slack message destination. Can be either a #channel or a @username.

username
    Noti bot username.

EXAMPLES

    ---
    nsuser:
      soundName: Ping
      soundNameFail: Basso
    say:
      voice: Alex
    espeak:
      voiceName: english-us
    speechsynthesizer:
      voice: Microsoft David Desktop
    bearychat:
      incomingHookURI: 1234567890abcdefg
    hipchat:
      accessToken: 1234567890abcdefg
      room: 1234567890abcdefg
    pushbullet:
      accessToken: 1234567890abcdefg
    pushover:
      userKey: 1234567890abcdefg
      apiToken: 1234567890abcdefg
    pushsafer:
      key: 1234567890abcdefg
    simplepush:
      key: 1234567890abcdefg
      event: 1234567890abcdefg
    slack:
      token: 1234567890abcdefg
      channel: '@jaime'
      username: noti

SEE ALSO

noti(1)

AUTHORS
Jaime Piña.