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
fd50b5ad20
onionshare/desktop
History
Micah Lee fd50b5ad20
Homebrew install create-dmg in a different place now
2024-02-22 10:54:50 -08:00
..
onionshare Updates list of languages and changelog 2024-02-20 02:26:48 +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 Homebrew install create-dmg in a different place now 2024-02-22 10:54:50 -08:00
tests rename compression test 2023-05-30 16:37:03 +10:00
org.onionshare.OnionShare.appdata.xml Update RELEASE.md 2024-02-20 01:06:26 +05:30
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 Updates python dependencies 2024-02-13 01:49:22 +05:30
pyproject.toml Updates the version information 2023-12-28 16:14:36 +05:30
README.md Merge pull request #1789 from mdaleo404/fix_get_tor_linux_platform_name 2023-12-14 20:18:12 +05:30
setup-freeze.py Rename LICENSE to LICENSE.txt 2023-10-17 12:25:05 -07:00
setup.py Updates the version information 2023-12-28 16:14:36 +05:30

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). Add C:\Program Files\7-Zip to your path.
  • Download and install gpg4win. Add C:\Program Files (x86)\GnuPG\bin to your path.

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

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