Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smartlook/smartlook-relay-proxy
Smartlook Relay Proxy ⚡️
https://github.com/smartlook/smartlook-relay-proxy
Last synced: 24 days ago
JSON representation
Smartlook Relay Proxy ⚡️
- Host: GitHub
- URL: https://github.com/smartlook/smartlook-relay-proxy
- Owner: smartlook
- License: mit
- Created: 2021-12-20T12:37:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T07:35:38.000Z (5 months ago)
- Last Synced: 2024-12-17T09:04:29.851Z (25 days ago)
- Language: TypeScript
- Homepage: https://smartlook.com
- Size: 1.45 MB
- Stars: 6
- Watchers: 8
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Smartlook Relay Proxy
This service relays HTTP requests from your subdomain to
Smartlook's recording domains, allowing you to bypass potential
browser settings or extensions used by your visitors configured to limit data capture.
> **Note**
> Only web recording is currently supported.
## Installation and deployment
> **Warning**
> Relay Proxy is only for advanced users. If you're not sure what you're doing, please contact your developer.
Images are available on [Docker Hub](https://hub.docker.com/r/smartlook/relay-proxy) and [GitHub Packages](https://github.com/smartlook/smartlook-relay-proxy/pkgs/container/relay-proxy).
1. Get the Smartlook relay proxy image. Images are available on [Docker Hub](https://hub.docker.com/r/smartlook/relay-proxy) and [GitHub Packages](https://github.com/smartlook/smartlook-relay-proxy/pkgs/container/relay-proxy).
2. Run the image and configure environment variables according to your needs.
**All variables are optional, default values are listed in the table below**.
```bash
docker run --name="smartlook-relay-proxy" \
-p :8000 \ # runs on port 8000 by default
smartlook/relay-proxy:6
```
3. Create a subdomain and point it to the container. It is best to use a subdomain of your website's domain.
4. Deploy the following script. Be sure to replace any URLs with your own URLs. Do not set `region`.
```diff
window.smartlook ||
(function (d) {
var o = (smartlook = function () {
o.api.push(arguments)
}), h = d.getElementsByTagName('head')[0];
var c = d.createElement('script');
o.api = new Array();
c.async = true;
c.crossOrigin = 'anonymous';
c.type = 'text/javascript';
c.charset = 'utf-8';
+ c.src = 'https://<your-relay-proxy-host>/recorder.js';
h.appendChild(c);
})(document);
+ smartlook('init', <project-key>, { host: '<your-relay-proxy-host>' });
```
You have now installed and deployed the Smartlook relay proxy. You can check if the relay proxy is working correctly by seeing requests sent through your subdomain in the _Network_ tab of your browser DevTools.
## Environment variables
| Name | Type | Default value | Description | Notes |
| --------------------- | -------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `ERROR_LOG_LEVEL` | `string` | `error` | [Nginx error log level](https://nginx.org/en/docs/ngx_core_module.html#error_log). One of `debug`, `info`, `notice`, `warn`, `error`, `crit`, `alert`, `emerg`. | Can be safely overridden. |
| `CLIENT_MAX_BODY_SIZE` | `string` | `20m` | [Nginx client_max_body_size](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size). | Can be safely overridden. |
| `PROXY_PORT` | `number` | `8000` | Port which will the HTTP server listen on. | Can be safely overridden. |
| `LISTEN_IPV6` | `boolean` | `false` (unset) | If set to `true`, the server will also listen on IPv6. The port will be the value of `PROXY_PORT` environment variable. | Can be safely overridden. |
| `DNS_RESOLVER` | `string` | `1.1.1.1 1.0.0.1 valid=5m` | [Nginx resolver](https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver). | Can be safely overridden. | |
| `WEB_SDK_HOST` | `string` | `web-sdk.smartlook.com` | Smartlook Web SDK host | Only edit this value if using a region other than EU, or if instructed by customer support. |
| `MANAGER_HOST` | `string` | `manager.eu.smartlook.cloud` | Smartlook Manager host | Only edit this value if using a region other than EU, or if instructed by customer support. |
| `WEB_SDK_WRITER_HOST` | `string` | `web-writer.eu.smartlook.cloud` | Smartlook Web Writer host | Only edit this value if using a region other than EU, or if instructed by customer support. |
| `ASSETS_PROXY_HOST` | `string` | `assets-proxy.smartlook.cloud` | Smartlook Assets Proxy host | Only edit this value if using a region other than EU, or if instructed by customer support. |
## Regional setup
Smartlook offers two regions for data storage: EU and US. By default, all projects are set to the EU region. To change your data storage region, contact Smartlook Support.
If your project is set to the US data region, you need to set the variables as follows:
| Name | Value |
| --------------------- | --------------------------------- |
| `MANAGER_HOST` | `manager.us.smartlook.cloud` |
| `WEB_SDK_WRITER_HOST` | `web-writer.us.smartlook.cloud` |
| `ASSETS_PROXY_HOST` | `assets-proxy.us.smartlook.cloud` |
If most of your visitors are located in a different region, you can set environment variables to reduce network latency. Smartlook servers are located in four regions:
- EU (Frankfurt)
- North America (Oregon)
- South America (São Paulo)
- Asia (Singapore)
To set up for other regions:
#### South America
> **Note**
> For this region, only the `WEB_SDK_WRITER_HOST` is available.
| Name | Value |
| --------------------- | ------------------------------- |
| `WEB_SDK_WRITER_HOST` | `web-writer.br.smartlook.cloud` |
#### Asia
> **Note**
> For this region, only the `WEB_SDK_WRITER_HOST` is available.
| Name | Value |
| --------------------- | ------------------------------- |
| `WEB_SDK_WRITER_HOST` | `web-writer.sg.smartlook.cloud` |
**By default, all data is stored in the EU**. However, if your Smartlook organization is set up to store data in US (you must contact Smartlook support to set it up), you need to set the environment variables as described in region-specific setup [above](#regional-setup).
## Development
```bash
# See all available commands
make help
```
## License
[MIT](LICENSE)