Keitaro Documentation

https://docs.keitaro.io
Admin
Keitaro is a tracker designed for affiliate marketing, helping users manage campaigns, landing...
Tokens:108,858
Snippets:1,313
Trust Score:9.6
Update:4 days ago
Show doc for...
Tokens:
Raw
### View installation logs

Source: https://docs.keitaro.io/en/get-started/manual-installation.html

Commands to view the installation log file for troubleshooting purposes.

```bash
less /var/log/keitaro/install.log
```

```bash
tail -n 1000 /var/log/keitaro/install.log
```

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

### Synchronize backup files example

Source: https://docs.keitaro.io/en/maintenance/transfer-tracker-to-another-server.html

A concrete example of the rsync command used to transfer backup files.

```bash
rsync -avzP -e "ssh -p 22" root@77.71.136.233:/var/lib/kctl-backups/common/2025-08-01-13-35-34/ /var/lib/kctl-backups/common/2025-08-01-13-35-34/
```

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

### Example URL structure

Source: https://docs.keitaro.io/en/landing-pages-and-offers/landing-page-redirect.html

An example of how the tracker URL looks with the token parameter included.

```text
https://trackerdomain/?_lp=1&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c`.
```

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

### Manual installation command

Source: https://docs.keitaro.io/en/get-started/cloud-providers/digitalocean.html

The installation command to be pasted into the User data field during manual Droplet creation.

```bash
#!/bin/bash
curl https://files.keitaro.io/scripts/releases/stable/kctl.sh | bash -s -- install
```

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

### Run Keitaro installation script

Source: https://docs.keitaro.io/en/faq.html

Execute this command in your server terminal to initiate the automatic installation of the Keitaro tracker.

```bash
curl keitaro.io/kctl.sh | bash -s -- install
```

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

### Manual installation command

Source: https://docs.keitaro.io/en/get-started/cloud-providers/friendhosting.html

Execute this command via SSH on a server without pre-installed control panels to install Keitaro.

```bash
curl https://files.keitaro.io/scripts/releases/stable/kctl.sh | bash -s -- install
```

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

### Cloud-config script for Keitaro installation

Source: https://docs.keitaro.io/en/get-started/cloud-providers/hetzner.html

Enter this command in the Cloud configs field during server creation to automatically install Keitaro upon server initialization.

```yaml
#cloud-config

runcmd:
curl https://files.keitaro.io/scripts/releases/stable/kctl.sh | bash -s -- install
```

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

### View help for domains:create

Source: https://docs.keitaro.io/en/development/cli.html

Example output showing the help documentation for the domains:create command.

```bash
[root@demo-en keitaro]# kctl run cli-php domains:create --help


Description:
  Add domain

Usage:
  domains:create [<domain>]

Arguments:
  domain

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```

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

### Get command help

Source: https://docs.keitaro.io/en/development/cli.html

Displays help information and available options for a specific command.

```bash
kctl run cli-php [COMMAND] --help
```

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

### Start screen session

Source: https://docs.keitaro.io/en/maintenance/transfer-tracker-to-another-server.html

Run screen to ensure the synchronization process continues if the SSH connection is interrupted.

```bash
screen
```

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

### Create backup directory

Source: https://docs.keitaro.io/en/maintenance/transfer-tracker-to-another-server.html

Prepare the directory on the new server to receive the backup files.

```bash
mkdir -p /var/lib/kctl-backups/common/
```

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

### REMOTE redirect random.php example

Source: https://docs.keitaro.io/en/campaigns/redirects-actions.html

An example of a PHP script used for the REMOTE redirect method, which reads links from a file and outputs a random one.

```php
<?php
if (!file_exists('./links.txt')) {
    die('No file links.txt');
}
$content = file_get_contents('./links.txt');
$lines = explode("\n", $content);
$links = array_map(function($line){
  $line = trim($line);
  return empty($line) ? null : $line;
}, $lines);
$links = array_filter($links);
echo $links[rand(0, count($links) - 1)];
?>
```

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

### Create a custom filter class in example.php

Source: https://docs.keitaro.io/en/development/creating-new-filter.html

Create a new file at /var/www/keitaro/var/filters/example.php. This class must extend AbstractFilter and implement getModes, getTemplate, and isPass methods.

```php
<?php
namespace Filters;
 
use Coreilter\AbstractFilter;
use Core	Locale\LocaleService;
use Traffic\Model\StreamFilter;
use Traffic\RawClick;
 
class example extends AbstractFilter
{
    public function getModes()
    {
        return [
            StreamFilter::ACCEPT => LocaleService::t('filters.binary_options.' . StreamFilter::ACCEPT),
            StreamFilter::REJECT => LocaleService::t('filters.binary_options.' . StreamFilter::REJECT),
        ];
    }
    /**
     * Filter settings template
     */
    public function getTemplate()
    {
        return '<input class="form-control" ng-model="filter.payload" />';
    }
 
    /**
     * Check if $rawClick passes the filter (true - passed, false - failed)
     */
    public function isPass(StreamFilter $filter, RawClick $rawClick)
    {
        $value = $filter->getPayload();
        return ($filter->getMode() == StreamFilter::ACCEPT && $rawClick->getSubIdN(1) == $value)
            || ($filter->getMode() == StreamFilter::REJECT && $rawClick->getSubIdN(1) == $value);
    }
}
```

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

### Install TikTok Pixel Tracking Code

Source: https://docs.keitaro.io/en/conversions-and-postback/tt-pixel.html

Add this code to the page where you want to install the pixel, such as a thank you page, to retrieve the pixel from the cookie and initialize the TikTok Analytics object.

```javascript
<script>
var matches = document.cookie.match(new RegExp("(?:^|; )" + 'pixel' + "=([^;]*)"));
var pixel = matches ? decodeURIComponent(matches[1]) : undefined;
</script>

<!-- TikTok Pixel Code Start -->
<script>
    !function (w, d, t) {
        w.TiktokAnalyticsObject = t;
        var ttq = w[t] = w[t] || [];
        ttq.methods = ["page", "track", "identify", "instances", "debug", "on", "off", "once", "ready", "alias", "group", "enableCookie", "disableCookie"],
            ttq.setAndDefer = function (t, e) {
                t[e] = function () {
                    t.push([e].concat(Array.prototype.slice.call(arguments, 0)))
                }
            };
        for (var i = 0; i < ttq.methods.length; i++) ttq.setAndDefer(ttq, ttq.methods[i]);
        ttq.instance = function (t) {
            for (var e = ttq._i[t] || [], n = 0; n < ttq.methods.length; n++) ttq.setAndDefer(e, ttq.methods[n]);
            return e
        }, ttq.load = function (e, n) {
            var i = "https://analytics.tiktok.com/i18n/pixel/events.js";
            ttq._i = ttq._i || {}, ttq._i[e] = [], ttq._i[e]._u = i, ttq._t = ttq._t || {}, ttq._t[e] = +new Date, ttq._o = ttq._o || {}, ttq._o[e] = n || {};
            var o = document.createElement("script");
            o.type = "text/javascript", o.async = !0, o.src = i + "?sdkid=" + e + "&lib=" + t;
            var a = document.getElementsByTagName("script")[0];
            a.parentNode.insertBefore(o, a)
        };
        ttq.load(pixel);
        ttq.page();
    }(window, document, 'ttq');
</script>
<!-- TikTok Pixel Code End -->
```

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

### AbstractClickMacro Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Method to get the PSR-7 ServerRequest.

```APIDOC
## AbstractClickMacro Interface

### Description
Method to get the PSR-7 ServerRequest.

### Methods
- **getServerRequest** (ServerRequest) - PSR-7 ServerRequest
```

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

### Navigate to an offer via button

Source: https://docs.keitaro.io/en/campaign-integrations/kclient-php.html

Use the $client->getOffer() method to generate a link to a targeted offer within your campaign flow.

```php
<body>
<a href="<?php echo $client->getOffer() ?>">CLICK TO GO</a>
</body>
</html>
```

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

### AbstractFilter Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Method to get the PSR-7 ServerRequest.

```APIDOC
## AbstractFilter Interface

### Description
Method to get the PSR-7 ServerRequest.

### Methods
- **getServerRequest** (ServerRequest) - PSR-7 ServerRequest
```

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

### FlowFilter Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Methods to get filter payload and mode.

```APIDOC
## FlowFilter Interface

### Description
Methods to get filter payload and mode.

### Methods
- **getPayload()** (mixed) - Filter values
- **getMode()** (string) - Current filter mode
```

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

### Create backup dump

Source: https://docs.keitaro.io/en/maintenance/transfer-tracker-to-another-server.html

Run this command on the old server to generate a backup dump of the tracker.

```bash
kctl backups create
```

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

### Campaign Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Method to get a field value from a campaign.

```APIDOC
## Campaign Interface

### Description
Method to get a field value from a campaign.

### Methods
- **get($fieldName)** (mixed) - Get value of $fieldName
```

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

### Create a custom click placeholder

Source: https://docs.keitaro.io/en/development/creating-new-placeholder.html

Implement a {randomx:min,max} placeholder by extending AbstractClickMacro and saving the file as /var/www/keitaro/var/macros/randomx.php.

```php
<?php
namespace Macros;

use Traffic\Model\Stream;
use Traffic\RawClick;
use Traffic\Macros\AbstractClickMacro;

class randomx extends AbstractClickMacro
{
    public function process(?Stream $stream, RawClick $click, $min, $max)
    {
        return rand($min, $max);
    }
}
```

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

### Offer Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Method to get a field value from an offer.

```APIDOC
## Offer Interface

### Description
Method to get a field value from an offer.

### Methods
- **get($fieldName)** (mixed) - Get value of $fieldName
```

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

### Report a rejected conversion

Source: https://docs.keitaro.io/en/campaign-integrations/tracking-script.html

Example of sending a rejected conversion status.

```javascript
KTracking.reportConversion(0, 'rejected');
```

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

### Creating a new admin account with kctl

Source: https://docs.keitaro.io/en/team-management/restoring-password.html

Use this command in the server terminal to create a new administrator account if existing login credentials are lost.

```bash
kctl run cli-php admin:create 'NEWLOGIN' 'NEWPASSWORD'
```

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

### Landing Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Method to get a field value from a landing page.

```APIDOC
## Landing Interface

### Description
Method to get a field value from a landing page.

### Methods
- **get($fieldName)** (mixed) - Get value of $fieldName
```

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

### Report a sale conversion

Source: https://docs.keitaro.io/en/campaign-integrations/tracking-script.html

Example of sending a sale conversion with a payout of 0.

```javascript
KTracking.reportConversion(0, 'sale');
```

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

### Navigate to a specific offer by ID

Source: https://docs.keitaro.io/en/campaign-integrations/kclient-php.html

Use the $client->getOffer() method with an array containing the 'offer_id' to link to a specific offer.

```php
<a href="<?php echo $client->getOffer(array('offer_id' => 123));?>">CLICK TO GO</a>
```

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

### Basic Offer Link

Source: https://docs.keitaro.io/en/campaign-integrations/tracking-script.html

Use the {offer} placeholder to create a link to an offer in a flow.

```html
<a href="{offer}">Link to offer</a>
```

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

### Traffic source Interface

Source: https://docs.keitaro.io/en/development/php-interfaces.html

Method to get a field value from a traffic source.

```APIDOC
## Traffic source Interface

### Description
Method to get a field value from a traffic source.

### Methods
- **get($fieldName)** (mixed) - Get value of $fieldName
```
Tokens:
Raw