thePR0M3TH3AN/VoxVera
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/VoxVera.git synced 2025-09-08 06:58:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #96 from PR0M3TH3AN/codex/add-detailed-installation-and-configuration-instructions-for

Browse Source 
Improve Tor install docs
This commit is contained in:
thePR0M3TH3AN
2025-06-21 19:28:35 -04:00
committed by GitHub
parent 1b432817df 18b11f0a96
commit 1480a6b4da
1 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -90,11 +90,29 @@ Run `voxvera check` to see missing dependencies.
The `voxvera/resources/tor/*` folders only contain small text files named
`placeholder`. VoxVera expects real `tor` and `obfs4proxy` binaries in those
locations when running `voxvera serve` or the Electron GUI. Install the tools
manually (for example with `apt install tor obfs4proxy`) and set the
environment variables `TOR_SOCKS_PORT` and `TOR_CONTROL_PORT` before launching.
You may also run `scripts/download_tor.sh` to fetch prebuilt binaries and
replace the placeholders.
locations when running `voxvera serve` or the Electron GUI.
**Option 1: install via your package manager**
```bash
sudo apt update && sudo apt install tor obfs4proxy
# or on macOS
brew install tor obfs4proxy
```
Ensure the Tor daemon is running (`sudo service tor start` on Linux).
**Option 2: use the helper script**
```bash
scripts/download_tor.sh
```
The script downloads the official Tor expert bundle for your OS and places the
executables under `voxvera/resources/tor/<platform>`.
After installing either way, set the ports used by Tor:
```bash
export TOR_SOCKS_PORT=9050
export TOR_CONTROL_PORT=9051
```
Run `voxvera check` to confirm the binaries are detected before launching.
---