Skip to content

Commit

Permalink
config 📝 was redundant.. just have one version of docs not many
Browse files Browse the repository at this point in the history
  • Loading branch information
dschep committed Feb 20, 2016
1 parent 79bc115 commit 6cbe309
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 40 deletions.
33 changes: 22 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,24 +96,35 @@ ToDo
- `Boxcar <https://boxcar.io>`_
- `Instapush <https://instapush.im>`_

Config
------
Configuring ``ntfy``
--------------------

``ntfy`` is configured via a yaml config file stored at
``~/.ntfy.yml``. It requires at minimum 1 keys: backends & a config for any
backend that requires one.
``ntfy`` is configured with a YAML file stored at ``~/.ntfy.yml``

See the `Configuration docs <http://ntfy.rtfd.org/en/stable/configuring-ntfy.html>`_ for more.
Backends
~~~~~~~~

Example Config:
The backends key specifies what backends to use by default. Each backend has
it's own configuration, stored in a key of it's own name. For example:

::

---
backends
- pushbullet
pushbullet
access_token: T0K3N
backends:
- pushover
- linux
pushover:
user_key: hunter2
pushbullet:
access_token: hunter2

Note: versions prior to v1.0.0 used JSON instead of YAML.

Note: v0.2.1 and older supported only a single backend, to support old configuration files ntfy will still accept a single backend (a string instead of a list of strings) with the key 'backend'.

The available backends are in `ntfy.backends <ntfy.backends.html>`_,
include only the module name in your config (eg: ``pushbullet`` not
``ntfy.backends.pushbullet``).

Testing
-------
Expand Down
29 changes: 0 additions & 29 deletions docs/configuring-ntfy.rst

This file was deleted.

0 comments on commit 6cbe309

Please sign in to comment.