shlink
v4.2.5
자신의 도메인에서 단축 URL을 제공하는 데 사용할 수 있는 PHP 기반 자체 호스팅 URL 단축기입니다.
전체 문서
도커 이미지
자체 호스팅
다운로드
구성
shlink 사용
기여
이 문서에는 Shlink를 시작하는 데 필요한 기본 사항이 포함되어 있습니다. 그것으로 할 수 있는 모든 것을 배우고 싶다면, 검색 가능한 전체 문서를 방문하세요.
문서를 읽으면 공식 도커 이미지를 사용하는 방법을 배울 수 있습니다.
아이디어는 이미지를 사용하여 컨테이너를 생성하고 env vars를 통해 사용자 정의 구성을 제공할 수 있다는 것입니다.
먼저 shlink를 실행할 호스트가 다음 요구 사항을 충족하는지 확인하세요.
PHP 8.2 또는 8.3
다음 PHP 확장: json, 컬, pdo, intl, gd 및 gmp/bcmath.
RoadRunner를 사용할 계획이 없다면 apcu 확장을 권장합니다.
svg 형식의 QR 코드를 생성하려면 xml 확장자가 필요합니다.
RabbitMQ 인스턴스와 통합하려면 소켓 및 bcmath 확장이 필요합니다.
MySQL, MariaDB, PostgreSQL, MicrosoftSQL 또는 SQLite.
또한 사용하려는 데이터베이스에 해당하는 pdo 변형( pdo_mysql , pdo_pgsql , pdo_sqlsrv 또는 pdo_sqlite 이 필요합니다.
Shlink를 실행하려면 빌드된 프로젝트 버전이 필요합니다. 그것을 얻는 방법에는 두 가지가 있습니다.
dist 파일 사용
shlink를 설치하는 가장 쉬운 방법은 사전 번들로 제공되는 배포 가능 패키지 중 하나를 사용하는 것입니다.
최신 버전으로 이동하여 필요에 맞는 shlink*_dist.zip 파일을 다운로드하세요. 지원되는 모든 PHP 버전에 대해 하나를 찾을 수 있습니다.
마지막으로 원하는 위치에 파일의 압축을 푼다.
소스에서 빌드
어떤 이유로든 프로젝트를 직접 빌드하려면 다음 단계를 따르세요.
그 후에는 build 디렉터리 내에 dist 파일이 생기며, 원하는 위치에 압축을 풀어야 합니다.
메모
이는 새로운 Shlink 버전을 출시할 때 사용되는 프로세스입니다. git으로 새 버전에 태그를 지정하면 GitHub 워크플로에 의해 GitHub 릴리스가 자동으로 생성되어 생성된 dist 파일이 첨부됩니다.
git로 프로젝트를 복제하거나( git clone https://github.com/shlinkio/shlink.git ), 녹색 복제 또는 다운로드 버튼을 클릭하여 다운로드하세요.
프로젝트 폴더 안에 Composer PHP 패키지 관리자를 다운로드하세요.
./build.sh 3.0.0 실행하여 버전을 빌드하려는 버전 번호로 바꿉니다. 버전 번호는 생성된 dist 파일 이름의 일부로 사용되며, 다음에서 shlink -V 실행할 때 반환되는 값을 설정합니다. 명령줄).
프로젝트를 어떻게 빌드했든 이제 다음 단계에 따라 구성해야 합니다.
MySQL, MariaDB, PostgreSQL 또는 Microsoft SQL Server를 사용하려는 경우 원하는 이름으로 빈 데이터베이스를 만듭니다.
data 디렉터리에 쓰기 권한을 반복적으로 부여합니다. Shlink는 이를 사용하여 일부 정보를 캐시합니다.
vendor/bin/shlink-installer install 스크립트를 실행하여 애플리케이션을 설정합니다. 설치 과정을 안내하는 명령줄 도구입니다. 이 도구는 Shlink를 호스팅하려는 서버에서 직접 실행해야 한다는 점을 고려하세요. 업로드/이동하기 전에는 실행하지 마세요.
bin/cli api-key:generate 실행하여 첫 번째 API 키를 생성하세요. Shlink의 API와 상호작용하려면 키가 필요합니다.
shlink가 설치되면 상호 작용하는 두 가지 주요 방법이 있습니다.
명령줄 : 사용 가능한 모든 명령을 보려면 bin/cli 실행해 보세요.
이들 모두는 --help / -h 플래그를 사용하여 실행하여 사용 방법과 사용 가능한 모든 옵션을 확인할 수 있습니다.
모든 디렉터리에서 shlink를 실행할 수 있도록 CLI 진입점( bin/cli )을 경로의 어딘가에 심볼릭 링크하는 것이 좋습니다.
REST API : API 사용 방법에 대한 전체 문서는 여기에서 찾을 수 있으며, 모든 엔드포인트를 문서화하는 샌드박스도 API 사양 포털에서 찾을 수 있습니다.
그러나 원시 API를 직접 사용하고 싶지는 않을 것입니다. 이것이 바로 https://app.shlink.io에서 직접 사용하거나 직접 호스팅할 수 있는 멋진 웹 클라이언트가 제공되는 이유입니다.
API와 CLI 모두 명령줄 인터페이스에서만 수행할 수 있는 API 키 관리를 제외하고 거의 동일한 작업을 수행할 수 있습니다.
개발 모드에서 프로젝트를 실행하는 방법이나 기여를 제공하는 방법을 찾으려면 CONTRIBUTING 문서를 읽어보세요.
이 제품에는 MaxMind에서 생성한 GeoLite2 데이터가 포함되어 있으며 https://www.maxmind.com에서 사용할 수 있습니다.
