From 199cbd7927f5d7a48e759a59e078b6cab349dc18 Mon Sep 17 00:00:00 2001 From: Luc Didry Date: Thu, 11 Apr 2024 15:37:45 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20=E2=80=94=20Server=20start=20is?= =?UTF-8?q?=20for=20testing=20or=20dev=20only=20(fix#35)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- argos/commands.py | 6 +++++- docs/cli.md | 8 ++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/argos/commands.py b/argos/commands.py index ca87647..d7a7e28 100644 --- a/argos/commands.py +++ b/argos/commands.py @@ -90,7 +90,11 @@ def agent(server_url, auth, max_tasks, wait_time, log_level): @click.option("--config", default="config.yaml", help="Path the the configuration file") @click.option("--reload", is_flag=True, help="Enable hot reloading") def start(host, port, config, reload): - """Starts the server""" + """Starts the server (use only for testing or development!) + + See https://framasoft.frama.io/framaspace/argos/deployment/systemd.html#server + for advices on how to start the server for production. + """ os.environ["ARGOS_YAML_FILE"] = config uvicorn.run("argos.server:app", host=host, port=port, reload=reload) diff --git a/docs/cli.md b/docs/cli.md index 472f8d6..5a45214 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -81,7 +81,7 @@ Commands: generate-token Generate a token, which can be used as an agent’s... migrate Run database migrations reload-config Read tasks configuration and add/delete tasks in database... - start Starts the server + start Starts the server (use only for testing or development!) ```