ย่อลิงค์

เครื่องมือย่อ URL ที่โฮสต์เองโดยใช้ PHP ซึ่งสามารถใช้เพื่อให้บริการ URL แบบสั้นภายใต้โดเมนของคุณเอง

สารบัญ

• เอกสารครบ
• ภาพนักเทียบท่า
• โฮสต์เอง
  • ดาวน์โหลด
  • กำหนดค่า
• การใช้ shlink
• มีส่วนร่วม

เอกสารครบ

เอกสารนี้มีพื้นฐานเบื้องต้นในการเริ่มต้นใช้งาน Shlink หากคุณต้องการเรียนรู้ทุกสิ่งที่คุณสามารถทำได้ โปรดไปที่เอกสารที่สามารถค้นหาได้ฉบับเต็ม

ภาพนักเทียบท่า

คุณสามารถเรียนรู้วิธีใช้อิมเมจนักเทียบท่าอย่างเป็นทางการได้โดยการอ่านเอกสาร

แนวคิดก็คือคุณสามารถสร้างคอนเทนเนอร์โดยใช้อิมเมจและจัดเตรียมการกำหนดค่าแบบกำหนดเองผ่าน env vars

โฮสต์เอง

ขั้นแรก ตรวจสอบให้แน่ใจว่าโฮสต์ที่คุณจะเรียกใช้ 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 ) หรือดาวน์โหลดโดยคลิกปุ่ม Clone หรือดาวน์โหลด สีเขียว
  • ดาวน์โหลดตัวจัดการแพ็คเกจ Composer PHP ภายในโฟลเดอร์โครงการ
  • เรียกใช้ ./build.sh 3.0.0 โดยแทนที่เวอร์ชันด้วยหมายเลขเวอร์ชันที่คุณจะสร้าง (หมายเลขเวอร์ชันจะใช้เป็นส่วนหนึ่งของชื่อไฟล์ dist ที่สร้างขึ้น และเพื่อตั้งค่าที่ส่งคืนเมื่อรัน shlink -V จาก บรรทัดคำสั่ง)

  หลังจากนั้น คุณจะมีไฟล์ dist อยู่ในไดเร็กทอรี build ซึ่งคุณต้องขยายขนาดในตำแหน่งที่คุณเลือก

  บันทึก

  นี่เป็นกระบวนการที่ใช้ในการเปิดตัว Shlink เวอร์ชันใหม่ หลังจากติดแท็กเวอร์ชันใหม่ด้วย git แล้ว GitHub release จะถูกสร้างขึ้นโดยอัตโนมัติโดยเวิร์กโฟลว์ GitHub โดยแนบไฟล์ dist ที่สร้างขึ้นลงไป

กำหนดค่า

แม้ว่าคุณจะสร้างโปรเจ็กต์ด้วยวิธีใด แต่ตอนนี้คุณต้องกำหนดค่าโดยทำตามขั้นตอนเหล่านี้:

• หากคุณกำลังจะใช้ MySQL, MariaDB, PostgreSQL หรือ Microsoft SQL Server ให้สร้างฐานข้อมูลเปล่าด้วยชื่อที่คุณเลือก
• ให้สิทธิ์การเขียนซ้ำไปยังไดเร็กทอรี data Shlink ใช้เพื่อแคชข้อมูลบางอย่าง
• ตั้งค่าแอปพลิเคชันโดยการรันสคริปต์ vendor/bin/shlink-installer install เป็นเครื่องมือบรรทัดคำสั่งที่จะแนะนำคุณตลอดกระบวนการติดตั้ง โปรดทราบว่าจะต้องเรียกใช้เครื่องมือนี้โดยตรงบนเซิร์ฟเวอร์ที่คุณวางแผนจะโฮสต์ Shlink อย่ารันก่อนที่จะอัพโหลด/ย้ายมันไปที่นั่น
• สร้างคีย์ API แรกของคุณโดยการรัน bin/cli api-key:generate คุณจะต้องมีรหัสเพื่อโต้ตอบกับ API ของ Shlink

การใช้ shlink

เมื่อติดตั้ง shlink แล้ว มีสองวิธีหลักในการโต้ตอบกับมัน:

• บรรทัดคำสั่ง : ลองเรียกใช้ bin/cli เพื่อดูคำสั่งที่มีอยู่ทั้งหมด

  ทั้งหมดสามารถรันได้ด้วยแฟล็ก --help / -h เพื่อดูวิธีการใช้งานและตัวเลือกทั้งหมดที่มี

  อาจเป็นความคิดที่ดีที่จะเชื่อมโยงจุดเข้าใช้งาน CLI ( bin/cli ) ไปยังที่ไหนสักแห่งในเส้นทางของคุณ เพื่อให้คุณสามารถเรียกใช้ shlink จากไดเร็กทอรีใดก็ได้

• REST API : คุณสามารถดูเอกสารฉบับสมบูรณ์เกี่ยวกับวิธีใช้ API ได้ที่นี่ และแซนด์บ็อกซ์ที่จัดทำเอกสารตำแหน่งข้อมูลทุกจุดอยู่ในพอร์ทัลข้อมูลจำเพาะ API

  อย่างไรก็ตาม คุณอาจไม่ต้องการใช้ Raw API ด้วยตัวเอง นั่นเป็นเหตุผลว่าทำไมจึงมีเว็บไคลเอ็นต์ที่ดีซึ่งสามารถใช้ได้โดยตรงจาก https://app.shlink.io หรือโฮสต์ด้วยตัวเอง

ทั้ง API และ CLI อนุญาตให้คุณดำเนินการเดียวกันเป็นส่วนใหญ่ ยกเว้นการจัดการคีย์ API ซึ่งสามารถทำได้จากอินเทอร์เฟซบรรทัดคำสั่งเท่านั้น

มีส่วนร่วม

หากคุณกำลังพยายามค้นหาวิธีดำเนินโครงการในโหมดการพัฒนาหรือวิธีให้การสนับสนุน โปรดอ่านเอกสารการสนับสนุน

---

ผลิตภัณฑ์นี้ประกอบด้วยข้อมูล GeoLite2 ที่สร้างโดย MaxMind ซึ่งหาได้จาก https://www.maxmind.com