https://github.com/goetas/docker-nginx-redirect

Handle HTTP redirects with this simple docker image
https://github.com/goetas/docker-nginx-redirect

docker http nginx nginx-proxy redirect

Last synced: 12 days ago
JSON representation

Handle HTTP redirects with this simple docker image

• Host: GitHub
• URL: https://github.com/goetas/docker-nginx-redirect
• Owner: goetas
• License: mit
• Created: 2018-10-20T16:56:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-20T18:13:29.000Z (over 6 years ago)
• Last Synced: 2024-11-17T11:16:08.589Z (2 months ago)
• Topics: docker, http, nginx, nginx-proxy, redirect
• Language: Dockerfile
• Size: 6.84 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nginx redirect

This is a very simple nginx docker image that helps you redirecting HTTP requests to the `www` sub-domain.

**Rationale:**


It is a common use case to have a project on a hypothetical `www.example.com`. 

What about requests going to  `example.com`?


Of course you can configure your project to redirect requests to the `www` sub-domain...
 

What is this should happen only for the "production/live" environment and for "staging"? 

(as most likely is going to look something as `www-staging.example.com`).


On staging having `staging.example.com` to redirect to `www-staging.example.com` could make no sense and will 

require a different rule.

Redirecting to `www` is not responsibility of "your" application and can be done outside of it. 

Here it comes useful `goetas/nginx-redirect`. 

## Usage

Basic example, using a docker-compose file:

```yaml

services:

    www_redirector:

      image: goetas/nginx-redirect:latest

```

An more sophisticated use case is when used in combination with [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy):

```yaml

services:

    web:

      image: jwilder/nginx-proxy

      ports:

        - "80:80"

  

    myproject:

      image: myproject

      environment:

        VIRTUAL_HOST: www.example.com

         

    www_redirector:

      image: goetas/nginx-redirect:latest

      environment:

        VIRTUAL_HOST: example.com

```

In this example:

- `web`: is listening on the port 80 (is the only container exposed to the outside)

- `myproject`: is the image that holds the code for your project, 

   and does not need to be aware which is going to be the hostname where the "project" will be exposed.

   
_The proxy will forward to it requests that are directed to `www.example.com` (thanks to `VIRTUAL_HOST=www.example.com`)_

- `www_redirector`: redirects eventual requests from `http://example.com` to `http://www.example.com`

   
_The proxy will forward to it requests that are directed to `example.com` (thanks to `VIRTUAL_HOST=example.com`)_

   

   

## Configuration variables

Using environment variables is possible to customize the redirect-behaviour.

All the configurations are optional.

- `REDIRECT_CODE`: HTTP redirect code (the default is 301)

- `REDIRECT_SUBDOMAIN`: to which sub-domain redirect (the default is to prepend `www.` to the original hostname)

## Other info

The project supports properly HTTPS redirects and respects the `X-Forwarded-Proto` and `X-Forwarded-Port` headers.

This image is based on the latest nginx docker image.