Edit nginx-auth's README.md to be clearer + fix rich text. (#75)

This commit is contained in:
ChillyEmber
2022-11-12 03:38:35 -05:00
committed by GitHub
parent 6d1d647455
commit ec99da9598
+6 -8
View File
@@ -1,25 +1,23 @@
# Installation guide for NGINX as a reverse proxy with authentication # Installation guide for NGINX as a reverse proxy with authentication
##How to start:
First, make sure that you have your `.htpasswd` file created, if you don't, you can follow this guide in the NGINX docs: First, make sure that you have your `.htpasswd` file created, if you don't, you can follow this guide in the NGINX docs:
https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-http-basic-authentication/ https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-http-basic-authentication/
This guide assumes that your `.htpasswd` file is located at `/etc/apache2/.htpasswd`. This guide assumes that your `.htpasswd` file is located at `/etc/apache2/.htpasswd`.
##Installation: #Installation:
Download your `docker-compose.yml` file, and make necessary changes to the environment variables, more notably, `NEKO_ROOMS_NAT1TO1` and `NEKO_ROOMS_INSTANCE_URL`. Download your `docker-compose.yml` file, and make necessary changes to the environment variables, more notably, `NEKO_ROOMS_NAT1TO1` and `NEKO_ROOMS_INSTANCE_URL`.
Run your docker-compose file, done by running `sudo docker-compose up -d` on Linux in the same directory as your compose file. Run your docker-compose file, done by running `sudo docker-compose up -d` on Linux in the same directory as your compose file.
Next, move onto NGINX. First, open up your NGINX config, and make any alterations necessary for the traefik `proxy-pass`. Next, move onto NGINX. First, open up your NGINX config, and make any alterations necessary for the traefik `proxy-pass`;
The Docker IP for the container can also work there, if necessary. The container's IP will also work there.
Your NGINX config at this point should be good to go, install and restart NGINX! Your NGINX config at this point should be good to go, install and restart NGINX!
##Certificates: #Certificates:
IF you wish to have SSL for Neko, you can use certbot to get that done! A guide is linked below for installation. If you wish to have SSL for Neko, you can use certbot to get that done! A guide is linked below for installation.
https://certbot.eff.org/instructions https://certbot.eff.org/instructions