Global Variables#

B-Fabric Web Apps provide a set of global variables that can be customized by users to adapt the application's behavior to specific needs. These variables control aspects such as configuration file paths, email addresses for support, server settings, and the development environment state.

This chapter explains how to modify these variables and where they are stored.

List of Global Variables#

The following global variables can be modified in B-Fabric Web Apps:

Variable	Default Value	Description
REDIS_HOST	"localhost"	Hostname for the Redis server used by the application.
REDIS_PORT	6379	Port number for the Redis server.
REDIS_USERNAME	None	Optional Redis username. Remove this line from `.env` if not used.
REDIS_PASSWORD	None	Optional Redis password. Remove this line from `.env` if not used.
CONFIG_FILE_PATH	"~/.bfabricpy.yml"	Path to the configuration file used by the application.
HOST	"127.0.0.1"	The IP address where the Dash app is hosted.
PORT	8050	The port number used by the Dash server.
DEBUG	False	Enables verbose logging for debugging purposes.
DEVELOPER_EMAIL_ADDRESS	"griffin@gwcustom.com"	Email address for development-related inquiries.
BUG_REPORT_EMAIL_ADDRESS	"gwtools@fgcz.system"	Email address for submitting bug reports.
GSTORE_REMOTE_PATH	"/path/to/remote/gstore"	Path to the remote gstore location (FGCZ-specific).
SCRATCH_PATH	"/scratch/folder"	Path to the scratch directory available for intermediate data processing steps. This directory should exist before invoking the app.
TRX_LOGIN	"trxcopy@fgcz-server.uzh.ch"	SSH login used for transferring files (FGCZ-specific).
TRX_SSH_KEY	"/home/user/.ssh/your_ssh_key"	Path to the SSH key used for secure file transfer (FGCZ-specific).
URL	"https://fgcz/dummy/url"	The base URL where report attachments will be made available via HTTPS.
SERVICE_ID	0	The ID of the service to charge the container when running the app.
DATASET_TEMPLATE_ID	0	The dataset template ID of the output dataset that your app creates.

How to Modify Global Variables#

Global variables should be set in a file named .env in the root directory of your project. Please refer to the example file .env.example in the template repository for guidance.

Note: If your Redis server does not require authentication, remove the following lines from your .env file:
REDIS_USERNAME=your_redis_username
REDIS_PASSWORD=your_redis_password

Alternatively, you can edit these variables directly within your application, as shown below.

Customize Redis Settings#

bfabric_web_apps.REDIS_HOST = "redis-server"
bfabric_web_apps.REDIS_PORT = 6380
bfabric_web_apps.REDIS_USERNAME = "your_redis_username"  # Optional
bfabric_web_apps.REDIS_PASSWORD = "your_redis_password"  # Optional

Change the Configuration File Path#

bfabric_web_apps.CONFIG_FILE_PATH = "~/custom_config.yml"

Change Host and Port Settings#

bfabric_web_apps.HOST = "127.0.0.1"
bfabric_web_apps.PORT = 8080

Enable Development or Debug Mode#

bfabric_web_apps.DEBUG = True

Update Developer Email Address#

bfabric_web_apps.DEVELOPER_EMAIL_ADDRESS = "support@mydomain.com"

Update Bug Report Email Address#

bfabric_web_apps.BUG_REPORT_EMAIL_ADDRESS = "bugs@mydomain.com"

Update FGCZ-specific Settings#

bfabric_web_apps.GSTORE_REMOTE_PATH = "/new/gstore/path"
bfabric_web_apps.TRX_LOGIN = "trxcopy@new-server"
bfabric_web_apps.TRX_SSH_KEY = "/home/user/.ssh/other_key"
bfabric_web_apps.URL = "https://new.url/path"

Change the Scratch Directory#

bfabric_web_apps.SCRATCH_PATH = "/new/scratch"

Change the Service ID#

bfabric_web_apps.SERVICE_ID = 123

Change the Dataset Template ID#

bfabric_web_apps.DATASET_TEMPLATE_ID = 5

Navigation Bar