Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.56 KB

File metadata and controls

53 lines (31 loc) · 2.56 KB

Environment Variables

To assist with configuration (and to avoid pushing API keys to this repo) the server can be configrured entirely with environment variables.

General

IP - the IP address you want the app to listen on for requests (typically 0.0.0.0 for all addresses)

PORT - the port you want the app to listen on.

FQDN - the fully qualified domain name of the server e.g. myapp.com or localhost for local testing. Used for API callbacks, so ensure this matches your API configuration!

Database

CLEARDB_DATABASE_URL - a MySQL URL for the app to use - e.g. mysql://user.password@dbhostname.com/databasename Can be used in place of configuring other MySQL variables.

DATABSE_HOST - the hostname of the databse to connect to (for devlopment, this is probably localhost).

DATABASE_USER - the user to connect to the DB as.

DATABASE_PASSWORD - the databse user's password.

DATABASE_NAME - the name of the databse to connect to (if you SOURCE databse_schema/databse_implementation.sql to configure the DB, this will be txstexe).

API Keys / Authentication

Facebook (for Facebook logins)

FB_CLIENTID - the Facebook application's client ID, obtained from https://developers.facebook.com/apps/

FB_CLIENTSECRET - the secret for your Facebook app

Google (for calendar functions)

GOOGLE_CALENDAR_ID - The name of the calendar to use for the event adds feature.

GOOGLE_CLIENT_EMAIL - The name of the account that will post to the calendar. Must be granted edit permissions to the calendar.

GOOGLE_CLIENT_PK - A PKCS12 private key used for authenticating the account.

These can all be obtained from the Google Developer Console at https://console.developers.google.com/projectselector/permissions/serviceaccounts - you will need to generate a service account and download the file it provides you, then use that to configure the variables OR save the file as google-svc-auth.json and the app will automatically load in the values - no environment variables needed.

Paypal

PAYPAL_MODE - Either live or sandbox, depending if the server is in production. Should only need sandbbox for development (defualt).

PAYPAL_ID - The ID of the merchant account that will be recieving Paypal payments.

PAYPAL_SECRET - The secret for the merchant account, obtainable from https://developer.paypal.com/developer/applications/`

Stripe (for card payments)

STRIPE_SECRET - Your Stripe secret key.

STRIPE_PUBLIC - Yuor publishable Stripe key.

Mailchimp

MAILCHIMP_API - Your Mailchimp API Key.

MAILCHIMP_LIST - The list ID to add signups to.