This is an automated email from the ASF dual-hosted git repository. asorokoumov pushed a commit to branch docs/121 in repository https://gitbox.apache.org/repos/asf/otava.git
commit f99c7a2fff5ac54d0a49a1c909c526a1abe89d28 Author: Alex Sorokoumov <[email protected]> AuthorDate: Mon Jan 26 18:19:10 2026 -0800 Update install guide --- docs/GETTING_STARTED.md | 14 +++++++++----- docs/INSTALL.md | 24 ++++++------------------ 2 files changed, 15 insertions(+), 23 deletions(-) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index a1bb572..5a5b145 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -21,15 +21,19 @@ ## Installation -Otava requires Python 3.8. If you don't have python 3.8, -use pyenv to install it. +Otava requires Python 3.10 or later. -Use pipx to install otava: - -``` +```bash pip install apache-otava ``` +or + +```bash +docker pull apache/otava +``` + + ## Setup Copy the main configuration file `resources/otava.yaml` to `~/.otava/otava.yaml` and adjust data source configuration. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 3695485..1844f89 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -19,30 +19,18 @@ # Installation -## Install using pipx +## Install using pip -Otava requires Python 3.8. If you don't have python 3.8, use pyenv to install it. +Otava requires Python 3.10 or later. -Use pip to install otava: - -``` +```bash pip install apache-otava ``` -## Build Docker container +## Install using Docker -To build the Docker container, run the following command: +Pull the official Docker image: ```bash -docker build -t otava . +docker pull apache/otava ``` - -> [!NOTE] -> The Dockerfile contains a `--mount` option that requires BuildKit [^1]. -> The BuildKit can be installed with the following commands: -> -> Debian and Ubuntu: `apt install -y docker-buildx` -> -> Fedora: `dnf install docker-buildx` -> -> [^1]: https://docs.docker.com/go/buildkit/
