Commit a0bb72a5 authored by Georges Racinet's avatar Georges Racinet 🦑
Browse files

More changes to INSTALL_HEPTAPOD.md from heptapod-0-12

--HG--
branch : heptapod-stable
parent 6d249f83fd73
......@@ -81,32 +81,25 @@ Install the Python packages to be taken from pypi.org using the
[requirements file](python/requirements.txt):
```
pip install -U -r python/requirements.txt
$PIP install -U -r python/requirements.txt
```
Then install from the following Mercurial URLs:
- https://mirror.octobus.net/heptapod/hg-git-heptapod
- https://mirror.octobus.net/octobus/hgext-loggingmod
- https://mirror.octobus.net/heptapod/py-heptapod
where `$PIP` is `pip --user` or `some/virtualenv/bin/pip` according to your
choice.
For each one, rather to use `pip install hg+https`, which is quite error
Then, we need a special unreleased version of `hg-git`.
Rather to use `pip install hg+https`, which is quite error
prone, the simplest best way looks like this:
```
hg clone -u $TAG https://mirror.octobus.net/heptapod/py-heptapod
$PIP install -e py-heptapod
hg clone -u $TAG https://mirror.octobus.net/heptapod/hg-git-heptapod hg-git
$PIP install -e hg-git
```
where `$PIP` is `pip --user` or `some/virtualenv/bin/pip` according to your
choice.
Notes:
- these repositories are small enough than pull exactly the wanted
- this repository is small enough that pulling exactly the wanted
revision is a needless complication.
- `hgext_loggingmod` is an exception of the tagging policy.
After initial development, it just stayed untouched, version 0.1.2 is fine.
- the `-e` flag will make your subsequent updates easier: you'll just have
to `hg pull -u NEW_TAG`, redo the `pip install -e` to account for package
metadata changes (notably entry points if any) and restart relevant processes.
......@@ -124,14 +117,29 @@ You need to
#### Defining Mercurial settings
`py-heptapod` ships with a configuration file that perfoms most of the required
and default Mercurial settings for Heptapod
The `heptapod` Python project, listed in `requirements.txt`,
ships with a configuration file, `required.hgrc`, that performs most
of the required and default Mercurial settings for Heptapod
(using the `heptapod` extension, permission policy, etc.)
You'll need to use it and add your local installation details.
You'll find it where your `$PIP` has installed `heptapod`, which you can
find out like this:
```
export PY_HEPTAPOD=`$PYTHON -c "import heptapod, os; print(os.path.dirname(heptapod.__file__))"`
```
where `$PYTHON` is the python interpreter that's consistent with `$PIP`. So,
for instance if you're using a virtualenv, and `$PIP` is
`/path/to/virtualenv/bin/pip`, then `$PYTHON` is
`/path/to/virtualenv/bin/python`. If you're using
the global pip, then `$PYTHON` is most likely just `python` or `python2`.
You'll need to use `$PY_HEPTAPOD/required.hgrc` and add your local
installation details.
A simple way is to create a `heptapod.hgrc` file using the `%include` directive.
See the example in `py-heptapod/heptapod/heptapod.example.hgrc`.
See the example in `$PY_HEPTAPOD/heptapod.example.hgrc`.
### Internal Mercurial service
......@@ -151,11 +159,12 @@ is on the path.
heptapod.wsgi:hgserve
```
Again, this `gunicorn` must be able to load the Heptapod Python packages.
Again, this `gunicorn` must be able to load the Heptapod Python packages, so
you should use the one that's been installed with `requirements.txt`.
Notes:
- Heptapod is not able yet to use Unix domain sockets
- Heptapod is not able yet to use Unix domain sockets in this service
- If you want to use another loopback URL, configure the Rails app
accordingly, in `config/gitlab.yml`.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment