Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hanadalee/ngx_http_server_redirect_module

Redirect server name in the same request
https://github.com/hanadalee/ngx_http_server_redirect_module

nginx nginx-module nginx-server

Last synced: 3 days ago
JSON representation

Redirect server name in the same request

Host: GitHub
URL: https://github.com/hanadalee/ngx_http_server_redirect_module
Owner: HanadaLee
License: bsd-2-clause
Created: 2024-12-21T11:39:52.000Z (11 days ago)
Default Branch: master
Last Pushed: 2024-12-25T13:32:59.000Z (7 days ago)
Last Synced: 2024-12-25T14:21:00.938Z (7 days ago)
Topics: nginx, nginx-module, nginx-server
Language: C
Homepage:
Size: 26.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# ngx_http_server_redirect_module

## Table of Contents

- [ngx\_http\_server\_redirect\_module](#ngx_http_server_redirect_module)
- [Table of Contents](#table-of-contents)
- [Description](#description)
- [Status](#status)
- [Installation](#installation)
- [Synopsis](#synopsis)
- [Basic Redirection](#basic-redirection)
- [Conditional Redirection](#conditional-redirection)
- [Configuration](#configuration)
- [Directive: `server_redirect`](#directive-server_redirect)
- [Directive: `schedule_redirect`](#directive-schedule_redirect)
- [Variable: `$server_redirect_original_host`](#variable-server_redirect_original_host)
- [Author](#author)
- [License](#license)

---

## Description

The `ngx_http_server_redirect_module` is a custom nginx module designed to facilitate dynamic server redirection based on configurable rules. It allows users to redirect incoming requests to different servers conditionally.

## Status
This Nginx module is currently considered experimental. Issues and PRs are welcome if you encounter any problems.

## Installation

To use theses modules, configure your nginx branch with --add-module=/path/to/ngx_http_server_redirect_module.

## Synopsis

### Basic Redirection
Redirect all requests to `newserver.com` unconditionally.

```nginx
http {
server {
listen 80;
server_name example.com;

server_redirect newserver.com;

location / {
proxy_pass http://newserver.com;
}
}

server {
listen 80;
server_name newserver.com;

# You can get original host from this variable.
add_header x-original-host $server_redirect_original_host;

location / {
proxy_pass http://upstream.com;
}
}
}
```

### Conditional Redirection

Redirect requests based on the presence of a specific header.

```nginx
http {
server {
listen 80;
server_name example.com;

# Redirect if request has 'X-Redirect' header and value is not 0 or empty.
server_redirect newserver.com if=$http_x_redirect;

# You can use ngx_http_var_module to generate judgment variables based on conditions.
# https://git.hanada.info/hanada/ngx_http_var_module
# var $is_ipv6 if_find $remote_addr :;
# server_redirect newserver.com if=$is_ipv6;

# This module takes effect after the real_ip module,
# Therefore, the real_ip module's directives will take effect on the server before server redirect.
# real_ip_header x-client-ip;

location / {
proxy_pass http://newserver.com;
}
}

server {
listen 80;
server_name newserver.com;

# You can get original host from this variable.
add_header x-original-host $server_redirect_original_host;

location / {
proxy_pass http://upstream.com;
}
}
}
```

### Schedule Redirection

Redirect the current request to another server from the first request path.
If request `http://example.com/newserver.com/test?arg=1`, it will be redirect to `http:///newserver.com/test?arg=1`. This process is internal and no 302 redirection will occur.
```nginx
http {
server {
listen 80;
server_name example.com;

# Enable schedule redirection.
schedule_redirect on;

# Requests will not arrive here unless the first path in the request path does not exist or the host in the first path is invalid.
return 400 "request path invalid";
}

server {
listen 80;
server_name newserver.com;

# You can get original host from this variable.
add_header x-original-host $server_redirect_original_host;

location / {
proxy_pass http://upstream.com;
}
}
}
```

## Configuration

### Directive: `server_redirect`

**Syntax:** *server_redirect target_host [if=condition]*

**Default:** *-*

**Context:** *server*

Redirect the current request to another server. The target server must have the same listening port as the current server.

The target host should be a specific host name just like the host in the request header. Even if the target server you want to redirect to is a wildcard domain name or a regular expression.

If the target server cannot be found, it will be redirected to the default server.

The if parameter enables conditional redirection. A request will not be redirected if the condition evaluates to “0” or an empty string. In addition, you can also use the form of `if!=` to make negative judgments.

Here is an example:

```nginx
server_redirect newserver.com if=$http_server_redirect;
```

This example redirects requests to `newserver.com` if the `Server-Redirect` header has value and value is not 0.

### Directive: `schedule_redirect`

**Syntax:** *schedule_redirect on | off*

**Default:** *schedule_redirect off*

**Context:** *server*

Redirect the current request to another server from the first request path.

If enabled, when accessing http://a.com/b.com/, the request will be redirected to http://b.com/. If the target server cannot be found, it will be redirected to the default server.

When server_redirect directive exists and meets the redirection conditions, server_redirect will be executed first.

If the request path does not have the first path (such as the home page), no redirection will be made.

After redirection, even $request_uri will be cleared of the first path. You can only find the original request path in the request line variable $request.

### Variable: `$server_redirect_original_host`

Keeps the original value of variable $host before redirection occurs.

## Author

Hanada [email protected]

## License

This Nginx module is licensed under [BSD 2-Clause License](LICENSE).