Onionr/docs/usage/install.md

18 lines
751 B
Markdown
Raw Normal View History

2019-06-28 20:23:03 +00:00
# Onionr Installation
2020-08-12 22:21:11 +00:00
The following steps work broadly speaking for WSL, Mac, and Linux.
2019-06-28 20:23:03 +00:00
2019-11-16 04:18:38 +00:00
1. Verify python3.7+ is installed: if not, see https://www.python.org/downloads/
2019-06-28 20:23:03 +00:00
2. Verify Tor is installed (does not need to be running, binary can be put into system path or Onionr directory)
3. [Optional but recommended]: setup virtual environment using [virtualenv](https://virtualenv.pypa.io/en/latest/), activate the virtual environment
2019-11-16 04:18:38 +00:00
4. Clone Onionr: `$ git clone https://gitlab.com/beardog/onionr`
2019-06-28 20:23:03 +00:00
2019-11-16 04:18:38 +00:00
5. Install the Python module dependencies: `$ pip3 install --require-hashes -r requirements.txt`
Note: if an alternative python install is needed, use virtualenv or run Onionr commands with:
`$ /path/to/python /path/to/onionr/onionr/__init__.py`