Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2024-10-01 01:35:40 -04:00
Code Issues Packages Projects Releases Wiki Activity
c23621d841
onionshare/desktop
History
Micah Lee 053688c4b9
Merge branch 'develop' into ci-builds
2022-05-25 21:32:17 -07:00
..
onionshare Merge pull request #1563 from mig5/tab_shortcuts_and_accessible_main_page 2022-04-28 00:45:39 +05:30
package Move windows and mac build scripts into scripts folder 2022-04-03 17:20: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
scripts Merge branch 'develop' into ci-builds 2022-05-25 21:32:17 -07:00
tests Remove useless CLI stuff from GUI tests, and refactor so that qtapp is a singleton and all tests can be run at once 2022-03-06 14:26:51 -08:00
org.onionshare.OnionShare.appdata.xml Update release docs, and fix screenshot link in appdata 2022-01-17 10:34:11 -08:00
org.onionshare.OnionShare.desktop Move the rest of the desktop files out of the src folder 2021-12-19 17:33:00 -08:00
org.onionshare.OnionShare.svg Move the rest of the desktop files out of the src folder 2021-12-19 17:33:00 -08:00
poetry.lock Create new windows.py script that combines various Windows build tasks, and update CI to use it 2022-03-31 18:34:41 -07:00
pyproject.toml Create new windows.py script that combines various Windows build tasks, and update CI to use it 2022-03-31 18:34:41 -07:00
README.md Combine all get-tor scripts into a single get-tor.py 2022-04-03 11:15:53 -07:00
setup-freeze.py Try a different way of explicitly defining what packages to include and exclude 2022-03-31 12:31:48 -07:00
setup.py Make snapcraft work 2022-01-17 12:56:39 -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/onionshare/onionshare.git
cd onionshare/desktop

Make sure you have Python 3 installed. If you're using Windows or macOS, install version 3.9.12 from python.org. For Windows, make sure to check the box to add python to the path on the first page of the installer.

Make sure you have poetry installed:

pip3 install poetry

And install the poetry dependencies:

poetry install

Windows users: You may need to install Microsoft C++ Build Tools, making sure to check "Desktop development with C++", before poetry install will work properly.

Get Tor

Linux users: In Ubuntu 20.04 you need the libxcb-xinerama0 package installed.

Windows users: Download and install 7-Zip from https://7-zip.org/download.html. Add C:\Program Files (x86)\7-Zip to your path.

Download Tor Browser and extract the binaries:

poetry run python ./scripts/get-tor.py

Compile dependencies

Install Go. The simplest way to make sure everything works is to install Go by following these instructions.

Download and compile meek-client:

poetry run python ./scripts/build-meek-client.py

Running OnionShare from the source code tree

To run OnionShare from the source tree:

poetry run onionshare
poetry run onionshare --help
poetry run onionshare -v
poetry run onionshare -v --local-only

You can also run onionshare-cli from the source tree, and it will look for Tor binaries in desktop/onionshare/resources/tor.

poetry run onionshare-cli --help

Running tests

Run the tests:

poetry run ./tests/run.sh

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

xvfb-run poetry run ./tests/run.sh