Загрузка shlink - Загрузка исходного кода shlink

съеживаться

Другой исходный код

v4.2.5

Скачать

Автономный инструмент сокращения URL-адресов на основе PHP, который можно использовать для обслуживания сокращенных URL-адресов в вашем собственном домене.

Полная документация

Этот документ содержит самые основы для начала работы с Shlink. Если вы хотите узнать все, что можно с ним делать, посетите полную документацию с возможностью поиска.

Докер-образ

Вы можете узнать, как использовать официальный образ докера, прочитав документацию.

Идея состоит в том, что вы можете просто сгенерировать контейнер, используя изображение, и предоставить собственную конфигурацию через переменные окружения.

Самостоятельный хостинг

Во-первых, убедитесь, что хост, на котором вы собираетесь запустить shlink, соответствует этим требованиям:

PHP 8.2 или 8.3
Следующие расширения PHP: json, curl, pdo, intl, gd и gmp/bcmath.
- Расширение apcu рекомендуется, если вы не планируете использовать RoadRunner.
- Расширение xml требуется, если вы хотите генерировать QR-коды в формате svg.
- сокеты и расширения bcmath необходимы, если вы хотите интегрироваться с экземпляром RabbitMQ.
MySQL, MariaDB, PostgreSQL, MicrosoftSQL или SQLite.
- Вам также понадобится соответствующий вариант pdo для базы данных, которую вы планируете использовать: pdo_mysql , pdo_pgsql , pdo_sqlsrv или pdo_sqlite .

Скачать

Чтобы запустить Shlink, вам понадобится встроенная версия проекта. Есть два способа получить его.

Использование файла dist
Самый простой способ установить shlink — использовать один из готовых дистрибутивных пакетов.
Перейдите к последней версии и загрузите файл shlink*_dist.zip который соответствует вашим потребностям. Вы найдете по одному для каждой поддерживаемой версии PHP.
Наконец, распакуйте файл в выбранное вами место.
Сборка из исходников
Если по какой-либо причине вы хотите создать проект самостоятельно, выполните следующие действия:
- Клонируйте проект с помощью git ( git clone https://github.com/shlinkio/shlink.git ) или загрузите его, нажав зеленую кнопку «Клонировать или загрузить» .
- Загрузите менеджер пакетов Composer PHP из папки проекта.
- Запустите ./build.sh 3.0.0 , заменив версию номером версии, которую вы собираетесь собрать (номер версии используется как часть имени сгенерированного файла dist и для установки значения, возвращаемого при запуске shlink -V из командная строка).
После этого в каталоге build появится файл dist, который вам нужно распаковать в выбранное вами место.
Примечание
Этот процесс используется при выпуске новых версий Shlink. После пометки новой версии с помощью git выпуск GitHub автоматически создается рабочим процессом GitHub, прикрепляя к нему сгенерированный файл dist.

Настроить

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

Если вы собираетесь использовать MySQL, MariaDB, PostgreSQL или Microsoft SQL Server, создайте пустую базу данных с именем по вашему выбору.
Рекурсивно предоставить разрешения на запись в каталог data . Шлинк использует его для кэширования некоторой информации.
Настройте приложение, запустив сценарий vendor/bin/shlink-installer install . Это инструмент командной строки, который проведет вас через процесс установки. Учтите, что этот инструмент необходимо запускать непосредственно на сервере, на котором вы планируете разместить Shlink. Не запускайте его до загрузки/перемещения туда.
Создайте свой первый ключ API, запустив bin/cli api-key:generate . Вам понадобится ключ для взаимодействия с API Shlink.

Использование слинка

После установки shlink существует два основных способа взаимодействия с ним:

Командная строка : попробуйте запустить bin/cli чтобы увидеть все доступные команды.
Все их можно запустить с флагом --help / -h , чтобы увидеть, как их использовать и все доступные параметры.
Вероятно, будет хорошей идеей создать символическую ссылку на точку входа CLI ( bin/cli ) где-нибудь на вашем пути, чтобы вы могли запускать shlink из любого каталога.
REST API : полную документацию по использованию API можно найти здесь, а песочницу, в которой также документируется каждая конечная точка, можно найти на портале API Spec.
Однако вы, вероятно, не захотите использовать исходный API самостоятельно. Вот почему предоставляется хороший веб-клиент, который можно использовать непосредственно из https://app.shlink.io или разместить самостоятельно.

И API, и CLI позволяют выполнять в основном одни и те же операции, за исключением управления ключами API, которое можно выполнить только из интерфейса командной строки.