Configuration

Setting up your configuration

You can specify Jet Bridge configuration through one of the following methods: command-line arguments, config files, or environment variables. Here are examples:

Method 1. Command-line arguments

Warning: The argument's name should be lowercase. Other methods are case-insensitive

jet_bridge --database_engine=postgresql \
    --database_host=localhost \
    --database_port=5432 \
    --database_user=user \
    --database_password=password \
    --database_name=mydb

Method 2. Config file

jet.ini

[JET]
DATABASE_ENGINE=postgresql
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=mydb
DATABASE_USER=user
DATABASE_PASSWORD=password

Method 3. Environment variables

DATABASE_ENGINE=postgresql \
    DATABASE_HOST=localhost \
    DATABASE_PORT=5432 \
    DATABASE_NAME=mydb \
    DATABASE_USER=user \
    DATABASE_PASSWORD=password \
    jet_bridge

Method 4. settings.py (Django package)

# For Django package database settings are taken from 
# DATABASES['default'] setting so you don't need to specify it.
JET_JWT_VERIFY_KEY='YOUR_CUSTOM_JWT_VERIFY_KEY'

All available settings

Required settings

Name	Description
DATABASE_ENGINE	Database engine, one of: postgresql mysql oracle mssql+pyodbc sqlite none
DATABASE_HOST	Database host
DATABASE_PORT	Database port
DATABASE_USER	Database user
DATABASE_PASSWORD	Database password
DATABASE_NAME	Database name or path (SQLite)

Optional settings

Name	Default	Description
ADDRESS (optional)	0.0.0.0	Jet Bridge address
PORT (optional)	8888	Jet Bridge port
SSL_CERT (optional)	-- none --	File path to SSL certificate
SSL_KEY (optional)	-- none --	File path to SSL private key
CONFIG (optional)	/etc/jet.conf	Path to config file
DEBUG (optional)	false	Run in debug mode
READ_ONLY (optional)	false	Data read only
BASE_URL (optional)	https://example.com/	Jet Bridge base URL
WEB_BASE_URL (optional)	https://app.jetadmin.io	Jet Admin frontend application base URL
API_BASE_URL (optional)	https://api.jetadmin.io/api	Jet Admin API base URL
MEDIA_STORAGE (optional)	default	Media storage type
MEDIA_ROOT (optional)	media	Media root
MEDIA_BASE_URL (optional)	-- none --	Media base URL
COOKIE_SAMESITE (optional)	None	Cookie Samesite attribute
COOKIE_SECURE (optional)	true	Is host with HTTPS
COOKIE_DOMAIN (optional)	-- none --	Cookie domain
COOKIE_COMPRESS (optional)	false	GZIP cookies that may be large in size
THREADS (optional)	number of CPUs	Number of threads Jet Bridge will create to serve requests
CORS_HEADERS (optional)	true	Specifies if Jet Bridge should automatically add CORS headers or want to add them on your own
JWT_VERIFY_KEY (optional)	See Validate JWT Token	JWT public key to verify user requests