Skip to content

Configuration documentation #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mweibel merged 2 commits into from
Feb 6, 2018
Merged

Configuration documentation #57

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0999f47
Update README.md
gr8bit Jan 17, 2018
928bc86
change default graph urls, update documentation
gr8bit Jan 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@ After you are done, run this in your shell to fetch the new dependency:
$ mix deps.get
```

## Configuration

```
Copy link
Owner

@mweibel mweibel Jan 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you somehow mention what the default configuration is and where to put that file?

Copy link
Contributor Author

@gr8bit gr8bit Jan 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, that's for Phoenix, sorry... will update

config :facebook,
appsecret: "<your app secret>",
graph_url: "https://graph.facebook.com",
 graph_video_url: "https://graph-video.facebook.com"
```
For graph_url and video_graph_url, you may also specify versioned urls (recommended) to pin your calls to a specific API version, like so:
```
graph_url: "https://graph.facebook.com/v2.11",
 graph_video_url: "https://graph-video.facebook.com/v2.8"
```
Note that you *must not* end the urls with a slash or the requests will fail (Facebook will report an error about unknown url components)!

Supplying an appsecret is optional. If you supply it, an [appsecret_proof](https://developers.facebook.com/docs/graph-api/securing-requests) will be submitted along with the Graph API requests. The appsecret can be changed (or set) at runtime using `Facebook.set_appsecret("<app secret>")`.

## Usage

1. Register an application on [developer.facebook.com](https://developer.facebook.com)
Expand Down