mirror of https://github.com/onionshare/onionshare.git synced 2024-12-25 07:19:41 -05:00

History

Micah Lee 1020121c33 Finish making the WiX installer 64-bit		2023-10-20 12:44:57 -07:00
..
onionshare	Merge pull request #1782 from onionshare/make-clear-chats-ephemeral	2023-10-17 19:58:23 +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	Finish making the WiX installer 64-bit	2023-10-20 12:44:57 -07:00
tests	rename compression test	2023-05-30 16:37:03 +10:00
org.onionshare.OnionShare.appdata.xml	Update version to 2.6.1.dev1	2023-10-17 17:01:11 -07: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	Update poetry deps	2023-10-17 11:24:57 -07:00
pyproject.toml	Update version to 2.6.1.dev1	2023-10-17 17:01:11 -07:00
README.md	remove specific package version	2023-10-18 08:15:47 +01:00
setup-freeze.py	Rename LICENSE to LICENSE.txt	2023-10-17 12:25:05 -07:00
setup.py	Update version to 2.6.1.dev1	2023-10-17 17:01:11 -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/onionshare/onionshare.git
cd onionshare/desktop

Make sure you have Python 3 installed. If you're using Windows or macOS, install the latest version of 3.11 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:

On Debian/Debian-based distributions you may need the libxcb-xinerama0 and libxcb-cursor0 packages installed.
On Fedora/CentOS you may need the libxcb-* and xcb-util-* packages installed.

Windows users:

Download and install 7-Zip (x64) from https://7-zip.org/download.html. [Add](https://medium.com/@kevinmarkvi/how-to-add-executables-togit fethc-your-path-in-windows-5ffa4ce61a53) C:\Program Files\7-Zip to your path.
Download and install gpg4win from https://gpg4win.org/. Add C:\Program Files (x86)\GnuPG\bin to your path too.

Download Tor Browser and extract the binaries for your platform. The platform must be win64, macos, or linux64.

poetry run python ./scripts/get-tor.py [platform]

Compile dependencies

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

Compile pluggable transports:

Windows users, in PowerShell:

.\scripts\build-pt-obfs4proxy.ps1
.\scripts\build-pt-snowflake.ps1
.\scripts\build-pt-meek.ps1

macOS and Linux users:

./scripts/build-pt-obfs4proxy.sh
./scripts/build-pt-snowflake.sh
./scripts/build-pt-meek.sh

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