forked from rethinkdb/horizon-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Squashed commit of the following: commit f39e8e5bca3393d12b6dbfa5f5072d13673dd4e4 Author: Watts Martin <[email protected]> Date: Wed Jun 15 16:03:18 2016 -0700 Update embed docs with new example commit 768597121bd2dfddb10ffaff9ad693fff7ce6553 Author: Watts Martin <[email protected]> Date: Wed Jun 15 15:41:24 2016 -0700 Updates based on review commit e8d494dd895865fcf82677d62e41f0d375e31de3 Author: Watts Martin <[email protected]> Date: Wed Jun 15 11:36:21 2016 -0700 Link to docs for setting up oauth endpoints in server object commit 83c4387a68cbcb40c151c608d95f1c647be59582 Author: Watts Martin <[email protected]> Date: Wed Jun 15 11:35:31 2016 -0700 Update CLI docs; remove scaling section commit 6683d4b2f7c41167d116426b6d2384f32278395c Author: Watts Martin <[email protected]> Date: Wed Jun 15 11:35:11 2016 -0700 Rearrange examples file commit d512033c64850bc841b0c0134e2dc5fb64108e3a Author: Watts Martin <[email protected]> Date: Wed Jun 15 11:34:47 2016 -0700 Draft frameworks integration document (and rename file) commit 55870a6512e4273f39ccdfb8ddab35e5bf9519f2 Author: Watts Martin <[email protected]> Date: Tue Jun 14 14:58:33 2016 -0700 Document hz make-token; closes rethinkdb#45 commit fba1396d7bcca627269473685c04a28b6bbc58aa Author: Watts Martin <[email protected]> Date: Tue Jun 14 14:15:50 2016 -0700 Integration document placeholder commit 5dddbbd223278c80946ab2ae31b9e7b8d021a702 Author: Watts Martin <[email protected]> Date: Tue Jun 14 14:14:33 2016 -0700 Reorg permissions docs slightly commit b8493a58e8e59de804292366ba2a1b4326489cde Author: Watts Martin <[email protected]> Date: Tue Jun 14 14:14:10 2016 -0700 Typo fix commit 56b8fe32057cafd59312fcb717fe69b23800f78e Author: Watts Martin <[email protected]> Date: Tue Jun 14 14:13:36 2016 -0700 Start CLI documentation
- Loading branch information
Watts Martin
committed
Jun 15, 2016
1 parent
42d405d
commit ddd0519
Showing
6 changed files
with
248 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| --- | ||
| layout: documentation | ||
| title: Embedding Horizon | ||
| id: embed | ||
| permalink: /docs/embed/ | ||
| --- | ||
|
|
||
| While you can start the Horizon server from the `hz` [command line tool][cli], it's also possible to embed it into a Node web app by importing `@horizon/server` and passing a server connection to the Horizon constructor. | ||
|
|
||
| [cli]: /docs/cli | ||
|
|
||
| For instance, using the [Express][] framework, the steps are: | ||
|
|
||
| [express]: http://expressjs.com | ||
|
|
||
| ```js | ||
| #!/usr/bin/env node | ||
| 'use strict' | ||
|
|
||
| const express = require('express'); | ||
| const horizon = require('@horizon/server'); | ||
|
|
||
| const app = express(); | ||
| const http_server = app.listen(8181); | ||
| const options = { auth: { token_secret: 'my_super_secret_secret' } }; | ||
| const horizon_server = horizon(http_server, options); | ||
|
|
||
| console.log('Listening on port 8181.'); | ||
| ``` | ||
|
|
||
| Express and Horizon are required, and Express is instantiated with `app.listen()`. Then the resulting `http_server` object is passed to `horizon` along with an option object. Options that can be passed to the Horizon server constructor are identical to the similarly-named options that can be defined in the [configuration file][cf], with the same defaults: | ||
|
|
||
| * `project_name` | ||
| * `rdb_host`: `'localhost'` | ||
| * `rdb_port`: `28015` | ||
| * `auto_create_collection`: `false` | ||
| * `auto_create_index`: `false` | ||
| * `permissions`: `true` | ||
| * `path`: `'/horizon;` | ||
| * `auth`: | ||
| * `success_redirect`: `'/'` | ||
| * `failure_redirect`: `'/'` | ||
| * `duration`: `'1d'` | ||
| * `create_new_users`: `true` | ||
| * `new_user_group`: `'authenticated'` | ||
| * `token_secret`: `null` | ||
| * `allow_anonymous`: `false` | ||
| * `allow_unauthenticated`: `false` | ||
|
|
||
| **Note:** Passing options to the constructor is the only way to configure the Horizon server when it's embedded. The `.hz/config.toml` configuration file will not be read. | ||
|
|
||
| [cf]: /docs/configuration | ||
|
|
||
| For some examples with other frameworks, including Koa and Hapi, consult the Horizon [examples page][ex]. | ||
|
|
||
| [ex]: /docs/examples | ||
|
|
||
| ## Configuring OAuth providers | ||
|
|
||
| OAuth endpoints cannot be set up through the options passed to the Horizon server constructor. Instead, you'll need to use the `add_auth_provider` method on the instantiated Horizon server object. | ||
|
|
||
| ```js | ||
| // ... initialization code as above for Express | ||
| const horizon_server = horizon(http_server, options); | ||
|
|
||
| horizon_server.add_auth_provider( | ||
| horizon_instance.auth.github, | ||
| { id: 'id', secret: 'secret', path: 'github' } | ||
| ); | ||
| ``` | ||
|
|
||
| For more details on setting up Oauth, read the section in [Authentication][a]. | ||
|
|
||
| [a]: /docs/auth/#oauth | ||
|
|
||
| ## Attaching Horizon to multiple HTTP servers | ||
|
|
||
| It's possible to pass a list of HTTP servers to the Horizon constructor rather than just one. Here's an example script that attaches Horizon to a public HTTPS server on port 8181 and a local HTTP server on port 8282: | ||
|
|
||
| ```js | ||
| 'use strict'; | ||
| const horizon = require('@horizon/server'); | ||
|
|
||
| const fs = require('fs'); | ||
| const http = require('http'); | ||
| const https = require('https'); | ||
|
|
||
| // Attach the horizon server to two http servers | ||
| // one on [::]:8181 over HTTPS and one on 127.0.0.1:8282 over HTTP | ||
| const on_http_request = (req, res) => { | ||
| res.writeHead(404); | ||
| res.end('File not found.'); | ||
| }; | ||
|
|
||
| const public_server = https.createServer({ | ||
| key: fs.readFileSync('key.pem'), | ||
| cert: fs.readFileSync('cert.pem'), | ||
| }, on_http_request); | ||
|
|
||
| const loopback_server = http.createServer(on_http_request); | ||
|
|
||
| public_server.listen(8181); | ||
| loopback_server.listen(8282, '127.0.0.1'); | ||
|
|
||
| const horizon_server = horizon([public_server, loopback_server], { | ||
| project_name: 'foo', | ||
| auth: { | ||
| token_secret: 'bar', | ||
| allow_anonymous: true, | ||
| allow_unauthenticated: true, | ||
| }, | ||
| }); | ||
|
|
||
| // Add Twitch authentication | ||
| horizon_server.add_auth_provider(horizon.auth.twitch, { | ||
| path: 'twitch', | ||
| id: '0000000000000000000000000000000', | ||
| secret: '0000000000000000000000000000000', | ||
| }); | ||
|
|
||
| // Shut down the server after 60 seconds | ||
| setTimeout(() => { | ||
| horizon_server.close(); | ||
| public_server.close(); | ||
| loopback_server.close(); | ||
| }, 60000); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters