Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docker/scripts/run-runner.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion docker/scripts/run-tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion docs/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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: ::

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading