docbrown/docs/backend/pusher.md
Jacob Herrington 7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00

1.2 KiB

title
Pusher

Pusher for Realtime Notifications

Pusher is a third party service being used to power the chat system.

In order to use the chat functionality within your development environment, you will need to sign up for a free-tier Pusher account and retrieve its keys. Then you'll need to provide those keys to the Rails application.

  1. Sign up or sign in to your Pusher account.

  2. Once signed in, fill in the prompt to create a new Pusher Channels app.

    pusher-1

  3. In your new Pusher Channels app, click the "App Keys" tab.

    pusher-2

  4. Change your keys accordingly (name of Pusher key -> name of our application key):

    app_id -> PUSHER_APP_ID
    key -> PUSHER_KEY
    secret -> PUSHER_SECRET
    cluster -> PUSHER_CLUSTER
    

    pusher-3

  5. Done.