Skip to content

Commit

Permalink
Update docs to use build server or vanity url
Browse files Browse the repository at this point in the history
  • Loading branch information
stp-ip committed Jul 30, 2019
1 parent 24b11a3 commit d4363a9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
14 changes: 8 additions & 6 deletions .seed-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ project:
website: "https://torproxy.okkur.org"
description: |
Route your http requests through the onion network without Tor browser
version: "v0.1.0"
version: "v0.2.0"

vision:
type: "community"
Expand All @@ -30,19 +30,21 @@ readme:
First you need to install the Tor on your machine. Check this page to download and learn how to install Tor: [Download Tor](https://www.torproject.org/download/)
Then install the torproxy using `go get`:
You can get torproxy as a plugin on caddy's [build server](https://caddyserver.com/download).
Or install torproxy using `go get`.
```
go get github.com/okkur/torproxy/cmd/torproxy
go get -u go.okkur.org/torproxy/cmd/torproxy
```
Create a config file like the below example:
Create a config file.
```
example.test {
torproxy example.test somewhereonthe.onion
}
```
Then run torproxy using this command:
Now you can run torproxy.
```
torproxy -conf tor.test
```
Expand All @@ -59,7 +61,7 @@ docs:
go mod download
```
Do not forget to install the Tor itself on your machine too since torproxy needs that to operate correctly.
Do not forget to install Tor itself on your machine since torproxy needs that to operate correctly.
emails:
commercialSupport: "[email protected]"
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,21 @@ Route your http requests through the onion network without Tor browser

First you need to install the Tor on your machine. Check this page to download and learn how to install Tor: [Download Tor](https://www.torproject.org/download/)

Then install the torproxy using `go get`:
You can get torproxy as a plugin on caddy's [build server](https://caddyserver.com/download).

Or install torproxy using `go get`.
```
go get github.com/okkur/torproxy/cmd/torproxy
go get -u go.okkur.org/torproxy/cmd/torproxy
```

Create a config file like the below example:
Create a config file.
```
example.test {
torproxy example.test somewhereonthe.onion
}
```

Then run torproxy using this command:
Now you can run torproxy.
```
torproxy -conf tor.test
```
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.1.0
v0.2.0
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Then run the following command to download the dependencies to your local cache
go mod download
```

Do not forget to install the Tor itself on your machine too since torproxy needs that to operate correctly.
Do not forget to install Tor itself on your machine since torproxy needs that to operate correctly.
# Documentation

No documentation available yet. Start your first contribution with some documentation.
Expand Down

0 comments on commit d4363a9

Please sign in to comment.