Skip to content

Commit 94a5315

Browse files
authored
Update install.rst
1 parent b5775b0 commit 94a5315

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

docs/install.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,15 @@ Install
4343
It is strongly recommended to install GeoHealthCheck in a Python Virtual Environment.
4444
A Virtual Environment is self-contained and provides the flexibility to install /
4545
tear down / whatever packages without affecting system wide packages or
46-
settings. The installation is driven by the standard config file `pyproject.toml`.
47-
It is recommended to use `pixi <https://pixi.prefix.dev/>`_ to manage the entire installation and
48-
further management.
46+
settings. The installation is driven by the standard config file ``pyproject.toml``.
47+
It is strongly recommended to use `Pixi <https://pixi.prefix.dev/>`_ to manage installation and management.
4948

5049
- Download a GeoHealthCheck release from
5150
https://github.com/geopython/GeoHealthCheck/releases, or clone manually from GitHub.
5251

53-
It is strongly recommended to install `pixi <https://pixi.prefix.dev/>`_ to
52+
It is strongly recommended to install `Pixi <https://pixi.prefix.dev/>`_ to
5453
handle the GeoHealthCheck installation and further tasks. The GHC Dockerfile also
55-
uses `pixi`.
54+
uses `Pixi`.
5655

5756
.. code-block:: bash
5857
@@ -150,11 +149,11 @@ An existing GHC database installation can be upgraded with:
150149
Notes:
151150

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

157-
- adapt your `config_site.py` to Plugin settings from `config_main.py`
156+
- adapt your `config_site.py` to Plugin settings from ``config_main.py``
158157
- assign `Probes` and `Checks` to each `Resource` via the UI
159158

160159
When running with Docker see the
@@ -165,7 +164,7 @@ Upgrade notes v0.5.0
165164
....................
166165

167166
In GHC v0.5.0 a new run-architecture was introduced. By default, healthchecks run under
168-
the control of an internal scheduler, i.s.o. of external cron-jobs. See also the :ref:`architecture` chapter
167+
the control of an internal scheduler, i.s.o. of external cronjobs. See also the :ref:`architecture` chapter
169168
and :ref:`admin_running` and below.
170169

171170
Upgrade notes v0.6.0
@@ -242,7 +241,7 @@ See `closed issues for the related GitHub Milestone 0.10.0 <https://github.com/g
242241
Specifics, for existing, pre 0.10.0, installations:
243242

244243
* Docker Containers now run under a specific non-root user. This may give permission issues.
245-
* `docker-compose.yml`: `entrypoint` now uses scripts directly like `/app/docker/scripts/run-runner.sh` i.s.o. `/run-runner.sh`
244+
* ``docker-compose.yml``: ``entrypoint`` now uses scripts directly like ``/app/docker/scripts/run-runner.sh`` i.s.o. ``/run-runner.sh``
246245
* When using SQLite in a Docker Named Volume you may need to re-init the DB if you get permission issues
247246
* Paver is replaced by Invoke and Pixi: see the updated README and docs for new maintenance commands
248247

0 commit comments

Comments
 (0)