update readme and linuxserver swag

This commit is contained in:
quackerd 2021-01-10 23:47:28 -05:00
parent 542334d914
commit 33abbe5893
Signed by: d
GPG Key ID: F73412644EDE357A
2 changed files with 5 additions and 6 deletions

View File

@ -3,7 +3,7 @@ Clean, dockerized v2ray(Websocket + TLS) + Nginx + Let's Encrypt with official a
## Supports:
- v2ray with websocket + TLS protocol using the [official v2ray docker image](https://hub.docker.com/r/v2ray/official/).
- Nginx frontend and **auto-renewing** Let's Encrypt certificate using the popular [linuxserver/letsencrypt docker image](https://hub.docker.com/r/linuxserver/letsencrypt/).
- Nginx frontend and **auto-renewing** Let's Encrypt certificate using the popular [linuxserver/swag](https://hub.docker.com/r/linuxserver/swag/).
- This project basically generates UUID, random paths and uses python to process the templates.
## Usage:
### Required packages
@ -12,12 +12,11 @@ Clean, dockerized v2ray(Websocket + TLS) + Nginx + Let's Encrypt with official a
- python-jinja2. A popular python template processor. Just search for jinja2 with your distro's package manager.
### Building
- Clone this repo.
- Clone this repo with your user instead of root.
- Make sure you run setup.py with your user instead of root otherwise Nginx will not start.
- Run `python setup.py -h` for directions.
- For example, if your full domain name is `aaa.bb.c` and your email is `d@e.f` then run `python setup.py -d bb.c -s aaa -e d@e.f`
- To start over, run `git reset --hard`. Don't run this with a running build or you will lose your existing config!
### README!
- Do NOT run the python script as root or Nginx won't start.
### Connecting
After spinning up all the containers, you can use client.conf to connect. If you are setting it up on your phone, connect to subdomain.domain.tld:443 and use websocket obfuscation.
@ -25,4 +24,4 @@ After spinning up all the containers, you can use client.conf to connect. If you
### Troubleshooting
- Make sure your subdomain.domain.tld points to the server.
- Use `docker logs nginx` to check for nginx init errors. Detailed nginx logs and be found in `nginx/logs/nginx`
- Use `docker logs v2ray` to check for v2ray init errors.
- Use `docker logs v2ray` to check for v2ray init errors.

View File

@ -7,7 +7,7 @@ networks:
services:
nginx:
container_name: nginx
image: linuxserver/letsencrypt
image: linuxserver/swag
restart: always
cap_add:
- NET_ADMIN