Mercurial > Pritunl-Fake-API

comparison docs/docker/api-only-install.md @ 0:b51518614818 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
New Files
author Pluto <meokcin@gmail.com>
date Tue, 03 Sep 2024 15:57:25 +0800
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:b51518614818
1 # API Only: Docker
2
3 ## Only installs the API (webserver) and not the Pritunl VPN itself.
4 This approach runs this API, either on port 80 or behind Traefik, either on docker swarm or single daemon.
5
6 You need to have docker up and running on your server.
7
8 - In your server, clone this repo, then `cd` to the cloned folder.
9 - Copy the docker-compose file provided in `<repo_root>/docker/api-only/docker-compose.yml` to
10 the root of the cloned folder.
11
12 You shall now have: `<repo_root>/docker-compose.yml`
13 - Modify the `<repo_root>/docker-compose.yml` to fit your needs and config
14
15 _Watch for volumes, docker swarm or single daemon, behind Traefik or not and the HOST value if behind traefik:_
16
17 In case you run behind Traefik, you need to setup the traefik router HOST
18
19 You need correctly setup traefik and docker network (here called proxy_external)
20
21 **(!) Make sure the mount volumes match correctly.**
22
23 * The first volume is the path to the www folder from the root of this repo.
24
25 The path shall be a full path, or be next to this docker-compose.yml file.
26
27 No parent folder navigation like `../../../` is allowed by docker.
28
29 * The second volume is the path to the nginx server config file.
30
31 This needs the commited nginx server config (or your own adapted version) to work properly.
32
33 See the file `<repo_root>/docker/api-only/conf.d/pritunl-fake-api.conf` for more details.
34 - Run the updated `docker-compose.yml` file in daemon mode with:
35
36 `docker-compose up -d`