Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
99 lines (79 sloc) 2.62 KB
project:
name: "Torproxy"
oneLiner: "An easy way to proxy your http requests through the onion network"
state: "beta"
image: ""
website: "https://torproxy.okkur.org"
description: |
Route your http requests through the onion network without Tor browser
version: "v0.2.0"
vision:
type: "community"
overview: |
Providing a fast and simple way to proxy your http requests through the onion network
items:
- "Simple and minimal config"
- "Proxy multiple hosts to a single endpoint"
concept: "Torproxy's core concept is to provide a simple way to proxy your http requsts using Caddy without needing to write complex logics and config"
aim: "Our aim is to provide a secure and easy way to access onion network on any device."
contributionLinks:
issueTemplate: "/.github/ISSUE_TEMPLATE.md"
starterIssues: "https://github.com/okkur/torproxy/labels/starter%20issue"
supportLinks:
documentation: "/docs"
readme:
usageExample: |
First you need to install Tor on your machine. Take a look at the [Tor download instructions](https://www.torproject.org/download/)
You can get torproxy as a plugin on caddy's [build server](https://caddyserver.com/download).
Or install torproxy using `go get`.
```
go get -u go.okkur.org/torproxy/cmd/torproxy
```
Create a config file.
```
example.test {
torproxy example.test somewhereonthe.onion
}
```
Now you can run torproxy.
```
torproxy -conf tor.test
```
docs:
development: |
Run the following command to get torproxy's source code and switch your working directory to the torproxy repository
```
git clone github.com/okkur/torproxy && cd torproxy
```
Then run the following command to download the dependencies to your local cache
```
go mod download
```
Do not forget to install Tor itself on your machine since torproxy needs that to operate correctly.
emails:
commercialSupport: "support@okkur.org"
security: "security@okkur.org"
coc: "coc@okkur.org"
copyright:
owner: "The Torproxy authors"
year: "2019"
cla:
copyrightHolder: "nzt.ventures GmbH"
mail: "legal@nzt.ventures"
maintainers:
- name: "Michael Grosser"
nick: "stp-ip"
repo:
link: "https://torproxy.okkur.org/code"
type: "Github"
badges:
- image: "https://img.shields.io/badge/state-beta-blue.svg"
alt: "state"
- image: "https://img.shields.io/github/release/okkur/torproxy.svg"
link: "https://github.com/okkur/torproxy/releases"
alt: "release"
- image: "https://img.shields.io/github/license/okkur/torproxy.svg"
link: "LICENSE"
alt: "license"
reposeed:
configVersion: "v1"
You can’t perform that action at this time.