Skip to content

Commit aa2aace

Browse files
tulinkryVladimir Kotal
authored andcommitted
updating the readme with directory specific installation
1 parent 394d7f3 commit aa2aace

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

opengrok-tools/src/main/python/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,25 @@ python3 -m pip install opengrok_tools-{version}.tar.gz
9797
This will download all dependencies and install the package to your local python3 modules.
9898
You can use console scripts to run the package binaries.
9999

100+
#### Installing to a specified directory
101+
102+
You can also install the tools to a specified directory, we suggest you to use the python virtual environment for it.
103+
104+
```bash
105+
cd /opt/opengrok
106+
python3 -m venv opengrok-tools
107+
opengrok-tools/bin/python -m pip install opengrok_tools-{version}.tar.gz
108+
```
109+
110+
This will install the package and all the dependencies under the `/opt/opengrok/opengrok-tools` directory.
111+
You can then call the scripts with
112+
113+
```bash
114+
/opt/opengrok/opengrok-tools/bin/opengrok-indexer
115+
/opt/opengrok/opengrok-tools/bin/opengrok-groups
116+
...
117+
```
118+
100119
#### Uninstalling
101120

102121
```bash

0 commit comments

Comments
 (0)