Skip to content

Commit f4e6a12

Browse files
committed
fix(contributing): Mention syncEngine.APIRoot
1 parent 0607e85 commit f4e6a12

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you've found a bug, try searching for similars issue before filing a new one.
77
# Contributing to N1
88

99
The hosted sync engine allows us to control adoption of N1 and maintain a great
10-
experience for our users. However, the sync engine is
10+
experience for our users. However, the sync engine is
1111
[open source](https://github.com/nylas/sync-engine) and you can set it
1212
up yourself to begin using N1 immediately. Follow instructions on the [sync
1313
engine](https://github.com/nylas/sync-engine) repository.
@@ -24,7 +24,7 @@ Read the [getting started guides](http://nylas.com/N1/docs/).
2424

2525
See [Windows instructions here](https://github.com/nylas/N1/blob/master/docs/Windows.md)
2626

27-
Linux users on Debian 8 and Ubuntu 15.04 onward must also install libgcrypt11, which Electron depends on.
27+
Linux users on Debian 8 and Ubuntu 15.04 onward must also install libgcrypt11, which Electron depends on.
2828

2929
### Running N1
3030

@@ -104,7 +104,12 @@ however, the Sync Engine is open source and you can run it yourself.
104104

105105
Replace `env: "production"` with `env: "local"` at the top level of the config.
106106
This tells N1 to look at `localhost:5555` for the sync engine. If you've deployed
107-
the sync engine elsewhere, you'll need to edit `nylas-api.coffee`.
107+
the sync engine elsewhere, add the following block beneath `env: "local"`:
108+
109+
```
110+
syncEngine:
111+
APIRoot: http://mysite.com:5555
112+
```
108113

109114
Copy the JSON array of accounts returned from the Sync Engine's `/accounts`
110115
endpoint (ex. `http://localhost:5555/accounts`) into the config file at the

0 commit comments

Comments
 (0)