almet/argos
1
0
Fork 0
mirror of https://framagit.org/framasoft/framaspace/argos.git synced 2025-04-28 18:02:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

🔀 Merge branch 'fix-33' into 'main'

Browse source 
📝 — Update doc for release (fix #33)

Closes #33

See merge request framasoft/framaspace/argos!47
This commit is contained in:
Alexis Metaireau 2024-04-25 12:11:16 +00:00
commit 3bad54c19b
2 changed files with 13 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/cli.md
View file

@ -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.
```

23
docs/installation/getting-started.md
View file

@ -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 .
```
<!--
## Install with pip
```bash
@ -39,25 +28,13 @@ 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
```
<!--
The quickest way to get started is to get the `config-example.yaml` file from our repository and edit it:
```bash
wget https://framagit.org/framasoft/framaspace/argos/-/raw/main/conf/config-example.yaml -O config.yaml
```
-->
You can read more about the configuration in the [configuration section](../configuration.md).