Unduh shlink - unduh kode sumber shlink

shlink

Kode sumber lainnya

v4.2.5

Unduh

Penyingkat URL yang dihosting sendiri berbasis PHP yang dapat digunakan untuk menyajikan URL yang dipersingkat di bawah domain Anda sendiri.

Daftar isi

Dokumentasi lengkap
gambar buruh pelabuhan
Dihosting sendiri

Unduh
Konfigurasikan

Menggunakan shlink
Berkontribusi

Dokumentasi lengkap

Dokumen ini berisi dasar-dasar untuk memulai dengan Shlink. Jika Anda ingin mempelajari semua yang dapat Anda lakukan dengannya, kunjungi dokumentasi lengkap yang dapat dicari.

gambar buruh pelabuhan

Anda dapat mempelajari cara menggunakan image buruh pelabuhan resmi dengan membaca dokumen.

Idenya adalah Anda bisa membuat container menggunakan gambar dan memberikan konfigurasi khusus melalui env vars.

Dihosting sendiri

Pertama, pastikan host tempat Anda akan menjalankan shlink memenuhi persyaratan berikut:

PHP 8.2 atau 8.3
Ekstensi PHP berikutnya: json, curl, pdo, intl, gd dan gmp/bcmath.

ekstensi apcu disarankan jika Anda tidak berencana menggunakan RoadRunner.
ekstensi xml diperlukan jika Anda ingin membuat kode QR dalam format svg.
soket dan ekstensi bcmath diperlukan jika Anda ingin berintegrasi dengan instance RabbitMQ.

MySQL, MariaDB, PostgreSQL, MicrosoftSQL atau SQLite.

Anda juga memerlukan variasi pdo yang sesuai untuk database yang ingin Anda gunakan: pdo_mysql , pdo_pgsql , pdo_sqlsrv atau pdo_sqlite .

Unduh

Untuk menjalankan Shlink, Anda memerlukan versi proyek yang dibuat. Ada dua cara untuk mendapatkannya.

Menggunakan file dist
Cara termudah untuk menginstal shlink adalah dengan menggunakan salah satu paket terdistribusi yang telah dibundel sebelumnya.
Buka versi terbaru dan unduh file shlink*_dist.zip yang sesuai dengan kebutuhan Anda. Anda akan menemukan satu untuk setiap versi PHP yang didukung.
Terakhir, dekompresi file di lokasi pilihan Anda.
Membangun dari sumber
Jika karena alasan apa pun Anda ingin membuat proyek sendiri, ikuti langkah-langkah berikut:
Setelah itu, Anda akan memiliki file dist di dalam direktori build , yang perlu Anda dekompresi di lokasi pilihan Anda.
Catatan
Ini adalah proses yang digunakan saat merilis versi Shlink baru. Setelah menandai versi baru dengan git, rilis GitHub secara otomatis dibuat oleh alur kerja GitHub, dengan melampirkan file dist yang dihasilkan ke dalamnya.

Kloning proyek dengan git ( git clone https://github.com/shlinkio/shlink.git ), atau unduh dengan mengklik tombol hijau Kloning atau unduh .
Unduh manajer paket Komposer PHP di dalam folder proyek.
Jalankan ./build.sh 3.0.0 , ganti versi dengan nomor versi yang akan Anda buat (nomor versi digunakan sebagai bagian dari nama file dist yang dihasilkan, dan untuk mengatur nilai yang dikembalikan saat menjalankan shlink -V dari baris perintah).

Konfigurasikan

Terlepas dari cara Anda membuat proyek, Anda sekarang perlu mengonfigurasinya, dengan mengikuti langkah-langkah berikut:

Jika Anda akan menggunakan MySQL, MariaDB, PostgreSQL atau Microsoft SQL Server, buat database kosong dengan nama pilihan Anda.
Berikan izin menulis ke direktori data secara rekursif. Shlink menggunakannya untuk menyimpan beberapa informasi.
Siapkan aplikasi dengan menjalankan skrip vendor/bin/shlink-installer install . Ini adalah alat baris perintah yang akan memandu Anda melalui proses instalasi. Ingatlah bahwa alat ini harus dijalankan langsung di server tempat Anda berencana menghosting Shlink. Jangan jalankan sebelum mengunggah/memindahkannya ke sana.
Hasilkan kunci API pertama Anda dengan menjalankan bin/cli api-key:generate . Anda memerlukan kunci untuk berinteraksi dengan API Shlink.

Menggunakan shlink

Setelah shlink diinstal, ada dua cara utama untuk berinteraksi dengannya:

Baris perintah : Coba jalankan bin/cli untuk melihat semua perintah yang tersedia.
Semuanya dapat dijalankan dengan tanda --help / -h untuk melihat cara menggunakannya dan semua opsi yang tersedia.
Mungkin ada baiknya untuk menghubungkan titik masuk CLI ( bin/cli ) ke suatu tempat di jalur Anda, sehingga Anda dapat menjalankan shlink dari direktori mana pun.
REST API : Dokumen lengkap tentang cara menggunakan API dapat ditemukan di sini, dan sandbox yang juga mendokumentasikan setiap titik akhir dapat ditemukan di portal Spesifikasi API.
Namun, Anda mungkin tidak ingin menggunakan API mentah sendiri. Itu sebabnya disediakan klien web bagus yang bisa langsung digunakan dari https://app.shlink.io, atau dihosting sendiri.

Baik API maupun CLI memungkinkan Anda melakukan sebagian besar operasi yang sama, kecuali untuk manajemen kunci API, yang hanya dapat dilakukan dari antarmuka baris perintah.