Penyingkat URL yang dihosting sendiri berbasis PHP yang dapat digunakan untuk menyajikan URL yang dipersingkat di bawah domain Anda sendiri.
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.
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.
Pertama, pastikan host tempat Anda akan menjalankan shlink memenuhi persyaratan berikut:
pdo_mysql
, pdo_pgsql
, pdo_sqlsrv
atau pdo_sqlite
.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:
git clone https://github.com/shlinkio/shlink.git
), atau unduh dengan mengklik tombol hijau Kloning atau unduh ../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). 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.
Terlepas dari cara Anda membangun proyek, Anda sekarang perlu mengonfigurasinya, dengan mengikuti langkah-langkah berikut:
data
secara rekursif. Shlink menggunakannya untuk menyimpan beberapa informasi.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 menjalankannya sebelum mengunggah/memindahkannya ke sana.bin/cli api-key:generate
. Anda memerlukan kunci untuk berinteraksi dengan API 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.
Jika Anda mencoba mencari tahu cara menjalankan proyek dalam mode pengembangan atau cara memberikan kontribusi, bacalah dokumen KONTRIBUSI.
Produk ini mencakup data GeoLite2 yang dibuat oleh MaxMind, tersedia dari https://www.maxmind.com