Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2024-12-25 07:19:41 -05:00
Code Issues Packages Projects Releases Wiki Activity
5681ba4439
onionshare/desktop
History
Hosted Weblate 5681ba4439
Translated using Weblate (Russian) 
Currently translated at 100.0% (11 of 11 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (58 of 58 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (27 of 27 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (9 of 9 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (24 of 24 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (31 of 31 strings)

Translated using Weblate (Russian)

Currently translated at 100.0% (28 of 28 strings)

Translated using Weblate (Russian)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/ru/

Translated using Weblate (Spanish)

Currently translated at 87.5% (21 of 24 strings)

Translated using Weblate (Icelandic)
Translate-URL: https://hosted.weblate.org/projects/onionshare/translations/is/

Co-authored-by: Alexander Tarasenko <alexound.login@gmail.com>
Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Sveinn í Felli <sv1@fellsnet.is>
Co-authored-by: carlosm2 <carlosm2@riseup.net>
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-advanced/ru/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-develop/ru/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-features/ru/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-help/ru/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/es/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-install/ru/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-security/ru/
Translate-URL: https://hosted.weblate.org/projects/onionshare/doc-tor/ru/
Translation: OnionShare/Doc - Advanced
Translation: OnionShare/Doc - Develop
Translation: OnionShare/Doc - Features
Translation: OnionShare/Doc - Help
Translation: OnionShare/Doc - Install
Translation: OnionShare/Doc - Security
Translation: OnionShare/Doc - Tor
2021-09-25 14:36:12 +02:00
..
package Fix Windows and Mac build scripts 2021-05-05 20:39:14 -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 Fetch tor binaries from Tor Browser 11.0a5 2021-09-10 12:41:48 -07:00
src Translated using Weblate (Russian) 2021-09-25 14:36:12 +02:00
tests Merge pull request #1406 from SaptakS/fix-filelisting 2021-09-09 16:52:25 -07:00
pyproject.toml Change version to 2.4.dev1, to make a dev release 2021-09-10 13:38:00 -07:00
README.md Change github URLs from micahflee/onionshare to onionshare/onionshare 2021-08-20 13:34:55 -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

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.

In Ubuntu 20.04 you also need the libxcb-xinerama0 package installed.

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