quicky

Quicky CLI

เครื่องมือ CLI ที่ปรับปรุงการปรับใช้และการจัดการของโครงการ Next.js และ node.js, เปิดใช้งานการเริ่มต้น, การปรับใช้จาก GitHub, อัปเดต, การลบ, การลบและการจัดการแอปพลิเคชันพร้อมกับการตั้งค่าโดเมนและใบรับรอง SSL ที่ง่ายขึ้น

คุณสมบัติ

• - การรวม GitHub : เริ่มต้นปรับใช้และจัดการโครงการ next.js และ node.js จากที่เก็บ GitHub ส่วนตัวและสาธารณะ
• การจัดการกระบวนการ : ใช้ประโยชน์จาก PM2 สำหรับวงจรชีวิตแอปพลิเคชันและการตรวจสอบ
• การบำรุงรักษาโครงการ : อัปเดตหรือลบโครงการที่ปรับใช้ได้อย่างง่ายดาย
• Domain & SSL Automation : กำหนดค่า NGINX โดยอัตโนมัติสำหรับโดเมนที่กำหนดเองและใบรับรอง SSL ช่วยให้คุณสามารถเพิ่ม/ลบโดเมนออกจากโครงการของคุณ
• ภาพรวมการกำหนดค่า : รายการและตรวจสอบรายละเอียดของโครงการที่ปรับใช้ทั้งหมดและโดเมนของพวกเขา
• - การจัดการ WebHook : ตั้งค่าจัดการและอัปเดต webhooks สำหรับการปรับใช้อัตโนมัติ
• การเข้าถึงแดชบอร์ด : จัดการและตรวจสอบเซิร์ฟเวอร์ WebHook ของคุณผ่านแผงหน้าปัดบนเว็บ
• - การจัดการบันทึก : ดูเอาต์พุตและบันทึกข้อผิดพลาดสำหรับเซิร์ฟเวอร์ WebHook ของคุณ

ข้อกำหนดเบื้องต้น

ในการติดตั้ง Quicky ก่อนอื่นรับเซิร์ฟเวอร์ Linux Ubuntu จากผู้ให้บริการเช่น DigitalOcean หรือ Hetzner

หลังจากตั้งค่าเซิร์ฟเวอร์ของคุณให้เชื่อมต่อกับมัน (เช่นผ่าน SSH) และติดตั้ง node.js และ NPM โดยดำเนินการคำสั่งต่อไปนี้:

sudo apt update
sudo apt install -y nodejs npm

การติดตั้ง

ติดตั้ง Quicky ทั่วโลกโดยใช้ npx หรือ npm :

npx quicky@latest install

หรือ

sudo npm install -g quicky

หมายเหตุ : คำสั่ง sudo เป็นสิ่งจำเป็นสำหรับการติดตั้งทั่วโลกและเพื่อป้องกันปัญหาการอนุญาตเมื่อกำหนดค่าโดเมน

การใช้งาน

1. เริ่มต้นอย่างรวดเร็ว

quicky init

คำสั่งนี้จะแจ้งให้คุณป้อนข้อมูลรับรอง GitHub และการกำหนดค่าพื้นฐานสำหรับการตั้งค่าโครงการของคุณ

Quicky ต้องใช้โทเค็นและชื่อผู้ใช้ GitHub ของคุณเพื่อโต้ตอบกับที่เก็บของคุณ หากต้องการสร้างโทเค็นใหม่ให้ทำตามขั้นตอนเหล่านี้:

1. เยี่ยมชมหน้าโทเค็นการเข้าถึงส่วนบุคคล GitHub ของคุณและตรวจสอบให้แน่ใจว่าใช้ โทเค็น (คลาสสิก)
2. คลิก สร้างโทเค็นใหม่
3. เลือกขอบเขตที่ต้องการสำหรับการเข้าถึงที่เก็บ
4. คลิก สร้างโทเค็น
5. คัดลอกโทเค็นและมอบให้อย่างรวดเร็วเป็นโทเค็นการเข้าถึง GitHub ของคุณ โทเค็นนี้จะถูกจัดเก็บในท้องถิ่นเพื่อใช้ในอนาคต

เพื่อเปิดใช้งานการปรับใช้อย่างต่อเนื่องให้ขอ URL WebHook สำหรับการปรับใช้อัตโนมัติ มันใช้โทเค็น GitHub ของคุณเพื่อตั้งค่าผู้ฟัง webhook และสร้าง webhooks แบบไดนามิก คุณจะต้องสร้างโดเมนย่อย (เช่น webhook.example.com ) ชี้ไปที่ที่อยู่ IP ของเซิร์ฟเวอร์ของคุณ สามารถทำได้โดยการเพิ่มบันทึก A ด้วยที่อยู่ IPv4 ของเซิร์ฟเวอร์ของคุณ

2. ปรับใช้โครงการ

quicky deploy

ตอนนี้ Quicky รองรับการปรับใช้ทั้งโครงการ next.js และ node.js ในระหว่างกระบวนการปรับใช้คุณจะได้รับแจ้งให้เลือกประเภทโครงการ:

• next.js
• node.js

การปรับใช้โครงการ next.js

ทำตามพรอมต์เพื่อเลือกพื้นที่เก็บข้อมูล next.js ของคุณ Quicky จะจัดการการปรับใช้และการกำหนดค่าโดยอัตโนมัติ

การปรับใช้โครงการ Node.js

ก่อนที่จะปรับใช้โครงการ Node.js ให้ตรวจสอบให้แน่ใจว่าไฟล์แอปพลิเคชันหลักของคุณมีชื่อว่า index.js คุณมีตัวเลือกในการระบุว่าโครงการของคุณจะใช้พอร์ตหรือไม่:

• ด้วยพอร์ต : ระบุหมายเลขพอร์ต (เช่น 3000) Quicky จะบันทึกไว้ในไฟล์ .env ช่วยให้คุณสามารถชี้โดเมนไปยังโครงการของคุณได้
• หากไม่มีพอร์ต : โดยไม่ต้องระบุพอร์ตโดเมนไม่สามารถนำไปยังโครงการได้ทำให้มันทำงานเป็นบริการพื้นหลังเท่านั้น

คำสั่งนี้จะแจ้งให้คุณทราบ:

• ชื่อผู้ใช้ GitHub ของคุณหรือชื่อองค์กรใด ๆ
• ชื่อที่เก็บ
• ประเภทโครงการ ( next.js หรือ node.js )
• หากเลือก node.js :
  • ไม่ว่าโครงการของคุณจะใช้พอร์ต
    • ถ้าใช่หมายเลขพอร์ตที่โครงการควรทำงาน (เช่น 3000)

ตัวแปรสภาพแวดล้อม - ในระหว่างการปรับใช้คุณจะถูกถามว่าคุณต้องการเพิ่มตัวแปรสภาพแวดล้อมในโครงการของคุณหรือไม่ Quicky จะจัดการการบันทึกหมายเลขพอร์ตในไฟล์ .env ของโครงการของคุณหากมี

3. จัดการโครงการ

quicky manage

แสดงรายการโครงการที่ปรับใช้ทั้งหมดและช่วยให้คุณ เริ่ม หยุด หยุดรีสตาร์ท อัปเดต หรือ ลบ โครงการเฉพาะ

4. อัปเดตโครงการโดย PID

quicky update < pid >

อัปเดตโครงการเฉพาะโดย PID ด้วยการเปลี่ยนแปลงล่าสุดจากที่เก็บ GitHub

5. ภาพรวมการกำหนดค่า

quicky list

แสดงภาพรวมของโครงการที่ปรับใช้ทั้งหมดรวมถึงรายละเอียดต่อไปนี้:

• PID : รหัสโครงการ
• เจ้าของ : ชื่อผู้ใช้ GitHub หรือชื่อองค์กร
• ที่เก็บ : ชื่อของที่เก็บ GitHub
• พอร์ต : หมายเลขพอร์ตที่โครงการกำลังทำงานอยู่
• สถานะ PM2 : สถานะปัจจุบันของกระบวนการ PM2
• อัปเดตล่าสุด : วันที่และเวลาของการปรับใช้/อัปเดตล่าสุด

6. โดเมน

ก่อนที่จะเพิ่มโดเมนในโครงการของคุณคุณต้อง:

1. - ซื้อชื่อโดเมน จากนายทะเบียนเช่น NameCheap หรือ GoDaddy
2. สร้างบันทึก A DNS ที่ชี้ไปที่ที่อยู่ IPv4 ของเซิร์ฟเวอร์ของคุณ

เมื่อคุณมีโดเมนแล้วคุณสามารถจัดการได้อย่างง่ายดายด้วยคำสั่งต่อไปนี้:

quicky domains

คำสั่งนี้ช่วยให้คุณสามารถ เพิ่ม และ ลบ โดเมนและโดเมนย่อยสำหรับโครงการของคุณได้อย่างง่ายดาย

7. webhooks

Quicky จัดเตรียมเซิร์ฟเวอร์ WebHook ในตัวเพื่ออัปเดตโครงการของคุณโดยอัตโนมัติเมื่อมีการส่งการเปลี่ยนแปลงไปยัง GitHub นี่คือวิธีการตั้งค่า:

การตั้งค่าเซิร์ฟเวอร์ WebHook

1. ข้อกำหนดเบื้องต้น

   • ตรวจสอบให้แน่ใจว่าคุณมีโดเมนย่อย (เช่น webhook.example.com) ชี้ไปที่ที่อยู่ IP ของเซิร์ฟเวอร์ของคุณ
   • เพิ่มบันทึก A DNS ด้วยที่อยู่ IPv4 ของเซิร์ฟเวอร์ของคุณ

2. การตั้งค่าเริ่มต้น

   quicky webhooks

   คำสั่งนี้จะ:

   • ตรวจสอบว่าเซิร์ฟเวอร์ webhook กำลังทำงานอยู่หรือไม่
   • แนะนำคุณตลอดกระบวนการตั้งค่าหากจำเป็น
   • พร้อมท์สำหรับการกำหนดค่า webhook

3. การกำหนดค่า

   • คุณจะต้องจัดเตรียม URL webhook (รูปแบบ: https: /// webhook)
   • เซิร์ฟเวอร์ WebHook จะเริ่มโดยอัตโนมัติหลังจากตั้งค่า

4. ตรวจสอบการตั้งค่า

   quicky webhooks status

   รายการนี้แสดง:

   • สถานะการรันเซิร์ฟเวอร์
   • ตัวเลือกในการรีสตาร์ท/หยุดเซิร์ฟเวอร์
   • เข้าถึงบันทึกเซิร์ฟเวอร์

Webhook Dashboard

1. การตั้งค่าการเข้าถึงแดชบอร์ด

   quicky webhooks dashboard

   • ตั้งค่าชื่อผู้ใช้และรหัสผ่าน
   • ข้อมูลประจำตัวจะถูกเก็บไว้อย่างปลอดภัย

2. เข้าถึงแดชบอร์ด

   • เปิดเบราว์เซอร์ของคุณเป็น https: /// dashboard
   • เข้าสู่ระบบด้วยข้อมูลประจำตัวของคุณ
   • ตรวจสอบสถานะ webhook
   • ดูบันทึก webhook

การจัดการ webhooks

ใช้ quicky webhooks กับคำสั่งเหล่านี้:

• status - ตรวจสอบสถานะเซิร์ฟเวอร์ WebHook
• restart - รีสตาร์ทเซิร์ฟเวอร์ WebHook
• stop - หยุดเซิร์ฟเวอร์ WebHook
• logs - ดูบันทึกเซิร์ฟเวอร์ WebHook
• dashboard - เข้าถึง Dashboard Webhook

8. อัพเกรด Quicky

quicky upgrade

อัพเกรด Quicky เป็นเวอร์ชันล่าสุด

9. ถอนการติดตั้ง Quicky

quicky uninstall

ลบอย่างรวดเร็วจากระบบของคุณ

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT - ดูไฟล์ใบ LICENSE สำหรับรายละเอียด

ผู้เขียน

• อโลฮี

อย่าลังเลที่จะติดต่อฉัน? @alemalohe หากคุณมีคำถามหรือข้อเสนอแนะ!

การบริจาค

ยินดีต้อนรับ! โปรดอ่านไฟล์ที่มีส่วนร่วมสำหรับแนวทางเกี่ยวกับวิธีการเริ่มต้น