mirror of https://github.com/onionshare/onionshare.git synced 2024-10-01 01:35:40 -04:00

Merge pull request #1167 from micahflee/docs

OnionShare documentation website

2020-09-03 12:01:50 -07:00

17 KiB

Raw Blame History

Index

Building OnionShare
Running tests
[Documentation]
Making releases

Building OnionShare

Start by getting the source code:

git clone https://github.com/micahflee/onionshare.git
cd onionshare

Linux

Use newest software

The recommended way to develop OnionShare is to use the latest versions of all dependencies.

First, install tor and obfs4proxy from either the official Debian repository, or from your package manager.

Then download Qt 5.14.0 for Linux:

cd ~/Downloads
wget https://download.qt.io/official_releases/qt/5.14/5.14.0/qt-opensource-linux-x64-5.14.0.run

If you'd like to check to make sure you have the exact installer I have, here is the sha256 checksum:

sha256sum qt-opensource-linux-x64-5.14.0.run
4379f147c6793ec7e7349d2f9ee7d53b8ab6ea4e4edf8ee0574a75586a6a6e0e  qt-opensource-linux-x64-5.14.0.run

Then make it executable and install Qt:

chmod +x qt-opensource-linux-x64-5.14.0.run
./qt-opensource-linux-x64-5.14.0.run

You have to create a Qt account and login to install Qt. Choose the default installation folder in your home directory. The only component you need is Qt 5.14.0 > Desktop gcc 64-bit.

Install poetry from your package manager, or by doing pip install --user poetry. Then install dependencies:

poetry install

You can run the CLI and the GUI versions of OnionShare like this:

poetry run ./dev_scripts/onionshare
poetry run ./dev_scripts/onionshare-gui

Use package managers

Alternatively, you can install dependencies from package managers.

Install the needed dependencies:

For Debian-like distros:

apt install -y python3-flask python3-stem python3-pyqt5 python3-crypto python3-socks  python-nautilus tor obfs4proxy python3-pytest python3-pytestqt build-essential fakeroot python3-all python3-stdeb dh-python python3-flask-httpauth python3-distutils python3-psutil python3-watchdog

For Fedora-like distros:

dnf install -y python3-flask python3-flask-httpauth python3-stem python3-qt5 python3-crypto python3-pysocks nautilus-python tor obfs4 python3-pytest rpm-build python3-psutil python3-watchdog

After that you can try both the CLI and the GUI version of OnionShare:

./dev_scripts/onionshare
./dev_scripts/onionshare-gui

You can also build OnionShare packages to install:

Create a .deb on Debian-like distros: ./install/build_deb.sh

Create a .rpm on Fedora-like distros: ./install/build_rpm.sh

For openSUSE: There are instructions for building in the wiki.

For ArchLinux: There is a PKBUILD available here that can be used to install OnionShare.

If you find that these instructions don't work for your Linux distribution or version, consult the Linux Distribution Support wiki guide, which might contain extra instructions.

macOS

Install Xcode from the Mac App Store. Once it's installed, run it for the first time to set it up. Also, run this to make sure command line tools are installed: xcode-select --install. And finally, open Xcode, go to Preferences > Locations, and make sure under Command Line Tools you select an installed version from the dropdown. (This is required for installing Qt5.)

Download and install Python 3.7.4 from https://www.python.org/downloads/release/python-374/. I downloaded python-3.7.4-macosx10.9.pkg.

You may also need to run the command /Applications/Python\ 3.7/Install\ Certificates.command to update Python 3.6's internal certificate store. Otherwise, you may find that fetching the Tor Browser .dmg file fails later due to a certificate validation error.

Install Qt 5.14.0 for macOS from https://www.qt.io/offline-installers. I downloaded qt-opensource-mac-x64-5.14.0.dmg. In the installer, you can skip making an account, and all you need is Qt > Qt 5.14.0 > macOS.

If you don't have it already, install poetry (pip3 install --user poetry). Then install dependencies:

poetry install

You can run both the CLI and GUI versions of OnionShare without building an bundle

poetry run ./dev_scripts/onionshare
poetry run ./dev_scripts/onionshare-gui

To build the app bundle

install/build_osx.sh

Now you should have dist/OnionShare.app.

To codesign and build a pkg for distribution

install/build_osx.sh --release

Now you should have dist/OnionShare.pkg.

Windows

Setting up your dev environment

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.7.4, 32-bit (x86) from https://www.python.org/downloads/release/python-374/. I downloaded python-3.7.4.exe. When installing it, make sure to check the "Add Python 3.7 to PATH" checkbox on the first page of the installer.

Install the Qt 5.14.0 from https://www.qt.io/offline-installers. I downloaded qt-opensource-windows-x86-5.14.0.exe. In the installer, you can skip making an account, and all you need Qt > Qt 5.14.0 > MSVC 2017 32-bit.

Install poetry. Open PowerShell, and run:

(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python

Then open a Command Prompt and cd to the onionshare folder, and install the poetry dependencies:

poetry install

After that you can try both the CLI and the GUI version of OnionShare:

poetry run python dev_scripts\onionshare
poetry run python dev_scripts\onionshare-gui

If you want to build a .exe

Download and install 7-Zip from http://www.7-zip.org/download.html. I downloaded 7z1900.exe.

Download and install the standalone Windows 10 SDK. Note that you may not need this if you already have Visual Studio.

Add the following directories (you might want to make sure these are exact on your computer) to the path:

C:\Program Files (x86)\Windows Kits\10\bin\10.0.18362.0\x86
C:\Program Files (x86)\Windows Kits\10\Redist\10.0.18362.0\ucrt\DLLs\x86
C:\Program Files (x86)\7-Zip
C:\Users\user\AppData\Local\Programs\Python\Python37-32\Lib\site-packages\PyQt5\Qt\bin

If you want the .exe to not get falsely flagged as malicious by anti-virus software

OnionShare uses PyInstaller to turn the python source code into Windows executable .exe file. Apparently, malware developers also use PyInstaller, and some anti-virus vendors have included snippets of PyInstaller code in their virus definitions. To avoid this, you have to compile the Windows PyInstaller bootloader yourself instead of using the pre-compiled one that comes with PyInstaller.

(If you don't care about this, you can install PyInstaller with pip install PyInstaller==3.5.)

Here's how to compile the PyInstaller bootloader:

Download and install Microsoft Build Tools for Visual Studio 2019. I downloaded vs_buildtools__1285639570.1568593053.exe. In the installer, check the box next to "Visual C++ build tools". Click "Individual components", and under "Compilers, build tools and runtimes", check "Windows Universal CRT SDK". Then click install. When installation is done, you may have to reboot your computer.

Then, enable the 32-bit Visual C++ Toolset on the Command Line like this:

cd "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build"
vcvars32.bat

Change to a folder where you keep source code, and clone the PyInstaller git repo and checkout the v3.5 tag:

git clone https://github.com/pyinstaller/pyinstaller.git
cd pyinstaller
git tag -v v3.5

(Note that ideally you would verify the git tag, but the PGP key that has signed the v3.5 git tag for is not published anywhere, so this isn't possible. See this issue.)

The next step is to compile the bootloader. We should do this all in dangerzone's poetry shell:

cd onionshare
poetry shell
cd ..\pyinstaller

And compile the bootloader, following these instructions. To compile, run this:

cd bootloader
python waf distclean all --target-arch=32bit --msvc_targets=x86

Finally, install the PyInstaller module into your poetry environment:

cd ..
python setup.py install
exit

Now the next time you use PyInstaller to build OnionShare, the .exe file should not be flagged as malicious by anti-virus.

If you want to build the installer

Go to http://nsis.sourceforge.net/Download and download the latest NSIS. I downloaded nsis-3.04-setup.exe.
Add C:\Program Files (x86)\NSIS to the path.

If you want to sign binaries with Authenticode

You'll need a code signing certificate. I got an open source code signing certificate from Certum.
Once you get a code signing key and certificate and covert it to a pfx file, import it into your certificate store.

To make a .exe:

Open a command prompt, cd into the onionshare directory, and type: pyinstaller install\pyinstaller.spec. onionshare-gui.exe and all of their supporting files will get created inside the dist folder.

To build the installer:

Note that you must have a codesigning certificate installed in order to use the install\build_exe.bat script, because it codesigns onionshare-gui.exe, uninstall.exe, and onionshare-setup.exe.

Open a command prompt, cd to the onionshare directory, and type: install\build_exe.bat

This will prompt you to codesign three binaries and execute one unsigned binary. When you're done clicking through everything you will have dist\onionshare-setup.exe.

Running tests

Tests in macOS and Linux

OnionShare includes PyTest unit tests. To run tests, you can run pytest against the tests/ directory.

poetry run ./tests/run.sh

You can run GUI tests like this:

poetry run ./tests/run.sh --rungui

If you're using Linux, you can also choose to wrap the tests in xvfb-run so that a ton of OnionShare windows don't pop up on your desktop (you may need to install the xorg-x11-server-Xvfb package), like this:

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

Tests in Windows

You can run this Windows batch script to run all of the CLI and GUI tests.

poetry run tests\run.bat

Documentation

To edit and build the documentation, see the docs readme.

Making releases

This section documents the release process. Unless you're a core OnionShare developer making a release, you'll probably never need to follow it.

Changelog, version, docs, and signed git tag

Before making a release, you must update the version in these places:

share/version.txt should have the correct version
pyproject.toml should have the correct version
docs/source/conf.py should have the correct version
install/org.onionshare.OnionShare.appdata.xml should have the correct version
install/onionshare.nsi should have the correct version, for the Windows installer

In addition to that, you must:

install/org.onionshare.OnionShare.appdata.xml should have the correct release date, and links to correct screenshots
CHANGELOG.md should be updated to include a list of all major changes since the last release
Update all of the documentation to cover new features, including taking new screenshots if necessary
There must be a PGP-signed git tag for the version, e.g. for OnionShare 2.1, the tag must be v2.1

The first step for the Linux, macOS, and Windows releases is the same:

Verify the release git tag:

git fetch
git tag -v v$VERSION

If the tag verifies successfully, check it out:

git checkout v$VERSION

Linux release

TODO: Write Flatpak instructions (see this issue).

To make a PPA release:

Go to Ubuntu build machine, which must have ~/.dput.cf with the correct PPA info in it, and with the correct PGP signing key
Verify and checkout the git tag for this release
Run ./install/ppa_release.sh, which builds a source package and uploads to the PPA build server
Login to Launchpad to monitor the build and make sure it is successful; if not, make minor patches and try the release again
After build is successful, from Launchpad, copy the binary from cosmic into other suites

macOS release

To make a macOS release, go to macOS build machine:

Build machine should be running macOS 10.11.6, and must have the Apple-trusted Developer ID Application: Micah Lee and Developer ID Installer: Micah Lee code-signing certificates installed
Verify and checkout the git tag for this release
Run ./install/build_osx.sh --release; this will make a codesigned installer package called dist/OnionShare-$VERSION.pkg
Copy OnionShare-$VERSION.pkg to developer machine

Then move back to the developer machine:

PGP-sign the macOS installer, gpg -a --detach-sign OnionShare-$VERSION.pkg

Note that once we support notarizing the macOS installer (see this issue), these will be the steps instead:

Developer machine, running the latest macOS, must have an app-specific Apple ID password saved in the login keychain called onionshare-notarize
Notarize it: xcrun altool --notarize-app --primary-bundle-id "com.micahflee.onionshare" -u "micah@micahflee.com" -p "@keychain:onionshare-notarize" --file OnionShare-$VERSION.pkg
Wait for it to get approved, check status with: xcrun altool --notarization-history 0 -u "micah@micahflee.com" -p "@keychain:onionshare-notarize"
After it's approved, staple the ticket: xcrun stapler staple OnionShare-$VERSION.pkg
PGP-sign the final, notarized and stapled, gpg -a --detach-sign OnionShare-$VERSION.pkg

This process ends up with two final files:

OnionShare-$VERSION.pkg
OnionShare-$VERSION.pkg.asc

Windows release

To make a Windows release, go to Windows build machine:

Build machine should be running Windows 10, and have the Windows codesigning certificate installed
Verify and checkout the git tag for this release
Run install\build_exe.bat; this will make a codesigned installer package called dist\onionshare-$VERSION-setup.exe
Copy onionshare-$VERSION-setup.exe to developer machine