mirror of
https://github.com/aljazceru/CTFd.git
synced 2025-12-17 14:04:20 +01:00
adc70fb320
Alpha release of CTFd v3.
# 3.0.0a1 / 2020-07-01
**General**
- CTFd is now Python 3 only
- Render markdown with the CommonMark spec provided by `cmarkgfm`
- Render markdown stripped of any malicious JavaScript or HTML.
- This is a significant change from previous versions of CTFd where any HTML content from an admin was considered safe.
- Inject `Config`, `User`, `Team`, `Session`, and `Plugin` globals into Jinja
- User sessions no longer store any user-specific attributes.
- Sessions only store the user's ID, CSRF nonce, and an hmac of the user's password
- This allows for session invalidation on password changes
- The user facing side of CTFd now has user and team searching
- GeoIP support now available for converting IP addresses to guessed countries
**Admin Panel**
- Use EasyMDE as an improved description/text editor for Markdown enabled fields.
- Media Library button now integrated into EasyMDE enabled fields
- VueJS now used as the underlying implementation for the Media Library
- Fix setting theme color in Admin Panel
- Green outline border has been removed from the Admin Panel
**API**
- Significant overhauls in API documentation provided by Swagger UI and Swagger json
- Make almost all API endpoints provide filtering and searching capabilities
- Change `GET /api/v1/config/<config_key>` to return structured data according to ConfigSchema
**Themes**
- Themes now have access to the `Configs` global which provides wrapped access to `get_config`.
- For example, `{{ Configs.ctf_name }}` instead of `get_ctf_name()` or `get_config('ctf_name')`
- Themes must now specify a `challenge.html` which control how a challenge should look.
- The main library for charts has been changed from Plotly to Apache ECharts.
- Forms have been moved into wtforms for easier form rendering inside of Jinja.
- From Jinja you can access forms via the Forms global i.e. `{{ Forms }}`
- This allows theme developers to more easily re-use a form without having to copy-paste HTML.
- Themes can now provide a theme settings JSON blob which can be injected into the theme with `{{ Configs.theme_settings }}`
- Core theme now includes the challenge ID in location hash identifiers to always refer the right challenge despite duplicate names
**Plugins**
- Challenge plugins have changed in structure to better allow integration with themes and prevent obtrusive Javascript/XSS.
- Challenge rendering now uses `challenge.html` from the provided theme.
- Accessing the challenge view content is now provided by `/api/v1/challenges/<challenge_id>` in the `view` section. This allows for HTML to be properly sanitized and rendered by the server allowing CTFd to remove client side Jinja rendering.
- `challenge.html` now specifies what's required and what's rendered by the theme. This allows the challenge plugin to avoid having to deal with aspects of the challenge besides the description and input.
- A more complete migration guide will be provided when CTFd v3 leaves beta
- Display current attempt count in challenge view when max attempts is enabled
- `get_standings()`, `get_team_stanadings()`, `get_user_standings()` now has a fields keyword argument that allows for specificying additional fields that SQLAlchemy should return when building the response set.
- Useful for gathering additional data when building scoreboard pages
- Flags can now control the message that is shown to the user by raising `FlagException`
- Fix `override_template()` functionality
**Deployment**
- Enable SQLAlchemy's `pool_pre_ping` by default to reduce the likelihood of database connection issues
- Mailgun email settings are now deprecated. Admins should move to SMTP email settings instead.
- Postgres is now considered a second class citizen in CTFd. It is tested against but not a main database backend. If you use Postgres, you are entirely on your own with regards to supporting CTFd.
- Docker image now uses Debian instead of Alpine. See https://github.com/CTFd/CTFd/issues/1215 for rationale.
- `docker-compose.yml` now uses a non-root user to connect to MySQL/MariaDB
- `config.py` should no longer be editting for configuration, instead edit `config.ini` or the environment variables in `docker-compose.yml`
151 lines
4.7 KiB
ReStructuredText
151 lines
4.7 KiB
ReStructuredText
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. As of CTFd v3, Mailgun integration is deprecated. Installations using the Mailgun API should migrate over to SMTP settings.
|
|
|
|
MAILGUN_BASE_URL
|
|
~~~~~~~~~~~~~~~~
|
|
Mailgun base url to send email over Mailgun. As of CTFd v3, Mailgun integration is deprecated. Installations using the Mailgun API should migrate over to SMTP settings.
|
|
|
|
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 <https://werkzeug.palletsprojects.com/en/0.15.x/middleware/proxy_fix/#werkzeug.middleware.proxy_fix.ProxyFix.>`_ 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
|
|
|
|
SERVER_SENT_EVENTS
|
|
~~~~~~~~~~~~~~~~~~
|
|
Specifies whether or not to enable to server-sent events based Notifications system.
|
|
|
|
OAUTH_CLIENT_ID
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
OAUTH_CLIENT_SECRET
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
Application Level Configuration
|
|
------------------------------- |