mirror of https://github.com/onionshare/onionshare.git synced 2024-12-25 23:39:43 -05:00

History

Micah Lee acceed9782 Merge pull request #1268 from SaptakS/macos-dark MacOS dark mode implementations		2021-02-01 20:33:31 -08:00
..
package	Add .desktop launchers in both snap and flatpack packages	2020-11-23 20:51:16 -08: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
scripts	Move check_lacked_trans.py into scripts -- this needs to be tested and fixed at some point	2020-12-13 11:45:35 -08:00
src	Merge pull request #1268 from SaptakS/macos-dark	2021-02-01 20:33:31 -08:00
tests	End web thread successfully when cleaning up after a tab, which prevents crashes after running the tests; and fix msi_filename in Windows build script	2020-11-09 19:47:57 -08:00
pyproject.toml	Move psutil dependency from desktop to CLI	2020-11-17 17:45:04 -08:00
README.md	Write rebuild-cli in python instead of bash to work in Windows, and make the dev script available in Windows	2020-11-29 13:57:53 -08: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

Download and install Python 3.8.6 from https://www.python.org/downloads/release/python-386/. I downloaded python-3.8.6-macosx10.9.pkg. (You may need to also run /Applications/Python\ 3.8/Install\ Certificates.command.)

Install python dependencies:

pip3 install --user poetry requests

Download Tor Browser and extract the binaries:

./scripts/get-tor-osx.py

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 python dependencies:

pip install poetry requests

Download Tor Browser and extract the binaries:

python scripts\get-tor-windows.py

Prepare the virtual environment

OnionShare uses Briefcase.

Install Briefcase dependencies by following these instructions.

Now create and/or activate a virtual environment.

Linux and macOS

python3 -m venv venv
. venv/bin/activate

Windows

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

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

pip install briefcase

In order to work with the desktop app, you'll need to build a wheel of the CLI package first, and copy it into the desktop folder. You'll need to re-run this script each time you change the CLI code.

python scripts/rebuild-cli.py

Running OnionShare from the source code tree

Inside the virtual environment, run OnionShare like this to install all of the dependencies:

briefcase dev -d

Once you have the dependencies installed, you can run it using the dev.sh script, which lets you use command line arguments, such as to --verbose or --local-only:

./scripts/dev.sh --help
./scripts/dev.sh -v
./scripts/dev.sh -v --local-only

Windows uses scripts\dev.bat instead.

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