Skip to content

zzEnvironment Variables declared in settings.py

Jump to bottom
Jace Manshadi edited this page Nov 23, 2023 · 1 revision

General Environment Variables

BASE_DIR :

  • indicates the location of the db.sqlit3 file is the user chooses to use sqlite3 as their database
  • indicates the location of the STATIC_ROOT directory.
    • this is the location of files such as any JavaScript files used. It is also contains the soft link that points to the repository for the exec-photos that are used on the list of officers page and the repository that contains some of our photos from our events, event-photos.
  • indicates the location of the MEDIA_ROOT directory:
    • contains the attachments from any announcements on the index page. Also contains the files that were uploaded using the upload page under "Documents" tab

WEBSITE_SECRET_KEY : used to create the website hashes

DEBUG : will display a more in-depth answer when an error occurs if set to true which exposes sensitive information.

HOST_ADDRESS : dictates what hostnames can be used to access the website. Examples of what it is usually set to include sfucsss.org [when being run from PRODUCTION] and 127.0.0.1 [when being run locally]

DB_TYPE: allows the user to either use a lightweight sqlite3 database [by specifying sqlite3] or use a docker-based postgresql database [by specifying postgres

Google Drive Management Environment Variables

GDRIVE_ROOT_FOLDER_ID : the id for the parent folder CSSS on the SFU CSSS google drive. this will be the default file id that is given to new officers when an alternate file id is not specified.

GDRIVE_TOKEN_LOCATION: the token.picke file that contains the credential information needed to authenticate against Google Drive API

Github Management Environment Variable

GITHUB_ACCESS_TOKEN : the access token used to authenticate against github and grant new officers or even non-officers their necessary permissions.

Officer Profile Environment Variable

PORT : when using the website locally, the address contains the port 8000 in it. As a result, in order for the page that creates the links that are then given to the new officers to have their info inputted on the site, are invalid as the website does not know to add a port. This only effecs individuals who are locally testing that officer generation link page.

EXEC_PHOTOS_PATH : the location that contains the repository that has the images of the officers that is used on the list_of_officers page.

Clone this wiki locally