From 2551f2b71981affad09e14693bd60dfc6ec3e4f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 07:21:55 +0000 Subject: [PATCH 1/8] Update documentation: Add mention to FreeBSD support --- docs/source/install.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index 7243680d..4243f6c0 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -54,6 +54,13 @@ Command-line only You can install just the command-line version of OnionShare on any operating system using the Python package manager ``pip``. :ref:`cli` has more info. +.. _freebsd: + +FreeBSD +------- + +Althought not being officially developed for this platform, OnionShare can also be installed on `FreeBSD `_. It's available via its ports tree or as pre-built package. Should you opt to install and use OnionShare on a FreeBSD operating system, please be aware that it's **NOT** officially supported by the OnionShare project. + .. _verifying_sigs: Verifying PGP signatures From 874d2ccdeb392d66583c269e4e28a3f79b1a75d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 07:33:00 +0000 Subject: [PATCH 2/8] Update documentation: describe pkg installatin for FreeBSD --- docs/source/install.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index 4243f6c0..19f3bcaf 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -61,6 +61,13 @@ FreeBSD Althought not being officially developed for this platform, OnionShare can also be installed on `FreeBSD `_. It's available via its ports tree or as pre-built package. Should you opt to install and use OnionShare on a FreeBSD operating system, please be aware that it's **NOT** officially supported by the OnionShare project. +Binary pkg Installation +^^^^^^^^^^^^^^^^^^^^^^^ + +To install the binary package, use ``pkg install pyXY-onionshare``, with ``pyXY`` specifying the version of Python the package was built for. So, in order to install OnionShare for Python 3.9, use:: + + pkg install py39-onionshare + .. _verifying_sigs: Verifying PGP signatures From 0fc5794e1866991cde46a73b65486527e37a07c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 07:42:22 +0000 Subject: [PATCH 3/8] Update documentation: mention manual port install for FreeBSD --- docs/source/install.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index 19f3bcaf..5df946d3 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -68,6 +68,13 @@ To install the binary package, use ``pkg install pyXY-onionshare``, with ``pyXY` pkg install py39-onionshare +Manual port Installation +^^^^^^^^^^^^^^^^^^^^^^^^ + +To install the FreeBSD port, change directory to the `ports tree `_ you must have checked out before and run the following:: + + make -s -C www/onionshare all install clean + .. _verifying_sigs: Verifying PGP signatures From 38744e4dd759282b7034cbf8d6a8394c08a02ad3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 07:43:25 +0000 Subject: [PATCH 4/8] Update documentation: `%s/tree/collection` for FreeBSD ports mentions --- docs/source/install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/install.rst b/docs/source/install.rst index 5df946d3..b5da605d 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -59,7 +59,7 @@ You can install just the command-line version of OnionShare on any operating sys FreeBSD ------- -Althought not being officially developed for this platform, OnionShare can also be installed on `FreeBSD `_. It's available via its ports tree or as pre-built package. Should you opt to install and use OnionShare on a FreeBSD operating system, please be aware that it's **NOT** officially supported by the OnionShare project. +Althought not being officially developed for this platform, OnionShare can also be installed on `FreeBSD `_. It's available via its ports collection or as pre-built package. Should you opt to install and use OnionShare on a FreeBSD operating system, please be aware that it's **NOT** officially supported by the OnionShare project. Binary pkg Installation ^^^^^^^^^^^^^^^^^^^^^^^ @@ -71,7 +71,7 @@ To install the binary package, use ``pkg install pyXY-onionshare``, with ``pyXY` Manual port Installation ^^^^^^^^^^^^^^^^^^^^^^^^ -To install the FreeBSD port, change directory to the `ports tree `_ you must have checked out before and run the following:: +To install the FreeBSD port, change directory to the `ports collection `_ you must have checked out before and run the following:: make -s -C www/onionshare all install clean From d1e1d8b23329fc36d748942fba7d15b972dee8fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 07:49:35 +0000 Subject: [PATCH 5/8] Update documentation: add refs to the FreeBSD handbook for pkg and ports --- docs/source/install.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index b5da605d..85a70cbf 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -68,6 +68,8 @@ To install the binary package, use ``pkg install pyXY-onionshare``, with ``pyXY` pkg install py39-onionshare +For additional information and details about the FreeBSD pre-built packages, please refer to its `official Handbook section about pkg `_. + Manual port Installation ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -75,6 +77,8 @@ To install the FreeBSD port, change directory to the `ports collection `_. + .. _verifying_sigs: Verifying PGP signatures From a6c8c5e8538701657239538526689e39a58584a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 08:02:30 +0000 Subject: [PATCH 6/8] Update documentation: more inputs about FreeBSD here --- docs/source/install.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index 85a70cbf..764d8de1 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -61,6 +61,11 @@ FreeBSD Althought not being officially developed for this platform, OnionShare can also be installed on `FreeBSD `_. It's available via its ports collection or as pre-built package. Should you opt to install and use OnionShare on a FreeBSD operating system, please be aware that it's **NOT** officially supported by the OnionShare project. +Though not being offered and officially maintained by the OnionShare developers, the FreeBSD packages and ports do fetch and verifies the source codes from the official OnionShare repository (or its official release packages from `PyPI `_). Should you wish to check changes related to this platform, please refer to the following resources: + +- https://cgit.freebsd.org/ports/log/www/onionshare +- https://www.freshports.org/www/onionshare + Binary pkg Installation ^^^^^^^^^^^^^^^^^^^^^^^ From 9bf6832f82c818d21ac2c092271f52bbc07bb5e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 08:07:00 +0000 Subject: [PATCH 7/8] Update documentation: mention the cli-version for FreeBSD pkg+port --- docs/source/install.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/install.rst b/docs/source/install.rst index 764d8de1..cc3b0e43 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -73,6 +73,8 @@ To install the binary package, use ``pkg install pyXY-onionshare``, with ``pyXY` pkg install py39-onionshare +There's also a **Command-line only** version of OnionShare available as pre-built package. Replace ``py39-onionshare`` by ``py39-onionshare-cli`` if you want to install that version. + For additional information and details about the FreeBSD pre-built packages, please refer to its `official Handbook section about pkg `_. Manual port Installation @@ -82,6 +84,8 @@ To install the FreeBSD port, change directory to the `ports collection `_. .. _verifying_sigs: From 54591f415c5915946c7a0dbb86c54c28adf41dd4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Zavam?= Date: Tue, 12 Sep 2023 08:10:37 +0000 Subject: [PATCH 8/8] Update documentation: `%s/Binary/Manual` to follow same std as the docu --- docs/source/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/install.rst b/docs/source/install.rst index cc3b0e43..298174e0 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -66,7 +66,7 @@ Though not being offered and officially maintained by the OnionShare developers, - https://cgit.freebsd.org/ports/log/www/onionshare - https://www.freshports.org/www/onionshare -Binary pkg Installation +Manual pkg Installation ^^^^^^^^^^^^^^^^^^^^^^^ To install the binary package, use ``pkg install pyXY-onionshare``, with ``pyXY`` specifying the version of Python the package was built for. So, in order to install OnionShare for Python 3.9, use::