├── wireguard └── .placeholder ├── traefik ├── dynamic │ └── tls.yml └── traefik.yml ├── env.example ├── whoami └── docker-compose.yml ├── docker-compose.yml ├── setup.sh ├── README.md └── LICENSE /wireguard/.placeholder: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /traefik/dynamic/tls.yml: -------------------------------------------------------------------------------- 1 | tls: 2 | options: 3 | default: 4 | minVersion: VersionTLS12 5 | sniStrict: true 6 | curvePreferences: 7 | - secp521r1 8 | - secp384r1 9 | -------------------------------------------------------------------------------- /env.example: -------------------------------------------------------------------------------- 1 | LE_EMAIL=myemail@example.com 2 | TIMEZONE=America/Los_Angeles 3 | FORWARDED_PORTS=80,443 4 | EXT_INTERFACE=eth0 5 | WG_HOSTNAME=example.com 6 | WG_PORT=41510 7 | AUTH_USER=myuser 8 | AUTH_PASSWORD=mypass 9 | DOCKER_DATA_PATH=./ 10 | -------------------------------------------------------------------------------- /whoami/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3" 2 | 3 | services: 4 | whoami: 5 | image: "containous/whoami" 6 | container_name: "whoami" 7 | labels: 8 | - "traefik.enable=true" 9 | - "traefik.http.routers.whoami.entrypoints=https" 10 | - "traefik.http.routers.whoami.rule=Host(`whoami.example.com`)" 11 | - "traefik.http.routers.whoami.tls=true" 12 | - "traefik.http.routers.whoami.tls.certresolver=http" 13 | - "traefik.http.routers.whoami.service=whoami" 14 | - "traefik.http.services.whoami.loadbalancer.server.port=80" 15 | networks: 16 | - dmz 17 | 18 | networks: 19 | dmz: 20 | external: true 21 | -------------------------------------------------------------------------------- /traefik/traefik.yml: -------------------------------------------------------------------------------- 1 | api: 2 | dashboard: true 3 | 4 | entryPoints: 5 | http: 6 | address: ":80" 7 | forwardedHeaders: 8 | trustedIPs: 9 | - 173.245.48.0/20 10 | - 103.21.244.0/22 11 | - 103.22.200.0/22 12 | - 103.31.4.0/22 13 | - 141.101.64.0/18 14 | - 108.162.192.0/18 15 | - 190.93.240.0/20 16 | - 188.114.96.0/20 17 | - 197.234.240.0/22 18 | - 198.41.128.0/17 19 | - 162.158.0.0/15 20 | - 104.16.0.0/12 21 | - 172.64.0.0/13 22 | - 131.0.72.0/22 23 | https: 24 | address: ":443" 25 | forwardedHeaders: 26 | trustedIPs: 27 | - 173.245.48.0/20 28 | - 103.21.244.0/22 29 | - 103.22.200.0/22 30 | - 103.31.4.0/22 31 | - 141.101.64.0/18 32 | - 108.162.192.0/18 33 | - 190.93.240.0/20 34 | - 188.114.96.0/20 35 | - 197.234.240.0/22 36 | - 198.41.128.0/17 37 | - 162.158.0.0/15 38 | - 104.16.0.0/12 39 | - 172.64.0.0/13 40 | - 131.0.72.0/22 41 | 42 | serversTransport: 43 | insecureSkipVerify: true 44 | 45 | providers: 46 | file: 47 | directory: /dynamic 48 | docker: 49 | endpoint: "unix:///var/run/docker.sock" 50 | exposedByDefault: false 51 | network: dmz 52 | 53 | certificatesResolvers: 54 | http: 55 | acme: 56 | email: myemail@example.com 57 | storage: acme.json 58 | httpChallenge: 59 | entryPoint: http 60 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3" 2 | 3 | services: 4 | wireguard: 5 | image: linuxserver/wireguard 6 | container_name: wireguard 7 | cap_add: 8 | - NET_ADMIN 9 | - SYS_MODULE 10 | environment: 11 | - "PUID=1000" 12 | - "PGID=1000" 13 | - "TZ=${TIMEZONE}" 14 | - "SERVERURL=${WG_HOSTNAME}" 15 | - "SERVERPORT=${WG_PORT}" 16 | dns: 17 | - 1.1.1.1 18 | - 8.8.8.8 19 | - 64.6.64.6 20 | #healthcheck: 21 | #test: ["CMD", "curl", "--interface", "wg0", "-o", "/dev/null", "-m", "3", "-s", "https://1.1.1.1/dns-query?ct=application/dns-json&name=www.google.com&type=AAAA"] 22 | #interval: 1m30s 23 | #timeout: 10s 24 | #retries: 3 25 | volumes: 26 | - ${DOCKER_DATA_PATH}/wireguard/:/config/ 27 | - /lib/modules/:/lib/modules/:ro 28 | labels: 29 | - "com.centurylinklabs.watchtower.depends-on=traefik" 30 | - "com.ouroboros.depends_on=traefik" 31 | sysctls: 32 | - "net.ipv4.conf.all.src_valid_mark=1" 33 | restart: unless-stopped 34 | networks: 35 | - dmz 36 | 37 | traefik: 38 | image: traefik:latest 39 | container_name: traefik 40 | network_mode: "service:wireguard" 41 | depends_on: 42 | - wireguard 43 | environment: 44 | - "TZ=${TIMEZONE}" 45 | volumes: 46 | - ${DOCKER_DATA_PATH}/traefik/traefik.yml:/traefik.yml 47 | - ${DOCKER_DATA_PATH}/traefik/dynamic/:/dynamic/ 48 | - ${DOCKER_DATA_PATH}/traefik/acme.json:/acme.json 49 | - /var/run/docker.sock:/var/run/docker.sock:ro 50 | labels: 51 | - "traefik.enable=true" 52 | - "traefik.http.middlewares.traefik-auth.basicauth.users=myuser:mypasshash" 53 | - "traefik.http.routers.http_catchall.rule=HostRegexp(`{any:.+}`)" 54 | - "traefik.http.routers.http_catchall.entrypoints=http" 55 | - "traefik.http.routers.http_catchall.middlewares=https_redirect" 56 | - "traefik.http.middlewares.https_redirect.redirectscheme.scheme=https" 57 | - "traefik.http.middlewares.https_redirect.redirectscheme.permanent=true" 58 | - "traefik.http.routers.traefik-secure.entrypoints=https" 59 | - "traefik.http.routers.traefik-secure.rule=Host(`${WG_HOSTNAME}`)" 60 | - "traefik.http.routers.traefik-secure.middlewares=traefik-auth" 61 | - "traefik.http.routers.traefik-secure.tls=true" 62 | - "traefik.http.routers.traefik-secure.tls.certresolver=http" 63 | - "traefik.http.routers.traefik-secure.service=api@internal" 64 | - "traefik.http.services.traefik.loadbalancer.server.port=8080" 65 | restart: unless-stopped 66 | 67 | networks: 68 | dmz: 69 | external: true 70 | -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Use common vars from .env 4 | source .env 5 | 6 | # Ensure exit is properly trapped 7 | trap "exit $?" TERM 8 | 9 | # Set sane path 10 | PATH="/bin:/usr/bin:/sbin:/usr/sbin" 11 | 12 | # Set error Handlers 13 | error_exit() { 14 | echo "$(date) - ERROR - ${ERRMSG}" 15 | exit 1 16 | } 17 | 18 | # Ensure requirements are installed 19 | reqs_check() { 20 | # Check for dependencies 21 | ERRMSG="Dependency missing. Recommend 'sudo apt-get --no-install-recommends install apache2-utils wireguard'" 22 | which htpasswd &>/dev/null || error_exit 23 | which wg &>/dev/null || error_exit 24 | } 25 | 26 | # Generate key pairs 27 | gen_keys() { 28 | # Generate keys, first run only. 29 | 30 | PRIVKEY_WG_CLIENT="$(wg genkey)" 31 | echo "PRIVKEY_WG_CLIENT=${PRIVKEY_WG_CLIENT}" >> .env 32 | 33 | PUBKEY_WG_CLIENT="$(echo ${PRIVKEY_WG_CLIENT} | wg pubkey)" 34 | echo "PUBKEY_WG_CLIENT=${PUBKEY_WG_CLIENT}" >> .env 35 | 36 | PRIVKEY_WG_SERVER="$(wg genkey)" 37 | echo "PRIVKEY_WG_SERVER=${PRIVKEY_WG_SERVER}" >> .env 38 | 39 | PUBKEY_WG_SERVER="$(echo ${PRIVKEY_WG_SERVER} | wg pubkey)" 40 | echo "PUBKEY_WG_SERVER=${PUBKEY_WG_SERVER}" >> .env 41 | } 42 | 43 | # Generate server and client config files 44 | gen_wg_conf() { 45 | # Create wg0.conf for client 46 | cat > ${DOCKER_DATA_PATH}/wireguard/wg0.conf < ${DOCKER_DATA_PATH}/server-wg0.conf < ${DOCKER_DATA_PATH}/rules.v4 < ; cd v4raider``` 48 | 3. Set up your environment variables - more info below 49 | : ```cp env.example .env``` 50 | 4. Edit ```.env``` with your favorite editor and customize. You will require the 51 | interface name from your VPS. As well as have an A record that points to your 52 | VPS. 53 | 5. Run the script to generate configs 54 | : ```./setup.sh``` 55 | 6. Create dmz network 56 | : ```sudo docker create network dmz``` 57 | 7. Bring up wireguard and traefik 58 | : ```sudo docker-compose up -d``` 59 | 60 | This will generate rules.v4 and server-wg0.conf for your VPS. 61 | 62 | ## External Host (Your VPS) 63 | This host will forward ports to your wireguard and traefik containers. Usually 64 | 80 and 443. 65 | 66 | 1. Remove potential conflict. 67 | : ```sudo apt-get autoremove --purge ufw``` 68 | 2. Allow ip forwarding 69 | : ```echo 'net.ipv4.ip_forward = 1' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p``` 70 | 3. Install dependencies 71 | : ```sudo apt-get update && sudo apt-get --no-install-recommends install wireguard iptables-persistent``` 72 | 4. Place files generated on your docker host in the appropriate location. You 73 | can scp the files into the appropriate location or just paste in the content 74 | with your favorite text editor. 75 | : ```server-wg0.conf``` goes to ```/etc/wireguard/wg0.conf``` on this host 76 | : ```rules.v4``` goes to ```/etc/iptables/rules.v4``` on this host 77 | 5. Load iptables 78 | : ```sudo iptables-restore /etc/iptables/rules.v4``` 79 | 6. Start wireguard 80 | : ```sudo systemctl enable --now wg-quick@wg0``` 81 | 82 | ## What now? 83 | Nothing, you're done! Your traefik dashboard should be accessible externally 84 | now. Navigate to https://\/ and enter the username and password you set 85 | in the .env file. 86 | 87 | ## What about other containers? 88 | Add these settings to your docker-compose. 89 | 90 | ``` 91 | labels: 92 | - "traefik.enable=true" 93 | - "traefik.http.routers..entrypoints=https" 94 | - "traefik.http.routers..rule=Host(`.mydomain.tld`)" 95 | - "traefik.http.routers..tls=true" 96 | - "traefik.http.routers..tls.certresolver=http" 97 | - "traefik.http.routers..service=" 98 | - "traefik.http.services..loadbalancer.server.port=" 99 | networks: 100 | - dmz 101 | 102 | networks: 103 | dmz: 104 | external: true 105 | ``` 106 | 107 | You can go to the ```whoami``` directory and change line 10 of the 108 | docker-compose.yml to a CNAME (or second A record) pointing to your VPS. It's 109 | ready to go with a ```docker-compose up -d```. 110 | 111 | ## Environment File 112 | Be sure to follow the example as closely as possible. Do not use quotes around 113 | variables as docker-compose will choke on it. 114 | 115 | | Parameter | Function | 116 | | :----: | --- | 117 | | LE_EMAIL | Email address for LetsEncrypt registration | 118 | | TIMEZONE | Local time zone ex: America/Los_Angeles | 119 | | FORWARDED_PORTS | Usually 80,443 | 120 | | EXT_INTERFACE | External interface of your VPS, ens192 or eth0 | 121 | | WG_HOSTNAME | The A record pointing to your VPS | 122 | | WG_PORT | UDP port for Wireguard | 123 | | AUTH_USER | Traefik Dashboard Username | 124 | | AUTH_PASSWORD | Traefik Dashboard Password | 125 | | DOCKER_DATA_PATH | Where wireguard and traefik will store config | 126 | 127 | If you set DOCKER_DATA_PATH, be sure to copy over the traefik and wireguard 128 | subdirectories included after running ```./setup.sh``` on step 5. 129 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------