This repository has been archived by the owner on Nov 3, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Eran Hammer-Lahav
committed
Sep 1, 2011
1 parent
8181b3d
commit 41b13a6
Showing
7 changed files
with
230 additions
and
220 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| config.js | ||
|
|
||
| .nide |
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 @@ | ||
| .nide |
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 |
|---|---|---|
| @@ -1,24 +1,24 @@ | ||
| Copyright (c) 2011, Yahoo, Inc. | ||
| All rights reserved. | ||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
| * Redistributions of source code must retain the above copyright | ||
| notice, this list of conditions and the following disclaimer. | ||
| * Redistributions in binary form must reproduce the above copyright | ||
| notice, this list of conditions and the following disclaimer in the | ||
| documentation and/or other materials provided with the distribution. | ||
| * Neither the name of Yahoo! Inc. nor the | ||
| names of its contributors may be used to endorse or promote products | ||
| derived from this software without specific prior written permission. | ||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
| ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY | ||
| DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
| ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| Copyright (c) 2011, Yahoo, Inc. | ||
| All rights reserved. | ||
|
|
||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
| * Redistributions of source code must retain the above copyright | ||
| notice, this list of conditions and the following disclaimer. | ||
| * Redistributions in binary form must reproduce the above copyright | ||
| notice, this list of conditions and the following disclaimer in the | ||
| documentation and/or other materials provided with the distribution. | ||
| * Neither the name of Yahoo! Inc. nor the | ||
| names of its contributors may be used to endorse or promote products | ||
| derived from this software without specific prior written permission. | ||
|
|
||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
| ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY | ||
| DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
| ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
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 |
|---|---|---|
| @@ -1,93 +1,93 @@ | ||
| Postmile is a collaborative list making tool built using JS, Node.js, and MongoDB. | ||
|
|
||
| # Installation | ||
|
|
||
| Postmile consists of an api server and a web server, both running using Node.js. The two servers can run on the same machine or different machines. | ||
| The following is based on a shared machine. | ||
|
|
||
| ```bash | ||
| $ git clone git@github.com:hueniverse/postmile.git | ||
| $ cd postmile | ||
| $ cp config.js.example config.js | ||
| ``` | ||
|
|
||
| Edit postmile/config.js with your preferences and configuration. | ||
|
|
||
| ```bash | ||
| $ cd api | ||
| $ cp vault.js.example vault.js | ||
| ``` | ||
|
|
||
| Edit postmile/api/vault.js and set the values of the 'aes256Key' variables to different random secrets sufficiently long (e.g. 40 characters). | ||
|
|
||
| If your MongoDB requires authentication, set the values of the database 'username' and 'password' (otherwise leave empty). | ||
|
|
||
| ```bash | ||
| $ npm update | ||
| $ node install | ||
|
|
||
| 110827/005720.948, info, Database initialized | ||
| 110827/005720.952, info, Initial dataset created successfully | ||
| 110827/005720.952, info, >>>>> postmile.web client secret: __some__secret__ | ||
| ``` | ||
|
|
||
| Copy the postmile.web client secret and save it for later. | ||
|
|
||
| ```bash | ||
| $ cd ../web | ||
| $ npm update | ||
| $ cp vault.js.example vault.js | ||
| ``` | ||
|
|
||
| Edit postmile/web/vault.js and set the values of the 'aes256Key' variables to different random secrets sufficiently long (e.g. 40 characters). | ||
|
|
||
| Set the value of the postmileAPI 'clientSecret' variable to the client secret saved earlier. | ||
|
|
||
| Enter at least one third-party API credentials (Twitter, Facebook, or Yahoo!) as received from each provider when you registered the application. | ||
| If asked, the callback URI is your web server configuration entered above with the path '/auth/twitter', '/auth/facebook', or '/auth/yahoo'. | ||
| For example, if you configured your web server to run on '127.0.0.1', port '8000', using the 'http' scheme, and you are using Twitter, your | ||
| callback URI is http://127.0.0.1:8000/auth/twitter. | ||
|
|
||
| ```bash | ||
| $ cd .. | ||
| ``` | ||
|
|
||
| Make sure to protect your vault.js files. If an attacker gets hold of them, you're screwed. | ||
| If you are going to run this in a production environment, you should use TLS (HTTPS) for the web server (otherwise it's cookies and OAuth 2.0 bits are | ||
| pretty open for attacks). To configure TLS, set the 'process.web.tls' variable in the postmile/config.js file to point to your TLS key and certificate. | ||
|
|
||
| # Startup | ||
|
|
||
| To start both servers at the same time in the same process (combined log output): | ||
|
|
||
| ```bash | ||
| $ node postmile | ||
| ``` | ||
|
|
||
| To start each server individually: | ||
|
|
||
| ```bash | ||
| $ node api/index & | ||
| $ node web/index & | ||
| ``` | ||
|
|
||
| Now point your browser at the web server address and start using Postmile. | ||
|
|
||
| # Credits | ||
|
|
||
| [Eran Hammer-Lahav](http://hueniverse.com) - Concept and server-side components | ||
|
|
||
| [Lance Welsh](https://github.com/lpw) - 'view' web client | ||
|
|
||
| Axel Albin-Lax, Josh Kamler, and Bryan Chen - UX/UI design, Snowy web client theme | ||
|
|
||
| [Emmanuel Crouvisier](https://github.com/emcro) - 'view' web client CSS/HTML | ||
|
|
||
| [Chris Carrasco](http://chriscarrasco.com/) - Original artwork | ||
|
|
||
| # History | ||
|
|
||
| Postmile is based on the discontinued experimental Yahoo! Sled project initially published at: https://github.com/yahoo/postmile. | ||
|
|
||
|
|
||
|
|
||
| Postmile is a collaborative list making tool built using JS, Node.js, and MongoDB. | ||
|
|
||
| # Installation | ||
|
|
||
| Postmile consists of an api server and a web server, both running using Node.js. The two servers can run on the same machine or different machines. | ||
| The following is based on a shared machine. | ||
|
|
||
| ```bash | ||
| $ git clone git@github.com:hueniverse/postmile.git | ||
| $ cd postmile | ||
| $ cp config.js.example config.js | ||
| ``` | ||
|
|
||
| Edit postmile/config.js with your preferences and configuration. | ||
|
|
||
| ```bash | ||
| $ cd api | ||
| $ cp vault.js.example vault.js | ||
| ``` | ||
|
|
||
| Edit postmile/api/vault.js and set the values of the 'aes256Key' variables to different random secrets sufficiently long (e.g. 40 characters). | ||
|
|
||
| If your MongoDB requires authentication, set the values of the database 'username' and 'password' (otherwise leave empty). | ||
|
|
||
| ```bash | ||
| $ npm update | ||
| $ node install | ||
|
|
||
| 110827/005720.948, info, Database initialized | ||
| 110827/005720.952, info, Initial dataset created successfully | ||
| 110827/005720.952, info, >>>>> postmile.web client secret: __some__secret__ | ||
| ``` | ||
|
|
||
| Copy the postmile.web client secret and save it for later. | ||
|
|
||
| ```bash | ||
| $ cd ../web | ||
| $ npm update | ||
| $ cp vault.js.example vault.js | ||
| ``` | ||
|
|
||
| Edit postmile/web/vault.js and set the values of the 'aes256Key' variables to different random secrets sufficiently long (e.g. 40 characters). | ||
|
|
||
| Set the value of the postmileAPI 'clientSecret' variable to the client secret saved earlier. | ||
|
|
||
| Enter at least one third-party API credentials (Twitter, Facebook, or Yahoo!) as received from each provider when you registered the application. | ||
| If asked, the callback URI is your web server configuration entered above with the path '/auth/twitter', '/auth/facebook', or '/auth/yahoo'. | ||
| For example, if you configured your web server to run on '127.0.0.1', port '8000', using the 'http' scheme, and you are using Twitter, your | ||
| callback URI is http://127.0.0.1:8000/auth/twitter. | ||
|
|
||
| ```bash | ||
| $ cd .. | ||
| ``` | ||
|
|
||
| Make sure to protect your vault.js files. If an attacker gets hold of them, you're screwed. | ||
| If you are going to run this in a production environment, you should use TLS (HTTPS) for the web server (otherwise it's cookies and OAuth 2.0 bits are | ||
| pretty open for attacks). To configure TLS, set the 'process.web.tls' variable in the postmile/config.js file to point to your TLS key and certificate. | ||
|
|
||
| # Startup | ||
|
|
||
| To start both servers at the same time in the same process (combined log output): | ||
|
|
||
| ```bash | ||
| $ node postmile | ||
| ``` | ||
|
|
||
| To start each server individually: | ||
|
|
||
| ```bash | ||
| $ node api/index & | ||
| $ node web/index & | ||
| ``` | ||
|
|
||
| Now point your browser at the web server address and start using Postmile. | ||
|
|
||
| # Credits | ||
|
|
||
| [Eran Hammer-Lahav](http://hueniverse.com) - Concept and server-side components | ||
|
|
||
| [Lance Welsh](https://github.com/lpw) - 'view' web client | ||
|
|
||
| Axel Albin-Lax, Josh Kamler, and Bryan Chen - UX/UI design, Snowy web client theme | ||
|
|
||
| [Emmanuel Crouvisier](https://github.com/emcro) - 'view' web client CSS/HTML | ||
|
|
||
| [Chris Carrasco](http://chriscarrasco.com/) - Original artwork | ||
|
|
||
| # History | ||
|
|
||
| Postmile is based on the discontinued experimental Yahoo! Sled project initially published at: https://github.com/yahoo/postmile. | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.