diff --git a/GUIDE.md b/GUIDE.md index e414294..8291189 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -23,7 +23,7 @@ ## Installation -Installation of Shynet is easy! Follow the [Basic Installation](#basic-installation) guide or the [Basic Installation with Docker Compose](#basic-installation-with-docker-compose) below for a minimal installation, or if you are going to be running Shynet over HTTPS through a reverse proxy. If you'd like to run Shynet over HTTPS without a reverse proxy, skip ahead to [Installation with SSL](#installation-with-ssl) instead. +Installation of Shynet is easy! Follow the [Basic Installation](#basic-installation) guide or the [Basic Installation with Docker Compose](#basic-installation-with-docker-compose) below for a minimal installation, or if you are going to be running Shynet over HTTPS through a reverse proxy. > **These commands assume Ubuntu.** If you're installing Shynet on a different platform, the process will be different. @@ -96,40 +96,6 @@ See the [Render docs](https://render.com/docs/deploy-shynet) for more informatio ## Advanced Usage -### Installation with SSL - -If you are going to be running Shynet through a reverse proxy, please see [Configuring a Reverse Proxy](#configuring-a-reverse-proxy) instead. - -0. We'll be cloning this into the home directory to make this installation easier, so run `cd ~/` if you need to. - -1. Instead of pulling from Docker, we will be pulling from GitHub and building using Docker in order to easily add SSL certificates. You will want to run `git clone https://github.com/milesmcc/shynet.git` to clone the GitHub repo to your current working directory. - -2. To install `certbot` follow [the guide here](https://certbot.eff.org/instructions) or follow along below - * Ubuntu 18.04 - * `sudo apt-get update` - * `sudo apt-get install software-properties-common` - * `sudo add-apt-repository universe` - * `sudo add-apt-repository ppa:certbot/certbot` - * `sudo apt-get update` - * `sudo apt-get install certbot` - -3. Run `sudo certbot certonly --standalone` and follow the instructions to generate your SSL certificate. - * If you registering the certificate to a domain name like `example.com`, please be sure to point your DNS records to your current server before running `certbot`. - -4. We are going to move the SSL certificates to the Shynet repo with with command below. Replace `` with the domain name you used in step 3. - * `cp /etc/letsencrypt/live//{cert,privkey}.pem ~/shynet/shynet/` - -5. With that, we are going to replace the `webserver.sh` with `ssl.webserver.sh` to enable the use of SSL certificates. The original `webserver.sh` will be backed up to `backup.webserver.sh` - * `mv ~/shynet/shynet/webserver.sh ~/shynet/shynet/backup.webserver.sh` - * `mv ~/shynet/shynet/ssl.webserver.sh ~/shynet/shynet/webserver.sh` - -6. Now we build the image! - * `docker image build shynet -t shynet-ssl:latest` - -7. Have a PostgreSQL server ready to go. This can be on the same machine as the deployment, or elsewhere. You'll just need a username, password, host, and port (default is `5432`). (For info on how to setup a PostgreSQL server on Ubuntu, follow [this guide](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-18-04)). - -8. Follow the [Basic Installation](#basic-installation) guide with just one modification: in step #4, change the local bind port from `80` to `443`, and use `shynet-ssl:latest` as your Docker image instead of `milesmcc/shynet:latest`. - ### Configuring a Reverse Proxy A reverse proxy has many benefits. It can be used for DDoS protection, caching files to reduce server load, routing HTTPS and/or HTTP connections, hosting multiple services on a single server, [and more](https://www.cloudflare.com/learning/cdn/glossary/reverse-proxy/)!