redirection.io

https://redirection.io/documentation/
Admin
redirection.io is a comprehensive URL redirection management platform that helps websites handle...
Tokens:81,937
Snippets:1,238
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Build and Install Apache Module

Source: https://redirection.io/documentation/developer-documentation/apache-module

Compiles and installs the redirection.io Apache module.

```bash
unzip libapache2-mod-redirectionio-master.zip
cd libapache2-mod-redirectionio-master
autoreconf -i
./configure
make clean
make
sudo make install
```

--------------------------------

### Install Build Tools and Rustup

Source: https://redirection.io/documentation/developer-documentation/apache-module

Installs necessary build tools and the Rust toolchain for compiling the library.

```bash
# Debian-based distribution
apt install autoconf build-essential curl wget unzip
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y

apt install cargo wget unzip

# RedHat-based distribution
yum install -y epel-release yum-utils curl
yum -y groupinstall 'Development Tools'
curl https://sh.rustup.rs -sSf | sh
```

--------------------------------

### Clone Docker Example Repository

Source: https://redirection.io/documentation/developer-documentation/using-redirection-io-with-docker

Clones the official redirection.io Docker example project from GitHub to get started with various integration setups.

```bash
git clone https://github.com/redirectionio/docker-example.git
cd docker-example

```

--------------------------------

### Install redirection.io Nginx Module on Red Hat/RPM

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Install the `libnginx-mod-redirectionio` package using YUM.

```bash
sudo yum install libnginx-mod-redirectionio
```

--------------------------------

### Install Rust Compilation Tools

Source: https://redirection.io/documentation/developer-documentation/apache-module

Instructions for installing the necessary Rust compilation tools required for building the libredirectionio library.

```bash
curl https://sh.rustup.rs -sSf | sh
```

--------------------------------

### Install Nginx Compilation Tools

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Installs essential tools and libraries required for compiling the Nginx module. Select the command matching your operating system.

```bash
# Debian-based distribution
apt install nginx gawk libssl-dev libpcre3-dev libzip-dev libxml2-dev libxslt-dev libgd-dev libgeoip-dev libperl-dev
```

```bash
# RedHat-based distribution
yum module enable nginx:1.20 # or whatever version of your choice
yum install nginx
```

--------------------------------

### Install redirection.io Vercel Middleware

Source: https://redirection.io/documentation/developer-documentation/vercel-middleware-integration

Install the redirection.io Vercel middleware package using npm or yarn.

```bash
npm install @redirection.io/vercel-middleware

// or with yarn
yarn add @redirection.io/vercel-middleware
```

--------------------------------

### Minimal Agent Configuration (YAML)

Source: https://redirection.io/documentation/agent-documentation/examples/minimal-configuration

This is a minimal starting point for the agent configuration, declaring only the instance name. It's useful for validating basic setup before adding more directives.

```yaml
instance:
  name: "My Instance"
```

--------------------------------

### Install Rust Compilation Tools

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Installs Rust and necessary build tools for compiling the libredirectionio library. Choose the appropriate command for your distribution.

```bash
# Debian-based distribution
apt install autoconf build-essential curl wget unzip
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y
```

```bash
# RedHat-based distribution
yum install -y epel-release yum-utils wget pcre-devel openssl-devel libxslt-devel gd-devel perl-ExtUtils-Embed GeoIP-devel google-perftools-devel httpd httpd-devel curl
yum -y groupinstall 'Development Tools'
curl https://sh.rustup.rs -sSf | sh
```

--------------------------------

### Install Compilation Tools for Apache Module

Source: https://redirection.io/documentation/developer-documentation/apache-module

Installs essential tools like gawk and gcc required for compiling the Apache module.

```bash
# Debian-based distribution
apt install gawk

# RedHat-based distribution
yum install gcc gawk wget unzip
```

--------------------------------

### Install Rust Toolchain

Source: https://redirection.io/documentation/developer-documentation/fastly-compute-edge-integration

Installs the Rust toolchain required for building the Fastly Compute@Edge worker.

```bash
apt install autoconf build-essential curl wget unzip
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y
```

--------------------------------

### Install Agent on Red Hat/RPM

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

Install the redirection.io agent package using `yum` for older Red Hat systems or `dnf` for Fedora. Ensure the repository has been added prior to installation.

```bash
sudo yum install redirectionio-agent

```

```bash
# or (Fedora)
sudo dnf install redirectionio-agent

```

--------------------------------

### Upsun Application Configuration Example

Source: https://redirection.io/documentation/developer-documentation/upsun-integration

Shows how to configure application settings like type and web server locations within Upsun's config.yaml.

```yaml
applications:
    example-app:
        type: golang:1.25
        web:
            locations:
                "/":
                    root: "app"
                    passthru: "/index.html"

```

--------------------------------

### Install redirection.io Apache module on Red Hat

Source: https://redirection.io/documentation/developer-documentation/apache-module

Install the redirection.io Apache module using YUM.

```bash
sudo yum install libapache2-mod-redirectionio
```

--------------------------------

### Update APT Cache and Install Agent

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

Refresh the package list and install the redirection.io agent.

```bash
sudo apt update && sudo apt install redirectionio-agent

```

--------------------------------

### Minimal Agent Configuration

Source: https://redirection.io/documentation/agent-documentation/minimal-configuration

This is a minimal configuration example, including only the required options. If no instance name is provided, the server's hostname will be used.

```yaml
instance:
    name: 'My Instance'
```

--------------------------------

### Check and Install Apache Extension Tool (apxs)

Source: https://redirection.io/documentation/developer-documentation/apache-module

Verifies if apxs is installed and provides commands to install it if missing.

```bash
which apxs

# Debian-based distribution
apt install apache2-dev

# RedHat-based distribution
yum install httpd-devel

# Amazon Linux
yum install httpd24-devel
```

--------------------------------

### Create a Complete Rule with cURL

Source: https://redirection.io/documentation/developer-documentation/public-api

This example demonstrates how to create a comprehensive redirection rule using a cURL command. It includes various trigger conditions, actions, markers, variables, and examples. Ensure you replace 'HERE_GOES_THE_TOKEN' and 'PROJECT_ID' with your actual credentials.

```bash
curl \
    -XPOST https://api.redirection.io/rules \
    -H "Authorization: Bearer HERE_GOES_THE_TOKEN" \
    -H "Content-Type: application/json" \
    -d @- <<'EOF'
    {
        "project": "/projects/PROJECT_ID",
        "trigger": {
            "source": "/animals/@animalName",
            "methods": [
                "GET",
                "POST"
            ],
            "requestHeaders": [
                {
                    "name": "User-Agent",
                    "operator": "contains",
                    "value": "bot"
                }
            ],
            "responseStatusCodes": [
                418
            ],
            "ipAddress": {
                "type": "inRange",
                "start": "1.2.3.4",
                "end": "1.2.3.255"
            },
            "sampling": 23
        },
        "actions": [
            {
                "type": "customHtml",
                "value": "<!-- Hello -->",
                "location": "headStart"
            },
            {
                "type": "redirection",
                "location": "https://example.com/pets/@animal",
                "statusCode": 307
            },
            {
                "type": "header",
                "name": "X-Redirectionio-Method",
                "value": "The method for this request was: @httpMethod",
                "mode": "override"
            }
        ],
        "markers": [
            {
                "name": "animalName",
                "type": "enum",
                "values": [
                    "dog",
                    "cat",
                    "fish"
                ],
                "transformers": [
                    {
                        "type": "uppercase"
                    }
                ]
            }
        ],
        "variables": [
            {
                "type": "marker",
                "name": "animal",
                "marker": "animalName"
            },
            {
                "type": "requestMethod",
                "name": "httpMethod",
                "transformers": [
                    {
                        "type": "lowercase"
                    }
                ]
            }
        ],
        "examples": [
            {
                "mustMatch": true,
                "url": "https://example.com/animals/fish",
                "method": "GET",
                "responseStatusCode": 418,
                "headers": [
                    {
                        "name": "User-Agent",
                        "value": "example-bot/1.0"
                    }
                ],
                "ipAddress": "1.2.3.10"
            },
            {
                "mustMatch": true,
                "url": "https://example.com/animals/dog",
                "method": "POST",
                "responseStatusCode": 418,
                "headers": [
                    {
                        "name": "User-Agent",
                        "value": "generic-bot"
                    }
                ],
                "ipAddress": "1.2.3.118"
            },
            {
                "mustMatch": false,
                "url": "https://example.com/animals/cat",
                "method": "DELETE"
            }
        ],
        "description": "Some quite complete rule example",
        "enabled": true,
        "tags": [
            "animals",
            "api created rule"
        ]
    }
EOF
```

--------------------------------

### Get Agent Version

Source: https://redirection.io/documentation/agent-documentation/agent-command-line-options

Use the --version flag to display the currently installed version of the redirection.io agent.

```bash
redirectionio-agent -V
```

--------------------------------

### Manually Install Apache Module

Source: https://redirection.io/documentation/developer-documentation/apache-module

Provides steps for manually copying the compiled module to the Apache modules directory.

```bash
# change the module permissions
chmod 644 ./src/mod_redirectionio.so

# then, copy it to the right location
# (of course, use the path that you have found above)
sudo mv ./src/mod_redirectionio.so /etc/apache-custom/lib/apache-custom/
```

--------------------------------

### Full Agent Configuration Example (YAML)

Source: https://redirection.io/documentation/agent-documentation/examples/full-example

This example showcases most of the redirection.io agent configuration capabilities. It covers instance naming, caching, logging, persistence to S3, server listening, project keys, reverse proxy settings, TLS configuration, forwarding options, agent-specific settings, HTTP configurations, geo-IP lookup, access logging, certificate management (ACME and file-based), virtual hosts, metrics, and various logging outputs and levels.

```yaml
instance:
  name: "My Instance"
  cache: 10000
logging: true
test_mode: false
persist:
  endpoint: "https://s3.amazonaws.com"
  bucket: "my-bucket"
  access_key: "$AWS_ACCESS_KEY_ID"
  secret_key: "$AWS_SECRET_ACCESS_KEY"
  region: "$AWS_DEFAULT_REGION"
  max_logs_buffer_size: 100000
server:
  listen: "127.0.0.1:10301"
project_keys:
  - "my-project-key"
reverse_proxy:
  listen:
    - "tcp://0.0.0.0:80"
    - "tls://0.0.0.0:443"
    - "quic://0.0.0.0:443"
trusted_proxies:
  ips:
    - "192.168.0.0/16"
    - "172.16.0.16"
  forwarded: true
  x_forwarded_for: true
  x_forwarded_host: false
  x_forwarded_proto: false
forward:
  address: "backend:4443"
  max_http_version: "h1"
tls:
  sni: "example.com"
  allow_invalid_certificates: false
keep_alive:
  idle_timeout: "30s"
  born_timeout: "1h"
  max_requests: 10000
request_host: "dummy.com"
forwarded_for: "auto"
timeout:
  resolve: "100ms"
  connect: "100ms"
  tls_handshake: "100ms"
  request: "1s"
  response: "1s"
allow_ipv6: false
agent:
  project_key: "my-project-key"
  override_request_scheme: "https"
  override_request_host: "example.com"
  add_rules_ids_header: true
http:
  cache: true
  compress: true
geo_ip:
  path: "/path/to/geoip.mmdb"
headers:
  X-Geo-Country: "$.country.iso_code"
  X-Geo-City: "$.city.names.en"
  X-Geo-Latitude: "$.location.latitude"
access_log:
  output: "file"
  format: "json"
  path: "/var/log/access.log.json"
certificate:
  acme:
    contacts:
      - "myemail@example.com"
    directory_url: "https://acme-v02.api.letsencrypt.org/directory"
  file:
    key: "/path/to/cert.key"
    certificates:
      - "/path/to/chain.pem"
      - "/path/to/cert.pem"
server_threads: 1
worker_threads: 4
worker_max_blocking_threads: 1024
virtual_hosts:
  - domains:
      - "example.com"
      - "www.example.com"
    access_log:
      output: "stdout"
      format: "text"
  - domains:
      - "tls://media.example.com"
    forward:
      directory: "/var/www/media"
metrics:
  listen: "127.0.0.1:9000"
log:
  - output: "file"
    format: "json"
    path: "/var/log/redirection.log.json"
  - output: "stdout"
    format: "text"
    max_level: "info"
  - output: "stderr"
    format: "json"
    min_level: "warning"
  - output: "syslog"
    format: "rfc5424"
    address: "syslog-server:514"
```

--------------------------------

### Configure Multiple Virtualhosts

Source: https://redirection.io/documentation/agent-documentation/virtualhosts

This example shows how to define multiple virtual hosts, each with its own set of domains and project keys. Ensure specific virtual hosts are defined before more general ones to avoid routing conflicts.

```yaml
instance:
    name: 'My Instance'
reverse_proxy:
    listen:
        - 'tcp://0.0.0.0:80'
        - 'tls://0.0.0.0:443'
    forward:
        address: '127.0.0.1:8080'
    agent:
        project_key: DEFAULT_PROJECT_KEY
    certificate:
        acme:
            contacts:
                - myemail@example.com
            directory_url: 'https://acme-v02.api.letsencrypt.org/directory'
virtual_hosts:
    - 
        domains:
            - example.com
            - www.example.com
        agent:
            project_key: WEBSITE_PROJECT_KEY
    - 
        domains:
            - 'tls://media.example.com'
        forward:
            directory: /var/www/media
        agent:
            project_key: MEDIA_PROJECT_KEY
```

--------------------------------

### Install apt-transport-https on Debian

Source: https://redirection.io/documentation/developer-documentation/apache-module

Ensure apt-transport-https is installed before adding the redirection.io repository.

```bash
sudo apt-get install apt-transport-https
```

--------------------------------

### Install apt-transport-https Package

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

Ensure your system can handle HTTPS repositories.

```bash
sudo apt-get install apt-transport-https

```

--------------------------------

### Install redirection.io Ansible Role

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Install the `redirectionio.nginx_module` Ansible role using Ansible Galaxy.

```bash
ansible-galaxy install redirectionio.nginx_module
```

--------------------------------

### Update APT Cache and Install Nginx Module on Debian/Ubuntu

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Update the package list and install the `libnginx-mod-redirectionio` package.

```bash
sudo apt update && sudo apt install libnginx-mod-redirectionio
```

--------------------------------

### Install redirection.io Apache module using Ansible Galaxy

Source: https://redirection.io/documentation/developer-documentation/apache-module

Install the redirection.io Apache module using the official Ansible role.

```bash
ansible-galaxy install redirectionio.apache_module
```

--------------------------------

### Update APT cache and install redirection.io module

Source: https://redirection.io/documentation/developer-documentation/apache-module

Update the package list and install the redirection.io Apache module.

```bash
sudo apt update && sudo apt install libapache2-mod-redirectionio
```

--------------------------------

### Install Compiled Module

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Moves the compiled `ngx_http_redirectionio_module.so` file to the Nginx modules directory.

```bash
sudo mv objs/ngx_http_redirectionio_module.so /usr/lib/nginx/modules/
```

--------------------------------

### Install redirection.io Agent and Nginx Module

Source: https://redirection.io/documentation/knowledge-base/setting-up-a-redirection-server-on-azure-cloud

Installs the redirection.io agent and Nginx module on a Debian-based system. Ensure your system is updated and the repository key is added before running these commands.

```bash
sudo apt update && sudo apt dist-upgrade

sudo apt-get install apt-transport-https gnupg2

wget -q -O - https://packages.redirection.io/gpg.key | sudo apt-key add -

echo "deb https://packages.redirection.io/deb/stable/2 any main" | sudo tee -a /etc/apt/sources.list.d/packages_redirection_io_deb.list
echo "deb https://packages.redirection.io/deb/stable/2 bookworm main" | sudo tee -a /etc/apt/sources.list.d/packages_redirection_io_deb.list

sudo apt update && sudo apt install redirectionio-agent libnginx-mod-redirectionio
```

--------------------------------

### Configure Application Logs Outputs (YAML)

Source: https://redirection.io/documentation/agent-documentation/examples/application-logs-outputs

This example configures the log array with file, stdout, stderr, and syslog destinations using different formats (json, text, rfc5424). It demonstrates flexible operational logging for local and centralized observability pipelines.

```yaml
instance:
  name: "My Instance"
reverse_proxy:
  listen:
    - "tcp://0.0.0.0:80"
forward:
  address: "backend:8080"
agent:
  project_key: "my-project-key"
log:
  - output: "file"
    format: "json"
    path: "/var/log/redirection.log.json"
  - output: "stdout"
    format: "text"
  - output: "stderr"
    format: "json"
  - output: "syslog"
    format: "rfc5424"
    address: "syslog-server:514"
```

--------------------------------

### Configure File Access Logs (JSON Format)

Source: https://redirection.io/documentation/agent-documentation/access-logs

This example shows how to configure the agent to output access logs to a file in JSON format. Ensure the specified path is writable by the agent.

```yaml
instance:
    name: 'My Instance'
reverse_proxy:
    listen:
        - 'tcp://0.0.0.0:80'
    forward:
        address: 'backend:8080'
    agent:
        project_key: my-project-key
    access_log:
        output: file
        format: json
        path: /var/log/access.log.json
```

--------------------------------

### Create Rule

Source: https://redirection.io/documentation/developer-documentation/public-api

This example demonstrates how to create a new redirection rule using a POST request to the /rules endpoint. It includes a comprehensive payload with trigger conditions, actions, markers, variables, and examples.

```APIDOC
## POST /rules

### Description
Creates a new redirection rule.

### Method
POST

### Endpoint
https://api.redirection.io/rules

### Parameters
#### Request Body
- **project** (string) - Required - The project ID for which the rule is being created.
- **trigger** (object) - Required - Defines the conditions that trigger this rule.
  - **source** (string) - Required - The source URL path pattern.
  - **methods** (array of strings) - Optional - HTTP methods that trigger the rule.
  - **requestHeaders** (array of objects) - Optional - Headers that must be present or match a pattern.
    - **name** (string) - Required - Header name.
    - **operator** (string) - Required - Matching operator (e.g., 'contains').
    - **value** (string) - Required - Value to match.
  - **responseStatusCodes** (array of integers) - Optional - Response status codes that trigger the rule.
  - **ipAddress** (object) - Optional - IP address conditions.
    - **type** (string) - Required - Type of IP address condition (e.g., 'inRange').
    - **start** (string) - Required - Start of the IP range.
    - **end** (string) - Required - End of the IP range.
  - **sampling** (number) - Optional - Sampling rate for the trigger.
- **actions** (array of objects) - Required - Actions to perform when the rule is triggered.
  - **type** (string) - Required - Type of action (e.g., 'customHtml', 'redirection', 'header').
  - **value** (string) - Optional - Content for customHtml or URL for redirection.
  - **location** (string) - Optional - Where to insert custom HTML or the redirection URL.
  - **statusCode** (integer) - Optional - HTTP status code for redirection.
  - **name** (string) - Optional - Header name for header action.
  - **mode** (string) - Optional - Mode for header action (e.g., 'override').
- **markers** (array of objects) - Optional - Defines markers for extracting information from the request.
  - **name** (string) - Required - Marker name.
  - **type** (string) - Required - Type of marker (e.g., 'enum').
  - **values** (array of strings) - Optional - Allowed values for enum marker.
  - **transformers** (array of objects) - Optional - Transformations to apply to the marker value.
    - **type** (string) - Required - Type of transformer (e.g., 'uppercase').
- **variables** (array of objects) - Optional - Defines variables derived from markers or request details.
  - **type** (string) - Required - Type of variable (e.g., 'marker', 'requestMethod').
  - **name** (string) - Required - Variable name.
  - **marker** (string) - Optional - The name of the marker to derive the variable from.
  - **transformers** (array of objects) - Optional - Transformations to apply to the variable value.
    - **type** (string) - Required - Type of transformer (e.g., 'lowercase').
- **examples** (array of objects) - Optional - Example requests to test the rule.
  - **mustMatch** (boolean) - Required - Whether the example must match.
  - **url** (string) - Required - The example URL.
  - **method** (string) - Required - The example HTTP method.
  - **responseStatusCode** (integer) - Optional - The expected response status code.
  - **headers** (array of objects) - Optional - Example request headers.
    - **name** (string) - Required - Header name.
    - **value** (string) - Required - Header value.
  - **ipAddress** (string) - Optional - The example IP address.
- **description** (string) - Optional - A description for the rule.
- **enabled** (boolean) - Optional - Whether the rule is enabled.
- **tags** (array of strings) - Optional - Tags for categorizing the rule.

### Request Example
```json
{
    "project": "/projects/PROJECT_ID",
    "trigger": {
        "source": "/animals/@animalName",
        "methods": [
            "GET",
            "POST"
        ],
        "requestHeaders": [
            {
                "name": "User-Agent",
                "operator": "contains",
                "value": "bot"
            }
        ],
        "responseStatusCodes": [
            418
        ],
        "ipAddress": {
            "type": "inRange",
            "start": "1.2.3.4",
            "end": "1.2.3.255"
        },
        "sampling": 23
    },
    "actions": [
        {
            "type": "customHtml",
            "value": "<!-- Hello -->",
            "location": "headStart"
        },
        {
            "type": "redirection",
            "location": "https://example.com/pets/@animal",
            "statusCode": 307
        },
        {
            "type": "header",
            "name": "X-Redirectionio-Method",
            "value": "The method for this request was: @httpMethod",
            "mode": "override"
        }
    ],
    "markers": [
        {
            "name": "animalName",
            "type": "enum",
            "values": [
                "dog",
                "cat",
                "fish"
            ],
            "transformers": [
                {
                    "type": "uppercase"
                }
            ]
        }
    ],
    "variables": [
        {
            "type": "marker",
            "name": "animal",
            "marker": "animalName"
        },
        {
            "type": "requestMethod",
            "name": "httpMethod",
            "transformers": [
                {
                    "type": "lowercase"
                }
            ]
        }
    ],
    "examples": [
        {
            "mustMatch": true,
            "url": "https://example.com/animals/fish",
            "method": "GET",
            "responseStatusCode": 418,
            "headers": [
                {
                    "name": "User-Agent",
                    "value": "example-bot/1.0"
                }
            ],
            "ipAddress": "1.2.3.10"
        },
        {
            "mustMatch": true,
            "url": "https://example.com/animals/dog",
            "method": "POST",
            "responseStatusCode": 418,
            "headers": [
                {
                    "name": "User-Agent",
                    "value": "generic-bot"
                }
            ],
            "ipAddress": "1.2.3.118"
        },
        {
            "mustMatch": false,
            "url": "https://example.com/animals/cat",
            "method": "DELETE"
        }
    ],
    "description": "Some quite complete rule example",
    "enabled": true,
    "tags": [
        "animals",
        "api created rule"
    ]
}
```
```

--------------------------------

### Add Redirection.io Debian Repository

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

Configure APT to use the redirection.io stable repository for agent installation.

```bash
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/redirectionio-archive-keyring.asc] https://packages.redirection.io/deb/stable/3 any main" | sudo tee -a /etc/apt/sources.list.d/packages_redirection_io_deb.list > /dev/null

```

--------------------------------

### Add redirection.io APT repository for Debian 13

Source: https://redirection.io/documentation/developer-documentation/apache-module

Add the redirection.io APT repository to your sources list. This example is for Debian 13 (Trixie).

```bash
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/redirectionio-archive-keyring.asc] https://packages.redirection.io/deb/stable/3 trixie main" | sudo tee -a /etc/apt/sources.list.d/packages_redirection_io_deb.list > /dev/null
```

--------------------------------

### Install Rust Toolchain for Cloudflare Worker

Source: https://redirection.io/documentation/developer-documentation/cloudflare-workers-integration

Installs the necessary Rust toolchain and build tools for developing Cloudflare Workers. Ensure you use the current stable version.

```bash
apt install autoconf build-essential curl wget unzip
curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain 1.85.0 -y
```

--------------------------------

### Using Environment Variables in Configuration

Source: https://redirection.io/documentation/agent-documentation/agent-configuration-reference

Demonstrates how to use environment variables within the agent configuration file for dynamic settings. Ensure variables like REDIRECTIONIO_INSTANCE_NAME and REDIRECTIONIO_APPLICATION_DIR are defined when the agent starts.

```yaml
instance:
    name: "${REDIRECTIONIO_INSTANCE_NAME}"
    persist: "${REDIRECTIONIO_APPLICATION_DIR}/rules"
log:
    - 
        output: "file"
        level: "info"
        path: "${REDIRECTIONIO_APPLICATION_DIR}/log/agent.log"

```

--------------------------------

### Configure Virtual Host Specific Access Logs

Source: https://redirection.io/documentation/agent-documentation/access-logs

This example demonstrates configuring different access log settings for multiple virtual hosts. One virtual host logs to a file in text format, while another logs to a syslog server in RFC5424 format.

```yaml
instance:
    name: 'My Instance'
reverse_proxy:
    listen:
        - 'tcp://0.0.0.0:80'
    forward:
        address: 'backend:8080'
    agent:
        project_key: my-project-key
    virtual_hosts:
        - 
            domains:
                - example.com
                - www.example.com
            access_log:
                output: file
                format: text
                path: /var/log/example.com-access.log
        - 
            domains:
                - media.example.com
            forward:
                directory: /var/www/media
            access_log:
                output: syslog
                format: rfc5424
                address: 'syslog-server:514'
```

--------------------------------

### SysV Init Script for redirection.io Agent

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

A sample SysV Init script for the redirection.io agent. This script can be used on systems that do not use systemd, providing basic start, stop, and restart functionality.

```sh
#!/bin/sh
#
# redirectionio-agent start stop daemon for CentOS (sysvinit)
#
# chkconfig: - 64 36
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 2 3 4 6
# Required-Start:
# description: redirectionio-agent start stop daemon for CentOS
# processname: redirectionio-agent
# pidfile: none
# lockfile: /var/lock/subsys/redirectionio-agent

# Source function library.
. /etc/rc.d/init.d/functions

# Source networking configuration.
. /etc/sysconfig/network

# Check that networking is up.
[ "$NETWORKING" = "no" ] && exit 0

USER="redirectionio"
APPNAME="redirectionio-agent"
APPBIN="/usr/bin/redirectionio-agent"
APPARGS=""
LOGFILE="/var/log/redirectionio.log"
LOCKFILE="/var/lock/subsys/$APPNAME"

LOGPATH=$(dirname $LOGFILE)

start() {
        [ -x $prog ] || exit 5
        [ -d $LOGPATH ] || mkdir $LOGPATH
        [ -f $LOGFILE ] || touch $LOGFILE

        echo -n $"Starting $APPNAME: "
        daemon --user=$USER "$APPBIN $APPARGS >>$LOGFILE &"
        RETVAL=$?
        echo
        [ $RETVAL -eq 0 ] && touch $LOCKFILE
        return $RETVAL
}

stop() {
        echo -n $"Stopping $APPNAME: "
        killproc $APPBIN
        RETVAL=$?
        echo
        [ $RETVAL -eq 0 ] && rm -f $LOCKFILE
        return $RETVAL
}

restart() {
        stop
        start
}

rh_status() {
        status $prog
}

rh_status_q() {
        rh_status >/dev/null 2>&1
}

case "$1" in
        start)
                rh_status_q && exit 0
                $1
        ;;;
        stop)
                rh_status_q || exit 0
                $1
        ;;;
        restart)
                $1
        ;;;
        status)
                rh_status
        ;;;
        *)
                echo "Usage: $0 {start|stop|status|restart}"
                exit 2
esac


```

--------------------------------

### Create a Rule with Markers

Source: https://redirection.io/documentation/developer-documentation/public-api

This example demonstrates how to create a new rule using the Redirection.io API, including defining triggers, actions, and markers for advanced traffic management.

```APIDOC
## POST /rules

### Description
Creates a new rule with specified triggers, actions, markers, variables, and examples.

### Method
POST

### Endpoint
https://api.redirection.io/rules

### Parameters
#### Request Body
- **project** (string) - Required - The project ID to associate the rule with.
- **trigger** (object) - Required - Defines the conditions that trigger the rule.
  - **source** (string) - Required - The source URL pattern.
- **actions** (array) - Required - A list of actions to perform when the trigger is met.
  - **type** (string) - Required - The type of action (e.g., "redirection").
  - **location** (string) - Required - The destination URL for redirection.
  - **statusCode** (integer) - Required - The HTTP status code for the redirection.
- **markers** (array) - Optional - Defines marker variables that can be used within the rule.
  - **name** (string) - Required - The name of the marker.
  - **type** (string) - Required - The type of the marker (e.g., "anything").
- **variables** (array) - Optional - Defines variables to be used in the rule.
  - **type** (string) - Required - The type of the variable (e.g., "marker").
  - **name** (string) - Required - The name of the variable.
  - **marker** (string) - Required - The name of the marker this variable refers to.
- **examples** (array) - Optional - Example URLs to test the rule against.
  - **mustMatch** (boolean) - Required - Whether the example URL should match the rule.
  - **url** (string) - Required - The example URL.
- **description** (string) - Optional - A description for the rule.
- **enabled** (boolean) - Optional - Whether the rule is enabled.
- **tags** (array) - Optional - Tags to categorize the rule.

### Request Example
```json
{
    "project": "/projects/PROJECT_ID",
    "trigger": {
        "source": "/animals/@everything"
    },
    "actions": [
        {
            "type": "redirection",
            "location": "https://example.com/pets/@everything",
            "statusCode": 307
        }
    ],
    "markers": [
        {
            "name": "everything",
            "type": "anything"
        }
    ],
    "variables": [
        {
            "type": "marker",
            "name": "everything",
            "marker": "everything"
        }
    ],
    "examples": [
        {
            "mustMatch": true,
            "url": "https://example.com/animals/fish"
        },
        {
            "mustMatch": false,
            "url": "https://example.com/not-matching/fish"
        }
    ],
    "description": "A redirect rule with a marker",
    "enabled": true,
    "tags": [
        "api created rule"
    ]
}
```

### Response
#### Success Response (200)
- **rule** (object) - The created rule object.

#### Response Example
(Response structure not provided in source)
```

--------------------------------

### Install Agent using Ansible Galaxy

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

Install the redirection.io agent using the official Ansible role. This is a convenient method for managing agent deployment across multiple systems.

```bash
ansible-galaxy install redirectionio.agent

```

--------------------------------

### Agent Configuration with File and ACME Certificates

Source: https://redirection.io/documentation/agent-documentation/examples/file-and-acme-certificates

Use this configuration to start the agent with static certificates while ACME certificates are being generated. This serves as a fallback mechanism.

```yaml
instance:
  name: "Example instance"
reverse_proxy:
  listen:
    - "tcp://0.0.0.0:80"
    - "tls://0.0.0.0:443"
certificate:
  acme:
  contacts:
    - "myemail@example.com"
  directory_url: "https://acme-v02.api.letsencrypt.org/directory"
  file:
    key: "/path/to/cert.key"
    certificates:
      - "/path/to/chain.pem"
      - "/path/to/cert.pem"
forward:
  address: "backend:8080"
agent:
  project_key: "my-project-key"
```

--------------------------------

### ACME Certificates Configuration Example

Source: https://redirection.io/documentation/agent-documentation/examples/acme-certificates

Configure HTTP and TLS listeners with ACME contacts and directory URL for automatic TLS certificate provisioning. This example is suitable for automatic TLS certificate provisioning and renewal with ACME (Let's Encrypt).

```yaml
instance:
  name: "Example instance"
reverse_proxy:
  listen:
    - "tcp://0.0.0.0:80"
    - "tls://0.0.0.0:443"
certificate:
  acme:
  contacts:
    - "myemail@example.com"
  directory_url: "https://acme-v02.api.letsencrypt.org/directory"
forward:
  address: "backend:8080"
agent:
  project_key: "my-project-key"
```

--------------------------------

### Display Agent Version

Source: https://redirection.io/documentation/agent-documentation/agent-command-line-options

Use the `--version` option to display the release name of the installed redirection.io agent.

```bash
/usr/bin/redirectionio-agent --version

redirectionio-agent 3.0.0

```

--------------------------------

### Get and Build libredirectionio Library

Source: https://redirection.io/documentation/developer-documentation/nginx-module

Downloads the libredirectionio library source code and builds it. This static library is required for the Nginx module.

```bash
cd /tmp
wget -O libredirectionio-master.zip https://github.com/redirectionio/libredirectionio/archive/master.zip
unzip libredirectionio-master.zip
cd libredirectionio-master
```

```bash
autoreconf -i && \
./configure && \
make clean && \
make && \
make install
```

--------------------------------

### CSV Import with Header

Source: https://redirection.io/documentation/user-documentation/how-to-bulk-import-or-export-redirection-rules

Example of a CSV file formatted for import, including a header row.

```csv
Source URL;Target URL;Status Code
/some-source;/some-target;302
/this-is-not-found;;404
/this-is-gone;;410
```

--------------------------------

### Agent Startup Error with Undefined Environment Variables

Source: https://redirection.io/documentation/agent-documentation/agent-configuration-reference

Illustrates the error message received when the agent starts without required environment variables defined, such as REDIRECTIONIO_APPLICATION_DIR. This results in paths not being replaced and file access errors.

```bash
redirectionio-agent

2026-09-26T16:07:17.753395Z ERROR cannot open file ${REDIRECTIONIO_APPLICATION_DIR}/log/agent.log: No such file or directory (os error 2)

```

--------------------------------

### Run Docker Infrastructure

Source: https://redirection.io/documentation/developer-documentation/using-redirection-io-with-docker

Starts the Docker containers in detached mode, making the redirection.io agent and associated services available.

```bash
docker-compose up -d

```

--------------------------------

### Publish Rules

Source: https://redirection.io/documentation/developer-documentation/public-api

This example shows how to publish all draft changes to the ruleset using a POST request to the /publish endpoint. This action makes the changes live on your production website.

```APIDOC
## POST /projects/{PROJECT_ID}/publish

### Description
Publishes all draft changes to the ruleset, making them live on the production website.

### Method
POST

### Endpoint
https://api.redirection.io/projects/PROJECT_ID/publish

### Parameters
#### Path Parameters
- **PROJECT_ID** (string) - Required - The ID of the project whose rules are to be published.

#### Request Body
This endpoint does not require a request body.

### Response
This endpoint does not explicitly define a response body in the provided documentation, but typically indicates success or failure of the publication process.
```

--------------------------------

### Configure Trusted Proxies in Agent

Source: https://redirection.io/documentation/agent-documentation/trusted-proxies

This configuration example demonstrates how to set up trusted proxies for the redirection.io agent. It specifies IP addresses and ranges to trust, and individually enables or disables forwarding headers.

```yaml
instance:
    name: 'My Instance'
reverse_proxy:
    listen:
        - 'tcp://0.0.0.0:80'
    trusted_proxies:
        ips:
            - 192.168.0.0/16
            - 172.16.0.16
        forwarded: true
        x_forwarded_for: true
        x_forwarded_host: false
        x_forwarded_proto: true
    forward:
        address: 'backend:8080'
    agent:
        project_key: my-project-key
```

--------------------------------

### Restart Agent Service on APT Systems

Source: https://redirection.io/documentation/agent-documentation/upgrading-the-agent

Restart the redirection.io agent service. This example shows common commands for systemd, SysVinit, and Upstart service managers.

```bash
sudo systemctl restart redirectionio-agent
sudo service redirectionio-agent restart
sudo /etc/init.d/redirectionio-agent restart
```

--------------------------------

### Add Red Hat/RPM Repository

Source: https://redirection.io/documentation/agent-documentation/installing-the-agent

Add the redirection.io stable repository to your system's package manager configuration. This allows you to install and update the agent using `yum` or `dnf`.

```bash
sudo yum-config-manager --add-repo https://packages.redirection.io/rpm/stable/3/any

```

```bash
# or (Fedora)
sudo dnf config-manager --add-repo https://packages.redirection.io/rpm/stable/3/any

```

--------------------------------

### HTML Page Before SEO Override

Source: https://redirection.io/documentation/user-documentation/actions-reference

An example of a basic HTML page structure before applying SEO meta tag overrides.

```html
<!doctype html>
<html lang=en>
  <head>
    <meta charset=utf-8>
  </head>
  <body>
    <p>Here goes the page content.</p>
  </body>
</html>

```

--------------------------------

### Organization Details Response

Source: https://redirection.io/documentation/developer-documentation/public-api

Example JSON response when retrieving organization details, including organization ID, name, slug, and a list of projects with their respective details.

```json
{
   "id" : "859fb30e-5c02-11eb-b66c-fa163e4748ca",
   "name" : "ACME agency",
   "projects" : [
      {
         "id" : "060201ae-88ad-4043-bd02-4661be4fcbd0",
         "metadata" : [],
         "name" : "ACME project",
         "plan" : "starter_1000",
         "slug" : "acme-project"
      }
   ],
   "slug" : "acme-agency"
}
```

--------------------------------

### Configure unstable_allowDynamic for pnpm

Source: https://redirection.io/documentation/developer-documentation/vercel-middleware-integration

When using pnpm, the module install location differs. Configure `unstable_allowDynamic` to include the `.pnpm` directory to ensure the middleware functions correctly.

```javascript
import redirectionioMiddleware from '@redirection.io/vercel-middleware/next';

export default redirectionioMiddleware;

export const config = {
  unstable_allowDynamic: [
    '/node_modules/.pnpm/**/@redirection.io/**',
  ],
}
```

--------------------------------

### Use redirection.io Middleware (No Existing Middleware)

Source: https://redirection.io/documentation/developer-documentation/vercel-middleware-integration

Create a middleware file for your Vercel application to use the redirection.io middleware. This setup is for applications that do not already have a middleware configured.

```typescript
import redirectionioMiddleware from '@redirection.io/vercel-middleware/next';

export default redirectionioMiddleware;

export const config = {
  unstable_allowDynamic: [
    '/node_modules/@redirection.io/**',
  ],
}
```

--------------------------------

### Reverse Proxy with TLS Listening

Source: https://redirection.io/documentation/agent-documentation/examples/reverse-proxy-on-tls

Configure the agent to listen on port 443 using TLS and forward requests to a backend. This example keeps the configuration minimal, focusing on the TLS listening mode.

```yaml
instance:
  name: "Example instance"
reverse_proxy:
  listen:
    - "tls://0.0.0.0:443"
forward:
  address: "backend:8080"
agent:
  project_key: "my-project-key"
```

--------------------------------

### Configure Project Key in .env File

Source: https://redirection.io/documentation/developer-documentation/using-redirection-io-with-docker

Copies the distribution environment file to .env and instructs to paste your redirection.io project key. This file is used to configure the agent.

```bash
cp .env.dist .env
REDIRECTIONIO_PROJECT_KEY=PASTE HERE YOUR REDIRECTION.IO PROJECT KEY

```

--------------------------------

### Enable Prometheus Metrics in Agent Configuration

Source: https://redirection.io/documentation/agent-documentation/monitoring-the-agent

Configure the agent to expose Prometheus metrics by setting the `metrics.listen` key in the agent configuration file. This example shows how to enable metrics on `127.0.0.1:9000`.

```yaml
instance:
    name: 'My Instance'
reverse_proxy:
    listen:
        - 'tcp://0.0.0.0:80'
    forward:
        address: 'backend:8080'
    agent:
        project_key: my-project-key
metrics:
    listen: '127.0.0.1:9000'
```

--------------------------------

### Display Agent Help Information

Source: https://redirection.io/documentation/agent-documentation/agent-command-line-options

Use the --help flag to display a summary of all available command line options for the redirection.io agent.

```bash
/usr/bin/redirectionio-agent --help
```

--------------------------------

### Test Agent Configuration File

Source: https://redirection.io/documentation/agent-documentation/agent-command-line-options

Use the --test option to validate the agent's configuration file without starting the agent. It returns a non-zero exit code if errors are found, suitable for use in provisioning scripts.

```bash
/usr/bin/redirectionio-agent --test
```

```log
2025-09-26T15:48:53.381109Z WARN config key 'loggg' does not exist, is it a typo?
```

--------------------------------

### Create Nginx VirtualHost for Redirection Server

Source: https://redirection.io/documentation/knowledge-base/setting-up-a-redirection-server-on-azure-cloud

Use this command to open or create the Nginx VirtualHost configuration file for your website. Replace `your-website.com` with your actual domain.

```bash
sudo nano /etc/nginx/sites-available/your-website.com
```

--------------------------------

### Serve Local Directory Configuration (YAML)

Source: https://redirection.io/documentation/agent-documentation/examples/serve-a-local-directory

Configure the agent to serve static content from `/var/www/media`. This is useful for static assets or simple file-serving use cases without a backend application process.

```yaml
instance:
  name: "My Instance"
reverse_proxy:
  listen:
    - "tcp://0.0.0.0:80"
forward:
  directory: "/var/www/media"
agent:
  project_key: "my-project-key"
```

--------------------------------

### Install Wrangler for Cloudflare Workers

Source: https://redirection.io/documentation/developer-documentation/cloudflare-workers-integration

Installs Wrangler, the official Cloudflare package for working with Cloudflare Workers, globally using npm.

```bash
npm install -g wrangler
```

--------------------------------

### Webhook Notification Payload Example

Source: https://redirection.io/documentation/user-documentation/project-notifications

This is an example of the JSON payload structure sent to a webhook URL when a rules publication event occurs. It contains details about the publication status, context, and changes.

```json
{
    "successful": true,
    "status": "published",
    "level": "info",
    "channelId": "69d248d4-40ea-44ae-8686-ebebe2a12b65",
    "context": {
        "url": "https:\/\/redirection.io\/manager\/acme-inc\/example-com\/versions\/2cc1c743-83bf-4b41-aa09-900944fe6337",
        "projectName": "example.com"
    },
    "rulesCount": 22718,
    "added": 387,
    "updated": 0,
    "deleted": 22,
    "summary": "Added new redirects for the june archived products",
    "authorName": "John Doe"
}
```

--------------------------------

### Download and Build libredirectionio Library

Source: https://redirection.io/documentation/developer-documentation/apache-module

Downloads the libredirectionio library source code and compiles it.

```bash
cd /tmp
wget -O libredirectionio-master.zip https://github.com/redirectionio/libredirectionio/archive/master.zip
unzip libredirectionio-master.zip
cd libredirectionio-master

autoreconf -i && \
./configure && \
make clean && \
make && \
make install
```

--------------------------------

### Custom Response Status Code Examples

Source: https://redirection.io/documentation/user-documentation/actions-reference

Examples of forcing specific HTTP status codes in responses. Useful for dropping traffic, indicating removed content, or signaling service unavailability.

```text
404 Not Found
```

```text
410 Gone
```

```text
503 Service Unavailable
```

--------------------------------

### Configure Local Filesystem Backend

Source: https://redirection.io/documentation/agent-documentation/forwarding-requests-to-the-backend

Specify the 'directory' option within the 'forward' configuration to serve files from a local path. If a resource is not found, a 404 error is returned.

```yaml
instance:
    name: 'My Instance'
reverse_proxy:
    listen:
        - 'tcp://0.0.0.0:80'
    forward:
        directory: /var/www/media
    agent:
        project_key: my-project-key
```

--------------------------------

### Restart Apache service

Source: https://redirection.io/documentation/developer-documentation/apache-module

Restart the Apache web server to apply changes after module installation.

```bash
sudo systemctl restart apache2
```
Tokens:
Raw