2025-04-28 15:13:15 +01:00
# ✍️ ilo sitelen tu
2025-04-27 17:20:02 +01:00
A rewriting proxy service for use as the backend of a live web mirroring service for resilient and robust access to your website.
---
2025-04-28 15:13:15 +01:00
## 🏃 Running with Docker Compose
You can run the application using Docker Compose in different environments using the appropriate Compose files and
profiles.
### 🔧 Production
To run in **production** , use only the base `docker-compose.yml` file:
```bash
docker-compose -f docker-compose.yml up
```
This will start the core services (rewriting proxy and redis backend) without exposing any development-specific
configurations or ports.
### 🧪 Staging
To run in **staging** , include the `override` file which may expose additional ports or settings:
```bash
docker-compose -f docker-compose.yml -f docker-compose.override.yml up
```
This setup is useful for testing in an environment that closely mirrors production but includes conveniences like
exposing the Redis port on localhost.
### 💻 Local Development
For **local development** , use the same staging command:
```bash
docker-compose -f docker-compose.yml -f docker-compose.override.yml up
```
### 🛠 Enabling the Legacy Updater Tool (Optional)
The Legacy Updater Tool is an optional service that can be enabled using the `legacy` profile.
The tool requires [additional configuration ](./legacy/README.md ).
To include it, use the `--profile` argument to `docker compose` :
```bash
docker-compose --profile legacy up
```
Without the `--profile legacy` flag, the updater tool is disabled by default.
## ⚙️ Origin Configuration
2025-04-27 17:20:02 +01:00
Each origin is required to have a JSON configuration object available in the Redis backend under the key
`jasima:config:<canonical host>` .
The following keys are meaningful in this object:
2025-05-03 16:06:36 +01:00
| Key | Description | Default | Example |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| `first_party_adobe` | See section below. | Feature disabled. | `{"subdomain": "ssc", "account": "example"}` |
| `first_party_tealium` | See section below. | Feature disabled. | `{"subdomain": "tags", "account": "example"}` |
| `geo_redirect_disable` | Disables redirecting to the canonical host when a mirror likely isn't needed based on the viewer's geography. | Requests are redirected based on a hardcoded list of countries unlikely to have implemented censorship. | `true` |
| `headers` | Append additional headers to the request sent to the origin. | No additional headers are added. | `{"X-Example": "Hello"}` |
| `host_connect` | Override the hostname that is used to connect to the origin. This can be useful in the case that the origin is begind a CDN that you want to avoid having to traverse, either due to DDoS protection tools being falsely triggered or simply to save costs. | The canonical host is used. | `"real-origin.example.com"` |
| `host_header` | Override the hostname that is used as the `Host` header when connecting to the origin. | The canonical host is used. | `"news.example.org"` |
| `host_ssl` | Override the hostname that is used for TLS SNI and for verification of the upstream's TLS certificate. | The canonical host is used. | `"news.example.org"` |
| `matomo_site_id` | The site ID to use for Matomo tracking. | No tracking code is added to HTML pages. | `20` |
| `rewrite_disable` | Disable content rewriting for this host. This disables both URL rewriting, and the addition of Matomo tracking code, but not the replacement of absolute links to the canonical hostname with relative links. | Rewriting is enabled. | `true` |
2025-04-27 17:20:02 +01:00
Note: the default case applies when the key is omitted.
2025-05-03 16:06:36 +01:00
### 🍪 First-Party Tealium & Adobe Analytics
**Watch Out!** This feature was implemented specifically for the US Agency for Global Media and may not work correctly
for others. If it works for you, then great. If it doesn't, we could potentially accept a pull request that either
adapts the existing feature, or just adds a new one for you. If you're so inclined then we'd be really happy to accept
a feature that allowed for custom Lua code to be added on a per-deployment basis.
The configuration for both services are the same. The assumption is that the first-party subdomain chosen is always a
subdomain of the registered domain name (i.e. an extension on the Mozilla Public Suffix List + one name). For example:
| Site | Registered Domain | First-Party App Subdomain |
|-----------------|-------------------|---------------------------|
| www.example.com | example.com | tags.example.com |
| ir.example.com | example.com | tags.example.com |
| example.com | example.com | tags.example.com |
In this example, the `subdomain` property to configure for this app would be `"tags"` .
The account name is the account name registered with the application. You can usually find this from the URL provided
to you for inclusion in your HTML.
**Tealium:** The Universal Tag code contains a URL that looks like:
`//tags.tiqcdn.com/utag/ACCOUNT/PROFILE/ENVIRONMENT/utag.js` .
The `ACCOUNT` here should be used for the `account` property in the configuration.
**Adobe Analytics:** Look for a URL like:
`https://ACCOUNT.sc.omtrdc.net/b/ss/` .
Again, `ACCOUNT` is what should be used for the `account` property in the configuration.
2025-04-28 15:13:15 +01:00
## 🖋️ Copyright
2025-04-27 17:20:02 +01:00
Copyright © 2025 SR2 Communications Limited.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
