YOURLS¶

В этой статье

• YOURLS. Основные возможности
• Особенности сборки
• Начало работы после развертывания YOURLS
• Вход в панель администрирования
• Создание коротких ссылок
• Статистика и аналитика
• Букмарклеты (Bookmarklets)
• Плагины YOURLS
• Заказ сервера с YOURLS с помощью API

YOURLS. Основные возможности¶

• Полный контроль над ссылками: использование собственного домена или поддомена для коротких URL, что обеспечивает узнаваемость бренда;
• Детальная статистика и аналитика: отслеживание количества переходов, источников трафика, географии посетителей и других метрик для каждой короткой ссылки;
• Пользовательские ключевые слова: возможность задавать собственные описательные и запоминающиеся ключевые слова для коротких ссылок;
• Публичные и приватные ссылки: создание открытых коротких URL для широкого распространения или приватных ссылок с ограниченным доступом;
• Букмарклеты: быстрое сокращение ссылок прямо из браузера без необходимости перехода на сайт YOURLS;
• Developer API: простой API для программного доступа, позволяющий интегрировать YOURLS с другими приложениями и автоматизировать задачи;
• Архитектура плагинов: расширение функциональности за счет установки плагинов, доступных в экосистеме YOURLS;
• Последовательное или пользовательское создание URL: возможность генерации последовательных коротких URL или использование пользовательских конфигураций;
• Безопасное управление пользователями: защищенный доступ к интерфейсу администрирования с использованием хеширования паролей.

Особенности сборки¶

Начало работы после развертывания YOURLS¶

После оплаты заказа на указанную при регистрации электронную почту придет уведомление о готовности сервера к работе. В нем будет указан IP-адрес VPS, а также логин и пароль для подключения. Управление оборудованием клиенты нашей компании осуществляют в панели управления серверами и API — Invapi.

Данные для авторизации, которые можно найти во вкладке Конфигурация >> Теги панели управления сервером или в присланном e-mail:

• Ссылка для доступа к панели управления YOURLS с веб-интерфейсом: в теге webpanel;
• Логин и Пароль для управления сервером: приходят в письме на вашу электронную почту при сдаче сервера.

Вход в панель администрирования¶

Для доступа к интерфейсу YOURLS выполните следующие шаги:

1. Откройте веб-браузер и перейдите по ссылке: https://yourls{Server_ID}.hostkey.in/admin;

2. При первом посещении вы попадете на страницу авторизации. Введите учетные данные:

   • Логин: root
   • Пароль: пароль по умолчанию, указанный в уведомлении о готовности сервера;

3. Нажмите кнопку Login.

Создание коротких ссылок¶

После успешного входа в панель администрирования вы попадете на главную страницу, где можно создавать новые короткие ссылки:

![](./images/you_2.png)

1. В поле Enter the URL here введите полный URL-адрес, который необходимо сократить;

2. В поле Custom short URL (необязательно) задайте пользовательское ключевое слово для короткой ссылки. Если оставить поле пустым, ключевое слово будет сгенерировано автоматически;

3. Нажмите кнопку Shorten The URL для создания короткой ссылки;

4. Результат будет отображен на странице:

   • Your short link - готовая короткая ссылка;
   • Original URL - полная версия короткой ссылки для копирования;
   • Copy - кнопка для быстрого копирования в буфер обмена.

Статистика и аналитика¶

YOURLS предоставляет детальную статистику по всем созданным коротким ссылкам:

1. Для просмотра детальной статистики по конкретной ссылке наведите курсор на ссылку и нажмите на значок статистики в поле Actions;

   

2. На странице статистики отображается:

   • общее количество кликов по каждой ссылке;
   • список переходов с указанием даты и времени;
   • источники трафика (referrer);
   • пользовательские агенты (User-Agent);
   • географические данные посетителей;

3. Статистика позволяет:

   • отслеживать популярность ссылок;
   • анализировать эффективность маркетинговых кампаний;
   • оптимизировать распределение трафика.

Букмарклеты (Bookmarklets)¶

Букмарклеты - это специальные закладки для браузера, позволяющие сокращать ссылки одной кнопкой, не переходя на сайт YOURLS:

1. Перейдите в раздел Tools в верхнем меню YOURLS;

2. Перетащите нужный ярлык на панель закладок вашего браузера;

   • Shorten - ярлык для сокращения текущей страницы;
   • Custom Shorten - ярлык с возможностью задать ключевое слово;

3. При просмотре интересной страницы нажмите соответствующий ярлык на панели закладок;

4. Появится диалоговое окно с результатом - готовой короткой ссылкой.

Плагины YOURLS¶

YOURLS поддерживает расширение функциональности через систему плагинов. Так как приложение развернуто в Docker-контейнерах, процесс установки требует монтирования локальной директории хоста для персистентного (постоянного) хранения данных плагинов.

Подготовка директории и настройка Docker Compose¶

Перед установкой плагинов необходимо настроить постоянное хранилище на сервере, чтобы плагины не удалялись при перезапуске или обновлении контейнеров:

1. Подключитесь к серверу по SSH под пользователем root.

2. Создайте локальную директорию для плагинов на хосте:

mkdir -p /opt/yourls/plugins

1. Назначьте корректные права доступа на созданную директорию:

chmod 0750 /opt/yourls/plugins
chown -R root:root /opt/yourls/plugins

1. Откройте файл конфигурации приложения /opt/yourls/yourls-compose.yml и добавьте секцию volumes для сервиса yourls, примонтировав созданную папку к внутреннему пути /var/www/html/user/plugins:

name: yourls
services:
  yourls:
    image: yourls:latest
    container_name: "yourls<ID-сервера>.hostkey.in"
    restart: always
    depends_on:
      - mysql
    ports:
      - "127.0.0.1:8080:8080"
    volumes:
      - /opt/yourls/plugins:/var/www/html/user/plugins
    environment:
      YOURLS_DB_HOST: mysql
      YOURLS_DB_NAME: yourls
      YOURLS_DB_USER: yourls
      YOURLS_DB_PASS: "yourls"
      YOURLS_SITE: "https://hostkey.in"
      YOURLS_USER: "root"
      YOURLS_PASS: "you_password"

  mysql:
    image: mysql:8
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: yourls
      MYSQL_DATABASE: yourls
      MYSQL_USER: yourls
      MYSQL_PASSWORD: "yourls"
    volumes:
      - /opt/yourls/mysql-data:/var/lib/mysql

1. Перезапустите контейнеры приложения из директории /opt/yourls, чтобы применить изменения конфигурации:

docker compose -f /opt/yourls/yourls-compose.yml down
docker compose -f /opt/yourls/yourls-compose.yml up -d

Процесс установки нового плагина¶

1. Скачайте архив плагина с официального репозитория YOURLS.

2. Распакуйте архив в локальную директорию сервера /opt/yourls/plugins/. Каждая папка плагина должна находиться строго по пути /opt/yourls/plugins/имя_плагина/ (внутри должен быть файл plugin.php).

3. Перейдите в веб-интерфейс панели администрирования и откройте раздел Plugins в верхнем меню.

4. Новый плагин автоматически отобразится в списке доступных.

5. Для включения плагина нажмите кнопку Activate рядом с его названием. Для отключения используйте кнопку Deactivate.

Популярные плагины¶

• GeoIP — определение географического положения посетителей;
• Click counter — расширенный и детализированный подсчет кликов;
• Social Sharing — интеграция с социальными сетями для быстрой отправки;
• Password Protection — ограничение доступа к коротким ссылкам по паролю;
• Expiry — автоматическое истечение срока действия ссылок по времени или числу переходов.

Заказ сервера с YOURLS с помощью API¶

Установка данного ПО с использованием API описана в данном руководстве.