-
Notifications
You must be signed in to change notification settings - Fork 87
Configure Environment Variables
skyhit edited this page Feb 27, 2014
·
5 revisions
The following scripts are used to ease the deployment and launching of the application for different environments:
Local development on Linux: /deploy/development.sh
Local development on Windows: /deploy/development.bat
Continuous integration: /deploy/ci.sh
Heroku: /deploy/heroku.sh
Normally, you don't need to set update the above scripts files, you just need to map the ip to informix.cloud.topcoder.com in hosts file, or set the environment variable (TC_VM_IP) before executing the script file for your environment.
These variables are used to configure the endpoint of the TC API.
| Variable Name | Description | Comment |
|---|---|---|
| TC_API_HOST | the name/ip of the host on which this application will run | default is api.topcoder.com |
| PORT | the port on which this application will run | default is 8080 |
These variables are used to configure OAuth.
| Variable Name | Description | Comment |
|---|---|---|
| OAUTH_CLIENT_ID | the oauth client id | the client identifier issued by the authorization server |
| OAUTH_CLIENT_SECRET | the oauth secret | client secret issued by the authorization server |
| OAUTH_CONNECTION | the oauth connection | default is vm-ldap-connection |
| OAUTH_DOMAIN | the oauth domain | default is sma |
| AUTH_MIDDLEWARE_CACHE_EXPIRY | the authorization cache lifetime | expressed in milliseconds |
These are the LDAP settings.
| Variable Name | Description | Comment |
|---|---|---|
| TC_LDAP_HOST | domain or ip address of the machine on which ldap is installed | this can be VM ip address or production database ip address. if TC_VM_IP is set then it uses it's value. default is informix.cloud.topcoder.com |
| TC_LDAP_PORT | the port on which ldap is installed | default is 636 |
| TC_LDAP_PASSWORD | the ldap password | default is secret |
| TC_LDAP_MEMBER_BASE_DN | the dn in which the member information is stored | default is "ou=members, dc=topcoder, dc=com" |
| TC_BIND_DN | the ldap bind dn | default is cn=Manager,dc=topcoder,dc=com |
| DEFAULT_PASSWORD | the default password for registration using social | default to defaultpass |
These are the JIRA credentials.
| Variable Name | Description | Comment |
|---|---|---|
| JIRA_USERNAME | the jira username for accessing jira soap service | |
| JIRA_PASSWORD | the jira password for accessing jira soap service |
These variables are used to configure member activation (email settings, activation server etc.).
| Variable Name | Description | Comment |
|---|---|---|
| TC_EMAIL_HOST | domain or ip address of the email host | default is smtp.gmail.com |
| TC_EMAIL_HOST_PORT | the email service port | default is 465 |
| TC_EMAIL_SECURED | flag indication if a secure connection should be used when sending emails | default is true |
| TC_EMAIL_ACCOUNT | the email account used for sending emails | default is [email protected] |
| TC_EMAIL_PASSWORD | the email account password | default is tc_public_email |
| TC_EMAIL_FROM | the email account that should appear as "from" | default is [email protected] |
| TC_EMAIL_TEMPLATE_DIR | the email template folder | default is mail_templates (relative to the project folder) |
| TC_ACTIVATION_SERVER_NAME | the base url of the TC member activation server | default is https://www.topcoder.com |
These variables are only used in tests.
| Variable Name | Description | Comment |
|---|---|---|
| API_ENDPOINT | the endpoint of this API | used for tests, default is http://localhost:8080 |
These variables are used to configure debugging for this application.
| Variable Name | Description | Comment |
|---|---|---|
| DISABLE_CONSOLE_LOG | flag indicating if console logging should be disabled | default is false |
These variables are used to configure password encryption.
| Variable Name | Description | Comment |
|---|---|---|
| PASSWORD_HASH_KEY | a Blowfish key for encrypting/decrypting passwords | base 64 encoded |
These variables are used to configure the DB connections.
| Variable Name | Description | Comment |
|---|---|---|
| TC_DB_HOST | domain or ip address of the machine on which informix database is installed (used for ) | this can be VM ip address or production database ip address. if TC_VM_IP is set then it uses it's value. default is informix.cloud.topcoder.com |
| TC_DB_PORT | the port on which informix database is installed | default is 2021 |
| TC_DB_USER | the informix user | default is informix |
| TC_DB_PASSWORD | the informix user's password | default is 1nf0rm1x |
| TC_DB_NAME | the informix server name | default is informixoltp_tcp |
| TC_DW_HOST | domain or ip address of the datawarehouse machine on which informix database is installed (used for ) | this can be VM ip address or production database ip address. if TC_VM_IP is set then it uses it's value. default is informix.cloud.topcoder.com |
| TC_DW_PORT | the port on which informix database is installed on datawarehouse machine | default is 2021 |
| TC_DW_USER | the informix user on the datawarehouse machine | default is informix |
| TC_DW_PASSWORD | the informix user's password on the datawarehouse machine | default is 1nf0rm1x |
| TC_DW_NAME | the informix server name on the datawarehouse machine | default is informixoltp_tcp |
| MINPOOL | the minimum number of connections to DB available for use | default is 1 |
| MAXPOOL | the maximum number of connections to DB available for use | default is 60 |
| MAXSIZE | the maximum number of connections that can be obtained to DB | default is 0 (an unlimited number of connections can be obtained) |
| IDLETIMEOUT | the idle timeout for connections | default is 3600 (seconds) |
| TIMEOUT | the timeout for connections | default is 30000 (miliseconds) |