https://github.com/ryanj/britemap

https://github.com/ryanj/britemap

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ryanj/britemap
• Owner: ryanj
• Created: 2012-09-20T17:26:55.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2012-09-20T17:28:23.000Z (about 12 years ago)
• Last Synced: 2024-10-11T00:12:57.442Z (about 1 month ago)
• Language: JavaScript
• Size: 109 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

        
Node.js on OpenShift

====================

This git repository helps you get up and running quickly w/ a node.js installation

on OpenShift. 

 

Running on OpenShift

----------------------------

Create an account at http://openshift.redhat.com/

Create a nodejs-0.6 application (you can call your application whatever you want)

    rhc app create -a nodejs -t nodejs-0.6

Add this upstream repo

    cd nodejs

    git remote add upstream -m master git://github.com/openshift/nodejs-example.git

    git pull -s recursive -X theirs upstream master

    # note that the git pull above can be used later to pull updates

Then push the repo upstream

    git push

That's it, you can now checkout your application at:

    http://nodejs-$yournamespace.rhcloud.com

Feel free to change or remove this file, it is informational only.

Repo layout

===========

node_modules/                       - Any Node modules packaged with the app

deplist.txt                         - Deprecated.

package.json                        - npm package descriptor.

.openshift/                         - Location for openshift specific files

.openshift/action_hooks/pre_build   - Script that gets run every git push before

                                      the build

.openshift/action_hooks/build       - Script that gets run every git push as

                                      part of the build process (on the CI

                                      system if available)

.openshift/action_hooks/deploy      - Script that gets run every git push after

                                      build but before the app is restarted

.openshift/action_hooks/post_deploy - Script that gets run every git push after

                                      the app is restarted

Notes about layout

==================

Please leave the node_modules and .openshift directories but feel free to

create additional directories if needed.

Note: Every time you push, everything in your remote repo dir gets recreated

      please store long term items (like an sqlite database) in the OpenShift

      data directory, which will persist between pushes of your repo.

      The OpenShift data directory is accessible relative to the remote repo

      directory (../data) or via an environment variable OPENSHIFT_DATA_DIR.

Environment Variables

=====================

OpenShift provides several environment variables to reference for ease

of use.  The following list are some common variables but far from exhaustive:

    process.env.OPENSHIFT_GEAR_NAME  - Application name

    process.env.OPENSHIFT_GEAR_DIR   - Application dir

    process.env.OPENSHIFT_DATA_DIR  - For persistent storage (between pushes)

    process.env.OPENSHIFT_TMP_DIR   - Temp storage (unmodified files deleted after 10 days)

When embedding a database using 'rhc app cartridge add', you can reference environment

variables for username, host and password:

    process.env.OPENSHIFT_DB_HOST      - DB Host

    process.env.OPENSHIFT_DB_PORT      - DB Port

    process.env.OPENSHIFT_DB_USERNAME  - DB Username

    process.env.OPENSHIFT_DB_PASSWORD  - DB Password

When embedding a NoSQL database using 'rhc app cartridge add', you can reference environment

variables for username, host and password:

    process.env.OPENSHIFT_NOSQL_DB_HOST      - NoSQL DB Host

    process.env.OPENSHIFT_NOSQL_DB_PORT      - NoSQL DB Port

    process.env.OPENSHIFT_NOSQL_DB_USERNAME  - NoSQL DB Username

    process.env.OPENSHIFT_NOSQL_DB_PASSWORD  - NoSQL DB Password

To get a full list of environment variables, simply add a line in your

.openshift/action_hooks/build script that says "export" and push.

deplist.txt

===========

A list of node modules to install, line by line on the server. This will happen

when the user does a git push.

Additional information

======================

Link to additional information will be here, when we have it :)