Torrific Lynx

Enables clear-net browsing over the Tor network via Lynx web browser

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

• 🧰 Usage

• 🗒 Notes

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

Prior to utilizing this project, the Lynx web browser should be installed, and bash --version should report a version number of 4 or greater.

Optional dependencies include firejail and socat, for process sandboxing and DNS over Tor respectively.

This repository makes use of Git Submodules to track Bash script dependencies, to avoid incomplete downloads clone with the --recurse-submodules option...

git clone --recurse-submodules git@github.com:paranoid-linux/torrific-lynx.git

To update tracked Git Submodules issue the following commands...

git pull

git submodule update --init --merge --recursive

To force upgrade of Git Submodules...

git submodule update --init --merge --recursive --remote

Note, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.

---

Quick Start

Clone this repository along with the submodules it depends upon...

mkdir -p ~/git/hub/paranoid-linux

cd ~/git/hub/paranoid-linux

git clone --recurse-submodules git@github.com:paranoid-linux/torrific-lynx.git

Install via a symbolic link to a directory listed within your system's PATH variable, eg...

cd ~/git/hub/paranoid-linux/torrific-lynx

ln -s "${PWD}/torrific-lynx" "${HOME}/bin/"

Update configurations files if defaults need modifications...

cd ~/git/hub/paranoid-linux/torrific-lynx

sudo ./update-configs.sh --help

---

Usage

Call script with --help option to list available parameters...

torrific-lynx --help

Pass a URL on the command-line to start Lynx and load that site...

torrific-lynx 'https://duckduckgo.com'

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

• Fork this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...

cd ~/git/hub/paranoid-linux/torrific-lynx

git remote add fork git@github.com:<NAME>/torrific-lynx.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/paranoid-linux/torrific-lynx


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Attribution

• GitHub -- github-utilities/make-readme

• Reddit -- Hou to use Lynx over Tor?

• Lynx -- Description of settings in lynx configuration file

• StackOverflow -- How do I set proxy for Lynx?

• Unix StackExchange -- Lynx things all certificates are untrusted with my configuration file

• Tor StackExchange -- This is a socks proxy not an HTTP proxy

• Cloud Flare -- Introducing DNS Resolver for Tor

• CommandLineFu -- Join the content of a bash array with commas

---

License

Enables clear-net browsing over the Tor network via Lynx web browser
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.