Skip to content

Commit

Permalink
Remove references to paver
Browse files Browse the repository at this point in the history
  • Loading branch information
borrob committed Jan 15, 2020
1 parent f9afdfe commit 57383c0
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 365 deletions.
2 changes: 0 additions & 2 deletions GeoHealthCheck/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ def version(ctx):
'install the instance data and help files.')
def create_instance(ctx, basepath):
"""Create an instance of GeoHealthCheck App
This command is a copy of `paver setup`
"""
verbose_echo(ctx, 'GeoHC: create instance')
import glob
Expand Down
4 changes: 2 additions & 2 deletions GeoHealthCheck/migrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and Flask-Script.
Users should be able to upgrade existing installs via:

# In top dir of installation
paver upgrade
geohc db upgrade

The `versions` dir contains the various upgrades. These were
initially created using the Alembic `autogenerate` facility
Expand Down Expand Up @@ -39,7 +39,7 @@ Subsequently the upgrade can be performed using:

python manage.py db upgrade
# or the equivalent (for users)
paver upgrade
geohc db upgrade

## Revisions

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ geohc 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 paver create_secret_key
# - SECRET_KEY # copy/paste result string from geohc create-secret-key

# Optional: edit other settings or leave defaults
# - SQLALCHEMY_DATABASE_URI
Expand Down
2 changes: 1 addition & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,5 +244,5 @@ geohc db-upgrade
etc
```

NB: database upgrades (`paver upgrade`)
NB: database upgrades (`geohc db upgrade`)
are always performed automatically when running GHC via Docker.
4 changes: 2 additions & 2 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ a configuration file in the environment settings that will override settings in
The configuration options are:

- **SQLALCHEMY_DATABASE_URI**: the database configuration. See the SQLAlchemy documentation for more info
- **SECRET_KEY**: secret key to set when enabling authentication. Use the output of ``paver create_secret_key`` to set this value
- **SECRET_KEY**: secret key to set when enabling authentication. Use the output of ``geohc 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 @@ -106,7 +106,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 `paver runner_daemon` or can run internally within
The **GHC Runner** can be run via the command `geohc 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
13 changes: 10 additions & 3 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Install
vi instance/config_site.py
# edit:
# - SQLALCHEMY_DATABASE_URI
# - SECRET_KEY # from paver create_secret_key
# - SECRET_KEY # from geohc create-secret-key
# - GHC_RETENTION_DAYS
# - GHC_SELF_REGISTER
# - GHC_NOTIFICATIONS
Expand Down Expand Up @@ -118,8 +118,8 @@ An existing GHC database installation can be upgraded with:
Notes:

* **Always backup your database first!!**
* make sure Flask-Migrate is installed (see requirements.txt), else: `pip install Flask-Migrate==2.5.2`, but best is to run `paver setup` also for other dependencies
* upgrading is "smart": you can always run `paver upgrade`, it has no effect when DB is already up to date
* make sure Flask-Migrate is installed (see requirements.txt), else: `pip install Flask-Migrate==2.5.2`, but best is to run `geohc create-instance` also for other dependencies
* upgrading is "smart": you can always run `geohc db upgrade`, it has no effect when DB is already up to date
* when upgrading from earlier versions without Plugin-support:

- adapt your `config_site.py` to Plugin settings from `config_main.py`
Expand All @@ -144,6 +144,13 @@ the `paver upgrade` command. Also password recovery was changed: a user can crea
a unique, personal URL that GHC sends by email. This requires a working email configuration and a reachable
`SITE_URL` config value. See :ref:`admin_user_mgt` for solving password problems.

Upgrade notes v0.8.0
....................

In previous version GHC used `paver` to control the setup and administration of
the application. With this version GHC switched `click` and the cli commands
changed to `geohc`. Type `geohc --help` to get more information.


Running
-------
Expand Down
Loading

0 comments on commit 57383c0

Please sign in to comment.