diff options
Diffstat (limited to 'browser/components/asrouter/README.md')
| -rw-r--r-- | browser/components/asrouter/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/browser/components/asrouter/README.md b/browser/components/asrouter/README.md new file mode 100644 index 0000000000..213093af86 --- /dev/null +++ b/browser/components/asrouter/README.md @@ -0,0 +1,23 @@ +# Activity Stream Router + +## Preferences `browser.newtab.activity-stream.asrouter.*` + +Name | Used for | Type | Example value +--- | --- | --- | --- +`allowHosts` | Allow a host in order to fetch messages from its endpoint | `[String]` | `["gist.github.com", "gist.githubusercontent.com", "localhost:8000"]` +`providers.cfr` | Message provider options for cfr | `Object` | [see below](#message-providers) +`providers.onboarding` | Message provider options for onboarding | `Object` | [see below](#message-providers) +`useRemoteL10n` | Controls whether to use the remote Fluent files for l10n, default as `true` | `Boolean` | `[true|false]` + +### Message providers examples + +```json +{ + "id" : "onboarding", + "enabled": true, + "type" : "local", + "localProvider" : "OnboardingMessageProvider" +} +``` + +### [Message format documentation](https://github.com/mozilla/activity-stream/blob/master/content-src/asrouter/schemas/message-format.md) |