README.md
1# Activity Stream Router
2
3## Preferences `browser.newtab.activity-stream.asrouter.*`
4
5Name | Used for | Type | Example value
6--- | --- | --- | ---
7`allowHosts` | Allow a host in order to fetch messages from its endpoint | `[String]` | `["gist.github.com", "gist.githubusercontent.com", "localhost:8000"]`
8`providers.snippets` | Message provider options for snippets | `Object` | [see below](#message-providers)
9`providers.cfr` | Message provider options for cfr | `Object` | [see below](#message-providers)
10`providers.onboarding` | Message provider options for onboarding | `Object` | [see below](#message-providers)
11`useRemoteL10n` | Controls whether to use the remote Fluent files for l10n, default as `true` | `Boolean` | `[true|false]`
12
13### Message providers examples
14
15```json
16{
17 "id" : "snippets",
18 "type" : "remote",
19 "enabled": true,
20 "url" : "https://snippets.cdn.mozilla.net/us-west/bundles/bundle_d6d90fb9098ce8b45e60acf601bcb91b68322309.json",
21 "updateCycleInMs" : 14400000
22}
23```
24
25```json
26{
27 "id" : "onboarding",
28 "enabled": true,
29 "type" : "local",
30 "localProvider" : "OnboardingMessageProvider"
31}
32```
33
34### [Snippet message format documentation](https://github.com/mozilla/activity-stream/blob/master/content-src/asrouter/schemas/message-format.md)
35