> For the complete documentation index, see [llms.txt](https://docs.vergeos-demo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vergeos-demo.com/knowledge-base/tenants/configuring-proxy.md).

# Configuring Proxy

Using a Proxy grants the ability to use 1 IP address for multiple Tenant environments by mapping FQDN hostnames. This bypasses the need to have 1 IP address per tenant and helps to preserve ipv4 addresses.

### Enabling Proxy

1. From the external network used to access tenant environments:
   * Select **Edit** in the left menu.
   * Enable **Proxy**.
   * In most cases, the **Proxy Listen Address** field can be left blank. This will default to `0.0.0.0`, meaning it will listen on all addresses.

{% hint style="warning" %}
**For VergeOS verions 4.12.6 and older**

'Bind DNS' will need to be temporarily enabled if it is not already in use on the network. This will expose the IP Alias selection in the UI (step 2).

Submit the settings but ***DO NOT RESTART THE NETWORK OR APPLY RULES YET!***
{% endhint %}

2. From the same external network:

   * Select **IP Addresses** in the left menu.
   * Edit or create an IP Address, setting the **Type** to **IP Alias**.
   * Submit.
   * Set the external network DNS back to the original setting (Prior to Version 4.12.4).
   * Select **Rules**.
   * Create a new rule that looks like the following image:

   ![proxy\_accept\_rule.png](/files/KSCwp7jCPEhVmUAESp99)

   * Restart the network and apply the rules.
   * Test the rule by opening a browser tab and navigating to the URL using the IP Alias address assigned in the previous step. If it works properly, the UI login page will open on the IP Alias address.

### Creating a New Tenant with Proxy

1. Create an **A Record** for the new tenant in your domain registrar to point to the assigned IP Alias.
2. Create a new tenant:
   * Enter all desired settings, leaving the **URL** blank.
3. In the **UI Management** tab of the tenant creation page, select **Create a new FQDN**.
4. In the **Proxy Tenant Config** page:
   * Select the network the proxy service is running on.
   * Select the tenant name.
   * Enter the FQDN of the tenant (the A Record created in step 1).
   * Submit.
5. Select **Skip** at the bottom of the **UI Management** page to avoid assigning an IP directly to the tenant.

{% hint style="info" %}
**A tenant cannot have a UI IP address AND a proxied FQDN.**
{% endhint %}

6. In the new tenant dashboard, select **Apply Proxy** in the highlighted warning.
7. Start the tenant and navigate to its URL in a browser tab to log in.

### Editing an Existing Tenant to use Proxy

1. Create an **A Record** for the tenant in your domain registrar to point to the assigned IP Alias (if one does not already exist).
2. From the tenant dashboard, select **Edit** in the left menu:
   * In the **UI Address** field, select **None**.
3. Navigate to the network running the proxy service:
   * Select **Proxy** in the left menu.
4. From the **Proxy Dashboard**:
   * Select **View Tenants**.
   * Select **New**.
5. In the **Proxy Tenant Config** page:
   * Select the network the proxy service is running on.
   * Select the tenant name.
   * Enter the FQDN of the tenant (the A Record created in step 1).
6. Navigate to the tenant dashboard and select **Apply Proxy** in the highlighted warning.
7. Select the tenant network (highlighted) from the tenant dashboard.

   ![tenant\_apply\_rules.png](/files/2vgJTsEkSDVB124Frxqi)
8. Select **Apply Rules** in the highlighted warning.
9. Test access to the tenant by navigating to its URL in a browser tab.

***

{% hint style="info" %}
**Document Information**

* Last Updated: 2024-08-29
* vergeOS Version: 4.12.6
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.vergeos-demo.com/knowledge-base/tenants/configuring-proxy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.