diff --git a/README.md b/README.md index d6a3fa7..69a89a7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ # SSSL DNS -This project contains a DNS server and a custom Nginx configuration intended to be used in conjunction with -[SSSL](https://github.com/PretendoNetwork/SSSL). +This project contains a DNS server and a custom Nginx configuration intended to be used in conjunction with [SSSL](https://github.com/PretendoNetwork/SSSL). ## Usage -The provided [example Docker Compose file](./compose.yml) shows a setup that runs both the DNS server and Nginx -together. Here's how to set it up: +The provided [example Docker Compose file](./compose.yml) shows a setup that runs both the DNS server and Nginx together. Here's how to set it up: 1. Clone this repository: `git clone https://github.com/PretendoNetwork/SSSL-DNS.git`. 2. Use [SSSL](https://github.com/PretendoNetwork/SSSL) to create your own patched SSL certficiates. 3. Copy the `cert-chain.pem` and `ssl-cert-private-key.pem` from SSSL to the `nginx` directory in this repository. -4. Create an Nginx configuration file `nginx.conf` in the `nginx` directory. Check the - [Nginx configuration README](./nginx/README.md) for more information. +4. Create an Nginx configuration file `nginx.conf` in the `nginx` directory. Check the [Nginx configuration README](./nginx/README.md) for more information. 5. Create a `.env` file in the `dns` directory. Check the [DNS server README](./dns/README.md) for more information. -6. Run `docker-compose up -d --build` to build and start your SSSL environment. This will take some time the first time - you run it but will be faster on subsequent runs. +6. Run `docker-compose up -d --build` to build and start your SSSL environment. This will take some time the first time you run it but will be faster on subsequent runs. diff --git a/dns/README.md b/dns/README.md index b40ee4c..02f93a3 100644 --- a/dns/README.md +++ b/dns/README.md @@ -1,12 +1,10 @@ # SSSL DNS server -Custom DNS server intended to be used in conjunction with [SSSL](https://github.com/PretendoNetwork/SSSL). It redirects -Nintendo hostnames to an SSSL-powered server using DNS spoofing. +Custom DNS server intended to be used in conjunction with [SSSL](https://github.com/PretendoNetwork/SSSL). It redirects Nintendo hostnames to an SSSL-powered server using DNS spoofing. ## Config -The only 2 addresses required are for `conntest.nintendowifi.net` and `account.nintendo.net`. These can either be set -using the default address or explicitly mapping them. Additional addresses may be added using `SSSL_DNS_MAP`. +The only 2 addresses required are for `conntest.nintendowifi.net` and `account.nintendo.net`. These can either be set using the default address or explicitly mapping them. Additional addresses may be added using `SSSL_DNS_MAP`. | Name | Description | Required | | -------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------- | @@ -15,12 +13,8 @@ using the default address or explicitly mapping them. Additional addresses may b | `SSSL_DNS_DEFAULT_ADDRESS` | The default address to use for `conntest.nintendowifi.net` and `account.nintendo.net`. | Only if not explicitly mapped. | | `SSSL_DNS_MAP_hostname` | An explicit mapping of a hostname to an address. | Only if not using the default address. | -These environment variables can be set manually or loaded from a `.env` file. See [example.env](./example.env) for an -example configuration. +These environment variables can be set manually or loaded from a `.env` file. See [example.env](./example.env) for an example configuration. ## Docker -The provided `Dockerfile` creates an image that runs the DNS server with Node.js. The configuration environment -variables should either be provided to the container directly or mounted as a `.env` file in `/home/node/app/.env`. The -[example Docker Compose file](../compose.yml) shows a setup that loads the configuration from a `.env` file in this -directory. +The provided `Dockerfile` creates an image that runs the DNS server with Node.js. The configuration environment variables should either be provided to the container directly or mounted as a `.env` file in `/home/node/app/.env`. The [example Docker Compose file](../compose.yml) shows a setup that loads the configuration from a `.env` file in this directory. diff --git a/nginx/README.md b/nginx/README.md index 6012521..e918805 100644 --- a/nginx/README.md +++ b/nginx/README.md @@ -1,24 +1,16 @@ # SSSL Nginx configuration -Nginx configuration intended to be used in conjunction with [SSSL](https://github.com/PretendoNetwork/SSSL). It supports -TLS 1.0/1.1 and legacy SSL ciphers, which are required for the Wii U. +Nginx configuration intended to be used in conjunction with [SSSL](https://github.com/PretendoNetwork/SSSL). It supports TLS 1.0/1.1 and legacy SSL ciphers, which are required for the Wii U. ## Configuration This uses standard Nginx configuration files. Use these two example files as a starting point: -- `nginx.default.conf` is a simple Nginx configuration file that displays the default Nginx welcome page. It shows the - basic configuration needed to create a server that uses an SSSL-patched certificate and supports the necessary legacy - SSL ciphers. -- `nginx.example.conf` is an example Nginx configuration file that shows how to reverse-proxy incoming requests to a - local Pretendo account server. +- `nginx.default.conf` is a simple Nginx configuration file that displays the default Nginx welcome page. It shows the basic configuration needed to create a server that uses an SSSL-patched certificate and supports the necessary legacy SSL ciphers. +- `nginx.example.conf` is an example Nginx configuration file that shows how to reverse-proxy incoming requests to a local Pretendo account server. ## Docker -The provided `Dockerfile` creates an image that compiles custom versions of OpenSSL and Nginx with support for TLS -1.0/1.1 and legacy SSL ciphers. Nginx is installed to `/opt/nginx`, so a custom configuration file should be mounted -into the container at `/opt/nginx/conf/nginx.conf` as shown in the [example Docker Compose file](../compose.yml). +The provided `Dockerfile` creates an image that compiles custom versions of OpenSSL and Nginx with support for TLS 1.0/1.1 and legacy SSL ciphers. Nginx is installed to `/opt/nginx`, so a custom configuration file should be mounted into the container at `/opt/nginx/conf/nginx.conf` as shown in the [example Docker Compose file](../compose.yml). -The default configuration requires an SSSL certificate to run. The `cert-chain.pem` and `ssl-cert-private-key.pem` files -generated by [SSSL](https://github.com/PretendoNetwork/SSSL) should be mounted into the container at `/opt/nginx/ssl/` -as `ca.pem` and `private.key` respectively, as shown in the [example Docker Compose file](../compose.yml). +The default configuration requires an SSSL certificate to run. The `cert-chain.pem` and `ssl-cert-private-key.pem` files generated by [SSSL](https://github.com/PretendoNetwork/SSSL) should be mounted into the container at `/opt/nginx/ssl/` as `ca.pem` and `private.key` respectively, as shown in the [example Docker Compose file](../compose.yml).