proxelar
Scriptable local traffic workbench for inspecting, intercepting, replaying, and rewriting HTTP/HTTPS and WebSocket traffic.
File Explorer
Download Latest Version (.zip)- config.toml
- bug_report.md
- custom.md
- feature_request.md
- ui.md
- autofix.yml
- changelog.yml
- deny.yml
- docs.yml
- release.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- 0.gif
- 1b.png
- 1w.png
- 2w.png
- 3b.png
- 3w.png
- 4b.png
- 5.png
- 5b.png
- 5w.png
- gui.gif
- tui.gif
- logo.png
- social-preview.html
- social-preview.png
- logo.png
- architecture.md
- browser-curl.md
- ca-trust.md
- lua-recipes.md
- reverse-proxy-mocking.md
- rules-and-api.md
- sessions-and-export.md
- forward.md
- reverse.md
- wireguard-socks-dns.md
- comparison.md
- limitations.md
- session-format.md
- threat-model.md
- api-reference.md
- examples.md
- overview.md
- ca-certificate.md
- cli-reference.md
- installation.md
- intercept.md
- interfaces.md
- introduction.md
- quick-start.md
- robots.txt
- sitemap.xml
- SUMMARY.md
- head.hbs
- book.toml
- init.lua
- proxelar-addon.json
- add_header.lua
- auth_inject.lua
- block_domain.lua
- filter_by_method.lua
- inject_cors.lua
- log_traffic.lua
- mock_api.lua
- modify_json_response.lua
- redirect.lua
- request_body_modify.lua
- rewrite_html.lua
- strip_cookies.lua
- event.rs
- handler.rs
- mod.rs
- state.rs
- ui.rs
- app.js
- index.html
- style.css
- mod.rs
- mod.rs
- terminal.rs
- browser.rs
- cli.rs
- main.rs
- wireguard_setup.rs
- Cargo.toml
- cert_server.rs
- mod.rs
- dns.rs
- forward.rs
- mod.rs
- outbound.rs
- raw.rs
- reverse.rs
- socks.rs
- tls.rs
- udp.rs
- wireguard.rs
- addon.rs
- body.rs
- content.rs
- encoding.rs
- error.rs
- event.rs
- filter.rs
- handler.rs
- intercept.rs
- lib.rs
- rewind.rs
- rules.rs
- scripting.rs
- session.rs
- cert_authority.rs
- cert_server.rs
- forward_proxy.rs
- reverse_proxy.rs
- Cargo.toml
- lib.rs
- serialization.rs
- Cargo.toml
- .dockerignore
- .gitignore
- AGENTS.md
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- cliff.toml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- deny.toml
- Dockerfile
- LICENSE-MIT
- README.md
- ROADMAP.md
- rust-toolchain.toml
- SECURITY.md
π Installation Guide
1. Get the code
git clone https://github.com/emanuele-em/proxelar
Downloads the entire project code from GitHub to your computer.
cd proxelar
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
- Rust (rustup) Rust is required to use cargo.
brew install proxelar
Installs the pre-built package via Homebrew β no source build required.
cargo install proxelar
Builds and installs the package published on crates.io β no need to clone the repo yourself.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -it -v ~/.proxelar:/root/.proxelar -p 8080:8080 -p 127.0.0.1:8081:8081 ghcr.io/emanuele-em/proxelar --interface gui --addr 0.0.0.0
Runs the built image as an actual container.
docker run --rm -it -v ~/.proxelar:/root/.proxelar -p 8080:8080 ghcr.io/emanuele-em/proxelar --interface terminal --addr 0.0.0.0
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo install proxelar
Builds and installs the package published on crates.io β no need to clone the repo yourself.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)