annotate docs/docker/api-only-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 # API Only: 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 This approach runs this API, either on port 80 or behind Traefik, either on docker swarm or single daemon.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
5
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
6 You need to have docker up and running on your server.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
7
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
8 - In your server, clone this repo, then `cd` to the cloned folder.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
9 - Copy the docker-compose file provided in `<repo_root>/docker/api-only/docker-compose.yml` to
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
10 the root of the cloned folder.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
11
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
12 You shall now have: `<repo_root>/docker-compose.yml`
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
13 - Modify the `<repo_root>/docker-compose.yml` to fit your needs and config
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
14
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
15 _Watch for volumes, docker swarm or single daemon, behind Traefik or not and the HOST value if behind traefik:_
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
16
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
17 In case you run behind Traefik, you need to setup the traefik router HOST
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
18
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
19 You need correctly setup traefik and docker network (here called proxy_external)
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
20
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
21 **(!) Make sure the mount volumes match correctly.**
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
22
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
23 * The first volume is the path to the www folder from the root of this repo.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
24
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
25 The path shall be a full path, or be next to this docker-compose.yml file.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
26
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
27 No parent folder navigation like `../../../` is allowed by docker.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
28
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
29 * The second volume is the path to the nginx server config file.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
30
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
31 This needs the commited nginx server config (or your own adapted version) to work properly.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
32
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
33 See the file `<repo_root>/docker/api-only/conf.d/pritunl-fake-api.conf` for more details.
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
34 - Run the updated `docker-compose.yml` file in daemon mode with:
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
35
b51518614818 New Files
Pluto <meokcin@gmail.com>
parents:
diff changeset
36 `docker-compose up -d`