From 09443286b52c74874175768359cf9e9903099ec7 Mon Sep 17 00:00:00 2001 From: Luc Didry Date: Thu, 25 Apr 2024 14:08:52 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20=E2=80=94=20Update=20doc=20for?= =?UTF-8?q?=20release=20(fix=20#33)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/cli.md | 22 +++++++++++++--------- docs/installation/getting-started.md | 23 ----------------------- 2 files changed, 13 insertions(+), 32 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 9f5966c..be7b0ec 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -78,9 +78,9 @@ Options: Commands: cleandb Clean the database (to run routinely) - generate-token Generate a token, which can be used as an agent’s... + generate-token Generate a token for agents migrate Run database migrations - reload-config Read tasks configuration and add/delete tasks in database... + reload-config Load or reload tasks’ configuration start Starts the server (use only for testing or development!) ``` @@ -98,14 +98,14 @@ Usage: argos server start [OPTIONS] Starts the server (use only for testing or development!) - See - https://framasoft.frama.io/framaspace/argos/deployment/systemd.html#server + See https://framasoft.frama.io/framaspace/argos/deployment/systemd.html#server for advices on how to start the server for production. Options: --host TEXT Host to bind --port INTEGER Port to bind - --config TEXT Path of the configuration file + --config TEXT Path of the configuration file. If ARGOS_YAML_FILE environment + variable is set, its value will be used instead. --reload Enable hot reloading --help Show this message and exit. ``` @@ -126,7 +126,8 @@ Usage: argos server migrate [OPTIONS] Run database migrations Options: - --config TEXT Path of the configuration file + --config TEXT Path of the configuration file. If ARGOS_YAML_FILE environment + variable is set, its value will be used instead. --help Show this message and exit. ``` @@ -153,7 +154,9 @@ Options: --max-lock-seconds INTEGER The number of seconds after which a lock is considered stale, must be higher than 60 (the checks have a timeout value of 60 seconds) - --config TEXT Path of the configuration file + --config TEXT Path of the configuration file. If ARGOS_YAML_FILE + environment variable is set, its value will be + used instead. --help Show this message and exit. ``` @@ -170,10 +173,11 @@ Options: ```man Usage: argos server reload-config [OPTIONS] - Read tasks configuration and add/delete tasks in database if needed + Read tasks’ configuration and add/delete tasks in database if needed Options: - --config TEXT Path of the configuration file + --config TEXT Path of the configuration file. If ARGOS_YAML_FILE environment + variable is set, its value will be used instead. --help Show this message and exit. ``` diff --git a/docs/installation/getting-started.md b/docs/installation/getting-started.md index ff5c981..5f784eb 100644 --- a/docs/installation/getting-started.md +++ b/docs/installation/getting-started.md @@ -5,17 +5,6 @@ - Python 3.11+ - PostgreSQL 13+ (for production) -## Getting dependencies - -Once you got the source locally, create a virtualenv and install the dependencies: - -```bash -python3 -m venv venv -source venv/bin/activate -pip install -e . -``` - - - ## Configure -### Configure the checks - -The quickest way to get started is to copy the `config-example.yaml` file and edit it: - -```bash -cp conf/config-example.yaml config.yaml -``` - - You can read more about the configuration in the [configuration section](../configuration.md).