Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
67 lines (53 sloc) 2.97 KB
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 - List of npm modules to install
.nodejs.env - Configuration file to setup environment
and pass command line parameters to Node
.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 ../data which will
persist between pushes of your repo.
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 :)
Jump to Line
Something went wrong with that request. Please try again.