Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Nov 12, 2022
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions traefik/nginx-auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
# 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:

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`.

##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.

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.
Next, move onto NGINX. First, open up your NGINX config, and make any alterations necessary for the traefik `proxy-pass`;
The container's IP will also work there.
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