README
¶
jnk (جنك)
A small utility to quickly configure OpenVPN services. Intended for development and testing.
Configuration
You can pass an ini-style config file with the --config flag.
In the [images] section you can override which images are used for each
service (by default it will use the latest in 0xacab registry for each
project).
- The
menshenblock is mandatory, since it's the main port that we will expose. - The
openvpnblock is optional. If it is enabled, it will run an OpenVPN container (TODO: auto-configure menshen to read vars from the control port). - The
bridge-xblocks are optional. It will run as manyobfsvpncontainers as needed for each type configured.
[images]
menshen = menshen-test
obfsvpn = obfsvpn-test
openvpn =
[menshen]
enabled = true
auto-tls = false
from-eip-url = https://black.riseup.net/3/config/eip-service.json
allow-gateway-list = true
allow-bridge-list = true
bridges = bridge-1:9090
[openvpn]
enabled = false
addr = localhost:1194
[bridge-1]
enabled = true
type = obfs4
gateway = 163.172.211.109:1194
location = amsterdam
addr = localhost:4430
[bridge-2]
enabled = false
type = obfs4-kcp
gateway = 163.172.211.109:1194
location = amsterdam
addr = localhost:4431
Documentation
¶
Overview ¶
Copyright © 2023 atanarjuat atanarjuat@riseup.net
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
config
config holds configuration for all the jnk application components
|
config holds configuration for all the jnk application components |
|
docker
docker contains functions to handle docker containers related to the OpenVPN and Bridge services.
|
docker contains functions to handle docker containers related to the OpenVPN and Bridge services. |