idk/sam-forwarder
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
idk
2018-09-14 00:35:13 -04:00
parent 815e124555
commit a013524011
4 changed files with 20 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@@ -98,7 +98,8 @@ gendoc:
@echo "" >> USAGE.md @echo "" >> USAGE.md
@echo "$(samcatd) is a daemon which runs a group of forwarding proxies to" >> USAGE.md @echo "$(samcatd) is a daemon which runs a group of forwarding proxies to" >> USAGE.md
@echo "provide services over i2p independent of the router. It also serves" >> USAGE.md @echo "provide services over i2p independent of the router. It also serves" >> USAGE.md
@echo "as a generalized i2p networking utility for power-users." >> USAGE.md @echo "as a generalized i2p networking utility for power-users. Think of it" >> USAGE.md
@echo "as a Swiss-army knife for the SAM API." >> USAGE.md
@echo "" >> USAGE.md @echo "" >> USAGE.md
@echo "usage:" >> USAGE.md @echo "usage:" >> USAGE.md
@echo "------" >> USAGE.md @echo "------" >> USAGE.md

16
README.md.asc
View File

@@ -75,12 +75,12 @@ I'm eventually going to make the manager implement net.Conn. This won't be
exposed in the default application probably though, but rather as a library. exposed in the default application probably though, but rather as a library.
-----BEGIN PGP SIGNATURE----- -----BEGIN PGP SIGNATURE-----
iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlubN9sACgkQ11wDs5te iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlubOlYACgkQ11wDs5te
FOEKbgf/YMN6Dv6WpV+U6nQVcbxcW0+uq9+oI5CZ/+Egl1TSTKUnU6duDgCwquPq FOElZAgAnDxNbHBwEaHk2x/X+ic8lZzd4jxUXS3T7GrH+1s7IEsk6aH0oQnnHzwC
EZkN1cO1EdGWQVkjLdrm4ZDeJ665iPEoU6Mp4dgtvCiEdsGwvb+3YPep/KsADYVs i6IC2K7MjTlKy/cftFqHf2tWSAAv1VuNSqaAMzS/N3s4j6b+FVGf2WtZvpBlOLVE
n7F4in/FSpUTtMlQWQ2CdEGr29eMNIZ+9O3P39w26wHfd+1uUHPVraI6HAFUwCFj jnRf/otTwj7zZAOPGErmVwNXz3cA5jz2HH6585/oPK2vDWI3AZIe1ObOfP5TX0Jh
VwPd7zQEjdpeDKcSNa3WXdgd9qRFVD2ll16NwiuhFa4ZW/BYLGmZAts+9qpBtPR3 /DfHOxeeMhYdhd4YxLVTwHLjTtd52MdLKkco161nRwvz+qznSDsbFQF8JUzX9btY
FiHq4+8q750P0O6+3uuVA4y9AkHPNRC2hU0LlXRVtwG36geB+H8PpMIeIfW4ihgS GJGnc8HPKH0CgQ5VfZSQIdB+AlribYJHLMvtgE1R2z1atdHVT4rnoOeIxvB//EOE
st/wyZpCRATF7jsR33CCEXvanvgD9w== fWe3CxEJkqvg9H9uL/oU0AZQgzWSiw==
=ruzo =9+ck
-----END PGP SIGNATURE----- -----END PGP SIGNATURE-----

9
USAGE.md
View File

@@ -83,7 +83,8 @@ samcatd - Router-independent tunnel management for i2p
samcatd is a daemon which runs a group of forwarding proxies to samcatd is a daemon which runs a group of forwarding proxies to
provide services over i2p independent of the router. It also serves provide services over i2p independent of the router. It also serves
as a generalized i2p networking utility for power-users. as a generalized i2p networking utility for power-users. Think of it
as a Swiss-army knife for the SAM API.
usage: usage:
------ ------
@@ -117,7 +118,7 @@ Usage of ./bin/samcatd:
-iv int -iv int
Set inbound tunnel length variance(-7 to 7) Set inbound tunnel length variance(-7 to 7)
-k string -k string
path to saved encrypted leaseset keys (default "none") key for encrypted leaseset (default "none")
-l Use an encrypted leaseset(true or false) (default true) -l Use an encrypted leaseset(true or false) (default true)
-n string -n string
Tunnel name, this must be unique but can be anything. (default "forwarder") Tunnel name, this must be unique but can be anything. (default "forwarder")
@@ -131,6 +132,10 @@ Usage of ./bin/samcatd:
Set outbound tunnel length variance(-7 to 7) Set outbound tunnel length variance(-7 to 7)
-p string -p string
Target port(Port of service to forward to i2p) (default "8081") Target port(Port of service to forward to i2p) (default "8081")
-pk string
private key for encrypted leaseset (default "none")
-psk string
private signing key for encrypted leaseset (default "none")
-r Reduce tunnel quantity when idle(true or false) -r Reduce tunnel quantity when idle(true or false)
-rc int -rc int
Reduce idle tunnel quantity to X (0 to 5) (default 3) Reduce idle tunnel quantity to X (0 to 5) (default 3)

6
daemon/main.go
View File

@@ -58,11 +58,11 @@ var (
injectHeaders = flag.Bool("ih", false, injectHeaders = flag.Bool("ih", false,
"Inject X-I2P-DEST headers") "Inject X-I2P-DEST headers")
leaseSetKey = flag.String("k", "none", leaseSetKey = flag.String("k", "none",
"path to saved encrypted leaseset keys") "key for encrypted leaseset")
leaseSetPrivateKey = flag.String("pk", "none", leaseSetPrivateKey = flag.String("pk", "none",
"path to saved encrypted leaseset keys") "private key for encrypted leaseset")
leaseSetPrivateSigningKey = flag.String("psk", "none", leaseSetPrivateSigningKey = flag.String("psk", "none",
"path to saved encrypted leaseset keys") "private signing key for encrypted leaseset")
targetDir = flag.String("d", "", targetDir = flag.String("d", "",
"Directory to save tunnel configuration file in.") "Directory to save tunnel configuration file in.")
iniFile = flag.String("f", "none", iniFile = flag.String("f", "none",