schmunk42 / docker-nginx-redirect

Docker container for redirecting web-traffic based on nginx

docker-nginx-redirect

A very simple container to redirect HTTP traffic to another server, based on nginx

Resources

• Docker Hub

Configuration

Environment variables

• SERVER_REDIRECT - server to redirect to, eg. www.example.com
• SERVER_NAME - optionally define the server name to listen on eg. ~^www.(?<subdomain>.+).example.com
  • useful for capturing variable to use in server_redirect.
• SERVER_REDIRECT_PATH - optionally define path to redirect all requests eg. /landingpage
  • if not set nginx var $request_uri is used
• SERVER_REDIRECT_SCHEME - optionally define scheme to redirect to
  • if not set but X-Forwarded-Proto is send as request header with value 'https' this will be used. In all other cases nginx var $scheme is used
• SERVER_REDIRECT_CODE - optionally define the http status code to use for redirection
  • if not set or not in list of allowed codes 301 is used as default
  • allowed Codes are: 301, 302, 303, 307, 308
• SERVER_REDIRECT_POST_CODE - optionally define the http code to use for POST redirection
  • useful if client should not change the request method from POST to GET
  • if not set or not in allowed Codes SERVER_REDIRECT_CODE is used
  • so per default all requests will be redirected with the same status code
• SERVER_REDIRECT_PUT_PATCH_DELETE_CODE - optionally define the http code to use for PUT, PATCH and DELETE redirection
  • useful if client should not change the request method from PUT, PATCH and DELETE to GET
  • if not set or not in allowed Codes SERVER_REDIRECT_CODE is used
  • so per default all requests will be redirected with the same status code
• SERVER_ACCESS_LOG - optionally define the location where nginx will write its access log
  • if not set /dev/stdout is used
• SERVER_ERROR_LOG - optionally define the location where nginx will write its error log
  • if not set /dev/stderr is used

See also docker-compose.yml file.

Usage

With docker-compose

docker-compose up -d

With docker

docker run -e SERVER_REDIRECT=www.example.com -p 8888:80 schmunk42/nginx-redirect
docker run -e SERVER_REDIRECT=www.example.com -e SERVER_REDIRECT_PATH=/landingpage -p 8888:80 schmunk42/nginx-redirect
docker run -e SERVER_REDIRECT=www.example.com -e SERVER_REDIRECT_PATH=/landingpage -e SERVER_REDIRECT_SCHEME=https -p 8888:80 schmunk42/nginx-redirect

---

Built by dmstr

docker-nginx-redirect's Issues

Image isn't automatically updated

This image was last updated on Dockerhub about a year ago, but the base alpine image was last updated a month ago. This I think is something which would be fairly straightforward to fix by using the specific alpine version in the dockerfile, implementing dependabot and a couple of actions to automerge updates, and having dockerhub rebuild on repo update (which may well already be the case).

PR shortly. :)

Query strings

When i try to use query strings in the redirect i get errors about not valid paths or valid redirect. But if i add the full url directly to defualt.conf no issues. Full url with query string works fine. Seems like this just needs to be supported.

issues about redirect between webs

Greetings!
I am trying to set an online viewer of books and pics.
Work layout likes:

1. list links.
2. people hit links and target to purchase webs.
3. people direct to webs of pics or books to read online.
4. purchase lock with their devices or IPs.

I dont know its too complex or what. but its really mass for me. May you help me this?

Thank you!

http redirect instead of https

Hello,

I use this docker image to redirect visitors from my www subdomain to my main website and combined it with jwilder/nginx-proxy and jrcs/letsencrypt-nginx-proxy-companion.

However my https://www.martinvw.nl now redirects to http://martinvw.nl which redirect to https://martinvw.nl. Ideally it should directly do the proper redirect, do you have any suggestions or are you open to receive a PR where I also make the $scheme configurable?

Thanks!