This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 191b04f6023 Improve local setup documentation (#67247)
191b04f6023 is described below
commit 191b04f6023cfcfe83a1f29100403e70be31aa15
Author: Skander Damergi <[email protected]>
AuthorDate: Mon Jun 22 01:41:47 2026 +0100
Improve local setup documentation (#67247)
* Improve local setup documentation
* Fix markdownlint: blank lines around code blocks and newline at EOF
* Add missing trailing newlines
---
INSTALLING.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/INSTALLING.md b/INSTALLING.md
index c9f4d862d71..6f5673a4693 100644
--- a/INSTALLING.md
+++ b/INSTALLING.md
@@ -23,9 +23,9 @@ This section outlines a recommended approach for setting up a
local development
> ⚠️ Avoid using either system-installed Python or Python from Homebrew, as
> these versions are often labeled `--externally-managed` resulting in
> restricted dependency installation.
-You can use other ways to install Python and airflow. Airflow development
setup requires `uv` and if you want to setup environment for development, `uv`
is the only supported local development environment setup, because we are using
`uv workspace` extensively. See [local virtualenv setup in contributing
docs](https://github.com/apache/airflow/blob/main/contributing-docs/07_local_virtualenv.rst)
for details.
+You can use other ways to install Python and Airflow. The Airflow development
setup requires `uv`. If you want to set up a development environment, `uv` is
the only supported local development environment setup because Airflow uses `uv
workspace` extensively. See [local virtualenv setup in contributing
docs](https://github.com/apache/airflow/blob/main/contributing-docs/07_local_virtualenv.rst)
for details.
-If you are just installing airflow to run it locally, You can use other ways
to set up your Python and virtualenv: `uv` is one of the options (refer to `uv`
documentation), but you can also use more traditional tools - for example
`pyenv`. Note that it is recommended to install airflow with constraints - at
least initially - because this way you can reproducibly install airflow. See
[Installation from
PyPI](https://airflow.apache.org/docs/apache-airflow/stable/installation/installing-fro
[...]
+If you are just installing Airflow to run it locally, you can use other ways
to set up your Python and virtual environment: `uv` is one option (refer to the
`uv` documentation), but you can also use more traditional tools, such as
`pyenv`. Note that installing Airflow with constraints is recommended, at least
initially, because it makes the installation reproducible. See [Installation
from
PyPI](https://airflow.apache.org/docs/apache-airflow/stable/installation/installing-from-pypi.html)
[...]
### ✅ Setup using pyenv:
@@ -70,7 +70,7 @@ source airflow_venv/bin/activate
pip install apache-airflow==3.1.8 --constraint
"https://raw.githubusercontent.com/apache/airflow/constraints-3.1.8/constraints-3.11.txt";
```
-Note that installing with constraints - at least initially - is recommended
for reproducible installation. It might sometimes happen that 3rd-party
distributions are released and their latest versions break airflow. Using
constraints makes the installation reproducible with versions of dependencies
that were "frozen" at the time of releasing airflow. Note you have to specify
both - airflow version and Python version you are using.
+Note that installing with constraints - at least initially - is recommended
for reproducible installation. It might sometimes happen that 3rd-party
distributions are released and their latest versions break airflow. Using
constraints makes the installation reproducible with versions of dependencies
that were "frozen" at the time of releasing airflow. Note you have to specify
both - Airflow version and Python version you are using.
You can also specify additional extras - when you want to install airflow with
additional providers:
@@ -86,7 +86,9 @@ pip install apache-airflow[amazon,google]==3.1.8 --constraint
"https://raw.githu
export AIRFLOW_HOME=~/airflow
```
-7. **Run Airflow in standalone mode**: Apache Airflow runs several components,
like the scheduler, web server, and API server, to manage workflows and show
the UI.
+> **Note:** This command sets `AIRFLOW_HOME` for the current shell session
only. To make it persistent, add the line to your shell profile, such as
`~/.bashrc` or `~/.zshrc`.
+
+7. **Run Airflow in standalone mode**: Apache Airflow runs several components,
such as the scheduler, web server, triggerer, and API server, to manage
workflows and display the UI.
- To run Airflow in standalone mode (which will automatically start the
required components):
@@ -101,3 +103,5 @@ airflow standalone
```text
http://localhost:8080
```
+
+**Note:** The `airflow standalone` command prints the generated username and
password in the terminal on first run. Use these credentials to log in to the
Airflow UI.
