Malin/krawl.es
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: update README to correct section titles and improve clarity

Browse Source
This commit is contained in:
Lorenzo Venerandi
2026-03-10 11:00:37 +01:00
parent 9fde3f49be
commit 467379d3f7
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -43,7 +43,7 @@
- [Docker Run](#docker-run) - [Docker Run](#docker-run)
- [Docker Compose](#docker-compose) - [Docker Compose](#docker-compose)
- [Kubernetes](#kubernetes) - [Kubernetes](#kubernetes)
- [Local (Python)](#local-python) - [Uvicorn (Python)](#uvicorn-python)
- [Configuration](#configuration) - [Configuration](#configuration)
- [config.yaml](#configuration-via-configyaml) - [config.yaml](#configuration-via-configyaml)
- [Environment Variables](#configuration-via-enviromental-variables) - [Environment Variables](#configuration-via-enviromental-variables)
@@ -139,6 +139,7 @@ services:
environment: environment:
- CONFIG_LOCATION=config.yaml - CONFIG_LOCATION=config.yaml
- TZ=Europe/Rome - TZ=Europe/Rome
# - KRAWL_DASHBOARD_SECRET_PATH="/my-secret-dashboard"
# - KRAWL_DASHBOARD_PASSWORD=my-secret-password # - KRAWL_DASHBOARD_PASSWORD=my-secret-password
volumes: volumes:
- ./config.yaml:/app/config.yaml:ro - ./config.yaml:/app/config.yaml:ro
@@ -166,7 +167,7 @@ docker-compose down
### Kubernetes ### Kubernetes
**Krawl is also available natively on Kubernetes**. Installation can be done either [via manifest](kubernetes/README.md) or [using the helm chart](helm/README.md). **Krawl is also available natively on Kubernetes**. Installation can be done either [via manifest](kubernetes/README.md) or [using the helm chart](helm/README.md).
### Python + Uvicorn ### Uvicorn (Python)
Run Krawl directly with Python (suggested version 13) and uvicorn for local development or testing: Run Krawl directly with Python (suggested version 13) and uvicorn for local development or testing: