Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
147 lines (104 sloc) 4.32 KB

Configuration

CTFd provides a number of configuration options which are used to configure server behavior. CTFd makes a distinction between configuration values which can be configured only with server-level access and values which can be configured by those with administrative priveleges on CTFd.

Server Level Configuration

Server level configuration can be modified from the config.py file in CTFd.

SECRET_KEY

The secret value used to creation sessions and sign strings. This should be set to a random string. In the interest of ease, CTFd will automatically create a secret key file for you. If you wish to add this secret key to your instance you should hard code this value to a random static value.

You can also remove .ctfd_secret_key from the .gitignore file and commit this file into whatever repository you are using.

http://flask.pocoo.org/docs/latest/quickstart/#sessions

DATABASE_URL

The URI that specifies the username, password, hostname, port, and database of the server used to hold the CTFd database.

e.g. mysql+pymysql://root:<YOUR_PASSWORD_HERE>@localhost/ctfd

REDIS_URL

The URI to connect to a Redis server.

e.g. redis://user:password@localhost:6379

http://pythonhosted.org/Flask-Caching/#configuring-flask-caching

MAILFROM_ADDR

The email address that emails are sent from if not overridden in the configuration panel.

MAIL_SERVER

The mail server that emails are sent from if not overriden in the configuration panel.

MAIL_PORT

The mail port that emails are sent from if not overriden in the configuration panel.

MAIL_USEAUTH

Whether or not to use username and password to authenticate to the SMTP server

MAIL_USERNAME

The username used to authenticate to the SMTP server if MAIL_USEAUTH is defined

MAIL_PASSWORD

The password used to authenticate to the SMTP server if MAIL_USEAUTH is defined

MAIL_TLS

Whether to connect to the SMTP server over TLS

MAIL_SSL

Whether to connect to the SMTP server over SSL

MAILGUN_API_KEY

Mailgun API key to send email over Mailgun

MAILGUN_BASE_URL

Mailgun base url to send email over Mailgun

LOG_FOLDER

The location where logs are written. These are the logs for CTFd key submissions, registrations, and logins. The default location is the CTFd/logs folder.

UPLOAD_PROVIDER

Specifies the service that CTFd should use to store files.

UPLOAD_FOLDER

The location where files are uploaded. The default destination is the CTFd/uploads folder.

AWS_ACCESS_KEY_ID

AWS access token used to authenticate to the S3 bucket.

AWS_SECRET_ACCESS_KEY

AWS secret token used to authenticate to the S3 bucket.

AWS_S3_BUCKET

The unique identifier for your S3 bucket.

AWS_S3_ENDPOINT_URL

A URL pointing to a custom S3 implementation.

REVERSE_PROXY

Specifies whether CTFd is behind a reverse proxy or not. Set to True if using a reverse proxy like nginx.

See Flask documentation for full details.

Tip

You can also specify a comma seperated set of numbers specifying the reverse proxy configuration settings. For example to configure x_for=1, x_proto=1, x_host=1, x_port=1, x_prefix=1 specify 1,1,1,1,1. By setting the value to True, CTFd will default to the above behavior with all proxy settings set to 1.

TEMPLATES_AUTO_RELOAD

Specifies whether Flask should check for modifications to templates and reload them automatically.

SQLALCHEMY_TRACK_MODIFICATIONS

Automatically disabled to suppress warnings and save memory. You should only enable this if you need it.

SWAGGER_UI

Enable the Swagger UI endpoint at /api/v1/

UPDATE_CHECK

Specifies whether or not CTFd will check whether or not there is a new version of CTFd

APPLICATION_ROOT

Specifies what path CTFd is mounted under. It can be used to run CTFd in a subdirectory. Example: /ctfd

OAUTH_CLIENT_ID

OAUTH_CLIENT_SECRET

Application Level Configuration

You can’t perform that action at this time.