annotate docs/docker/pritunl-patched-install.md @ 0:b51518614818 default tip

New Files
author Pluto <meokcin@gmail.com>
date Tue, 03 Sep 2024 15:57:25 +0800
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
1 # Fully Patched Pritunl: Using Docker
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
2
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
3 ## Only installs the API (webserver) and not the Pritunl VPN itself.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
4 You need to have docker up and running on your server.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
5
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
6 This uses the docker image for Pritunl by `goofball222/pritunl` and installs the fake api hooks directly into it.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
7
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
8
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
9 Step:
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
10
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
11 - In your server, clone this repo, then `cd` to the cloned folder.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
12 - Go to the `docker` folder of the repo.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
13 - Read the `<repo_root>/docker/docker-compose.yml` file carefully and edit to fit your needs (ports, volumes, network, server domain...)
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
14 - Run the `docker-compose.yml` file in daemon mode with:
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
15
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
16 `docker-compose up -d`
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
17
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
18 - This will `docker build` the patched pritunl container and run it on the following ports:
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
19 - Under this port the Pritunl web interface will be exposed (for reverse proxies)
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
20
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
21 *9700:9700*
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
22
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
23 - The following are the two default ports for the tcp+udp servers (you may edit these as needed!)
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
24
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
25 *1194:1194*
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
26
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
27 *1194:1194/udp*
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
28