From 3ca4258e2368cec8662d59d90a25c71503778250 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Tue, 30 Jun 2026 07:45:17 -0400 Subject: [PATCH 1/2] update invoke commands --- README.md | 4 ++-- docker/scripts/run-runner.sh | 2 +- docker/scripts/run-tests.sh | 2 +- docs/admin.rst | 2 +- docs/config.rst | 10 +++++----- docs/install.rst | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 53942d5..e7e0b18 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ pip3 install Invoke # setup installation invoke setup # generate secret key -invoke create_secret_key +invoke create-secret-key # setup local configuration (overrides GeoHealthCheck/config_main.py) vi instance/config_site.py # edit at least secret key: -# - SECRET_KEY # copy/paste result string from `invoke create_secret_key` +# - SECRET-KEY # copy/paste result string from `invoke create-secret-key` # Optional: edit other settings or leave defaults # - SQLALCHEMY_DATABASE_URI diff --git a/docker/scripts/run-runner.sh b/docker/scripts/run-runner.sh index 3c91b76..f57045c 100755 --- a/docker/scripts/run-runner.sh +++ b/docker/scripts/run-runner.sh @@ -13,6 +13,6 @@ export PYTHONPATH=/GeoHealthCheck/GeoHealthCheck:$PYTHONPATH cd /GeoHealthCheck source bin/activate -invoke runner_daemon +invoke runner-daemon echo "END /run-runner.sh" diff --git a/docker/scripts/run-tests.sh b/docker/scripts/run-tests.sh index d66621d..15a79ec 100755 --- a/docker/scripts/run-tests.sh +++ b/docker/scripts/run-tests.sh @@ -18,6 +18,6 @@ export PYTHONPATH=/GeoHealthCheck/GeoHealthCheck:$PYTHONPATH cd /GeoHealthCheck source bin/activate -invoke run_tests +invoke run-tests echo "END /run-tests.sh" diff --git a/docs/admin.rst b/docs/admin.rst index d4dfcc4..cf8eab3 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -95,7 +95,7 @@ Or more compact within the root dir of your GHC installation: :: Or even more compact within the root dir of your GHC installation via Invoke: :: - $ invoke create_hash -p mypass + $ invoke create-hash -p mypass Copy/paste the entire token below for example to set password $pbkdf2-sha256$29000$FkJoTYnxPqc0pjQG4HxP6Q$C3SZb8jqtM7zKS1DSLcouc/CL9XMI9cL5xT6DRTOEd4 diff --git a/docs/config.rst b/docs/config.rst index 8914d80..714dc9e 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -15,7 +15,7 @@ The configuration options are: - **SQLALCHEMY_DATABASE_URI**: the database configuration. See the SQLAlchemy documentation for more info - **SQLALCHEMY_ENGINE_OPTION_PRE_PING**: DB Disconnect Handling, emitting a test statement on the SQL connection at the start of each connection pool checkout (default: ``False``) -- **SECRET_KEY**: secret key to set when enabling authentication. Use the output of ``invoke create_secret_key`` to set this value +- **SECRET_KEY**: secret key to set when enabling authentication. Use the output of ``invoke create-secret-key`` to set this value - **GHC_RETENTION_DAYS**: the number of days to keep Run history - **GHC_PROBE_HTTP_TIMEOUT_SECS**: stop waiting for the first byte of a Probe response after the given number of seconds - **GHC_MINIMAL_RUN_FREQUENCY_MINS**: minimal run frequency for Resource that can be set in web UI @@ -51,7 +51,7 @@ The configuration options are: Example on overriding the configuration with an environment variable: :: export GHC_SETTINGS=/tmp/my_GHC_settings.py - invoke run_tests + invoke run-tests As an example: the `my_GHC_settings.py` file can contain a single line to define a test database: :: @@ -111,7 +111,7 @@ This is the preferred mode as each `Resource` can have its own schedule (configu via Dashboard) and `cron` has dependencies on local environment. Later versions may phase out cron-scheduling completely. -The **GHC Runner** can be run via the command `invoke runner_daemon` or can run internally within +The **GHC Runner** can be run via the command `invoke runner-daemon` or can run internally within the **GHC Webapp** by setting the config variable **GHC_RUNNER_IN_WEBAPP** to `True` (the default). NB it is still possible to run GHC as in the pre-v0.5.0 mode using cron-jobs: just run the **GHC Webapp** with **GHC_RUNNER_IN_WEBAPP** set to `False` and have your cron-jobs scheduled. @@ -153,7 +153,7 @@ Compiling Language Files ........................ At runtime compiled versions, `.mo` files, of the language-files are used. -Easiest to compile is via: `invoke compile_translations` in the project root dir. +Easiest to compile is via: `invoke compile-translations` in the project root dir. This basically calls `pybabel compile` with the proper options. Now you can e.g. test your new translations by starting GHC. @@ -175,7 +175,7 @@ Missing translations will have `msgstr ""` like in this excerpt: :: Next all empty `msgstr` can be filled. -Updating is easiest using the command `invoke update_translations` within the root dir of the project. +Updating is easiest using the command `invoke update-translations` within the root dir of the project. This will basically call `pybabel extract` followed by `pybabel update` with the proper parameters. Customizing the Score Matrix diff --git a/docs/install.rst b/docs/install.rst index f26a133..439341f 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -63,13 +63,13 @@ Install invoke setup # create secret key to use for auth - invoke create_secret_key + invoke create-secret-key # almost there! Customize config vi instance/config_site.py # edit: # - SQLALCHEMY_DATABASE_URI - # - SECRET_KEY # from invoke create_secret_key + # - SECRET_KEY # from invoke create-secret-key # - GHC_RETENTION_DAYS # - GHC_SELF_REGISTER # - GHC_NOTIFICATIONS From 21acaf873fef7a2fb55f056ec25acd25b3c2513f Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Tue, 30 Jun 2026 07:46:30 -0400 Subject: [PATCH 2/2] fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7e0b18..f83409b 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ invoke create-secret-key # setup local configuration (overrides GeoHealthCheck/config_main.py) vi instance/config_site.py # edit at least secret key: -# - SECRET-KEY # copy/paste result string from `invoke create-secret-key` +# - SECRET_KEY # copy/paste result string from `invoke create-secret-key` # Optional: edit other settings or leave defaults # - SQLALCHEMY_DATABASE_URI