Skip to content

Remove flask application configuration from docs for AF3 #49393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amoghrajesh merged 2 commits into from
Apr 21, 2025
Merged

Remove flask application configuration from docs for AF3 #49393

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c902bb4
Remove flask application configuration from docs for AF3
amoghrajesh Apr 17, 2025
c9be03f
remove line
amoghrajesh Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions airflow-core/docs/howto/set-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,27 +196,3 @@ Example settings you can configure this way:
* :ref:`Customize your UI <customizing-the-ui>`
* :ref:`Configure more variables to export <export_dynamic_environment_variables>`
* :ref:`Customize your DB configuration <set-up-database-backend>`


Configuring Flask Application for Airflow Webserver
===================================================

Airflow uses Flask to render the web UI. When you initialize the Airflow webserver, predefined configuration
is used, based on the ``webserver`` section of the ``airflow.cfg`` file. You can override these settings
and add any extra settings however by adding flask configuration to ``webserver_config.py`` file in your
``$AIRFLOW_HOME`` directory. This file is automatically loaded by the webserver.

For example if you would like to change rate limit strategy to "moving window", you can set the
``RATELIMIT_STRATEGY`` to ``moving-window``.

You could also enhance / modify the underlying flask app directly,
as the `app context <https://flask.palletsprojects.com/en/2.3.x/appcontext/>`_ is pushed to ``webserver_config.py``:

.. code-block:: python

from flask import current_app as app


@app.before_request
def print_custom_message() -> None:
print("Executing before every request")