mirror of https://github.com/onionshare/onionshare.git synced 2025-01-10 19:52:50 -03:00

History

Micah Lee 50e7471a49 Make it work in Windows		2020-10-14 22:36:31 -07:00
..
install	Make it work in Windows	2020-10-14 22:36:31 -07:00
screenshots	Add onionshare CLI to cli folder, move GUI to desktop folder, and start refactoring it to work with briefcase	2020-10-12 22:40:55 -07:00
src/onionshare	PySide2 datetimes use .toPython instead of .toPyDateTime	2020-10-14 20:25:49 -07:00
tests	Load onionshare_cli from source tree instead of pip dependency, and start making tests work with PySide2	2020-10-14 20:17:08 -07:00
.gitignore	Move docs back to root, move onionshare_gui into briefcase app, and make modifications so briefcase app will work	2020-10-13 17:28:54 -07:00
pyproject.toml	Load onionshare_cli from source tree instead of pip dependency, and start making tests work with PySide2	2020-10-14 20:17:08 -07:00
README.md	Make it work in Windows	2020-10-14 22:36:31 -07:00

README.md

OnionShare Desktop

Building OnionShare

Start by getting the source code and changing to the desktop folder:

git clone https://github.com/micahflee/onionshare.git
cd onionshare/desktop

Install platform-specific dependencies

Linux

If you're using Linux, install tor and obfs4proxy from either the official Debian repository, or from your package manager.

macOS

Windows

These instructions include adding folders to the path in Windows. To do this, go to Start and type "advanced system settings", and open "View advanced system settings" in the Control Panel. Click Environment Variables. Under "System variables" double-click on Path. From there you can add and remove folders that are available in the PATH.

Download Python 3.8.6, 32-bit (x86) from https://www.python.org/downloads/release/python-386/. I downloaded python-3.8.6.exe. When installing it, make sure to check the "Add Python 3.8 to PATH" checkbox on the first page of the installer.

Download and install 7-Zip from http://www.7-zip.org/download.html. I downloaded 7z1900.exe. Add C:\Program Files (x86)\7-Zip to your path.

Install dependencies:

pip install requests

Download Tor Browser and extract the binaries by running:

cd ..\cli
python scripts\get-tor-windows.py

Prepare the code

OnionShare uses Briefcase.

Install Briefcase dependencies by following these instructions.

Now create and/or activate a virtual environment.

python3 -m venv venv
. venv/bin/activate

Or in Windows:

python -m venv venv
venv\Scripts\activate.bat

While your virtual environment is active, install briefcase from pip.

pip install briefcase

Run OnionShare from the source tree like this:

briefcase dev -d

Running tests

Install these packages inside your virtual environment:

pip install pytest pytest-briefcase pytest-faulthandler pytest-qt

Then run the tests:

./tests/run.sh

If you want to run tests while hiding the GUI, you must have the xvfb package installed, and then:

xvfb-run ./tests/run.sh