หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

เกี่ยวกับ ntfy

ntfy นำการแจ้งเตือนไปยังเปลือกของคุณ มันสามารถให้การแจ้งเตือนเดสก์ท็อปโดยอัตโนมัติเมื่อคำสั่งที่ใช้งานยาวนานหรือสามารถส่งการแจ้งเตือนแบบพุชไปยังโทรศัพท์ของคุณเมื่อคำสั่งเฉพาะเสร็จสิ้น สับสน? วิดีโอนี้แสดงให้เห็นถึงฟังก์ชั่นนี้บางอย่าง:

เร็ว 

$ sudo pip install ntfy
$ ntfy send test
# send a notification when the command `sleep 10` finishes
# this sends the message '"sleep 10" succeeded in 0:10 minutes'
$ ntfy done sleep 10
$ ntfy -b pushover -o user_key t0k3n send ' Pushover test! '
$ ntfy -t ' ntfy ' send " Here's a custom notification title! "
$ echo -e ' backends: ["pushover"]npushover: {"user_key": "t0k3n"} ' > ~ /.ntfy.yml
$ ntfy send " Pushover via config file! "
$ ntfy done --pid 6379  # pid extra
$ ntfy send " :tada: ntfy supports emoji! :100: "  # emoji extra
# Enable shell integration
$ echo ' eval "$(ntfy shell-integration)" ' >> ~ /.bashrc

ติดตั้ง

เทคนิคการติดตั้งใน QuickStart เป็นวิธีการติดตั้งที่แนะนำ มันสามารถติดตั้งใน virtualenv ได้ แต่ด้วยคำเตือนบางอย่าง: การแจ้งเตือน Linux จำเป็นต้องใช้ --system-site-packages สำหรับ VirtualEnV และ OS X การแจ้งเตือนไม่ทำงานเลย

- หมายเหตุ: การแจ้งเตือนเดสก์ท็อป Linux ต้องมีการผูก Python DBUS ดูที่นี่สำหรับข้อมูลเพิ่มเติม

การรวมเชลล์

ntfy มีการสนับสนุนสำหรับการส่งการแจ้งเตือน โดยอัตโนมัติ เมื่อคำสั่งที่ใช้งานยาวนานใน Bash และ ZSH ใน Bash It จำลองฟังก์ชั่น preexec ของ ZSH และ precmd ด้วย rcaloras/bash-preexec เพื่อเปิดใช้งานการเพิ่มสิ่งต่อไปนี้ใน .bashrc หรือ .zshrc : 

 eval " $( ntfy shell-integration ) "

โดยค่าเริ่มต้นจะส่งการแจ้งเตือนสำหรับคำสั่งที่ใช้งานได้นานกว่า 10 วินาทีเท่านั้นและหากเทอร์มินัลมุ่งเน้น Terminal Focus ทำงานบน X11 (Linux) และกับ Terminal.app และ Iterm2 บน MacOS ตัวเลือกทั้งสองสามารถกำหนดค่าได้ผ่านตัวเลือก --longer-than และ --foreground-too

เพื่อหลีกเลี่ยงการแจ้งเตือนที่ไม่จำเป็นเมื่อเรียกใช้โปรแกรมแบบโต้ตอบโปรแกรมที่ระบุไว้ใน AUTO_NTFY_DONE_IGNORE ไม่ได้สร้างการแจ้งเตือน ตัวอย่างเช่น: 

 export AUTO_NTFY_DONE_IGNORE= " vim screen meld "

ความพิเศษ

ntfy มีคุณสมบัติบางอย่างที่ต้องใช้การพึ่งพาเพิ่มเติม
  • ntfy done -p $PID ต้องติดตั้งเป็น pip install ntfy[pid]
  • การสนับสนุน Emoji ต้องติดตั้งเป็น pip install ntfy[emoji]
  • การสนับสนุน XMPP ต้องการการติดตั้งเป็น pip install ntfy[xmpp]
  • การสนับสนุนโทรเลขจำเป็นต้องติดตั้งเป็น pip install ntfy[telegram]
  • การสนับสนุน Instapush ต้องการการติดตั้งเป็น pip install ntfy[instapush]
  • Slack Support ต้องการการติดตั้งเป็น pip install ntfy[slack]
  • การใช้งาน WebHook ที่เข้ามา
  • Rocket.Chat สนับสนุนต้องติดตั้งเป็น pip install ntfy[rocketchat]

ในการติดตั้งพิเศษหลายรายการให้แยกด้วยเครื่องหมายจุลภาค: เช่น pip install ntfy[pid,emoji]

การกำหนด ntfy

ntfy ได้รับการกำหนดค่าด้วยไฟล์ YAML ที่เก็บไว้ที่ ~/.ntfy.yml หรือในตำแหน่งเฉพาะแพลตฟอร์มมาตรฐาน:

  • linux - ~/.config/ntfy/ntfy.yml
  • MacOS - ~/Library/Application Support/ntfy/ntfy.yml
  • Windows - C:Users<User>AppDataLocaldschepntfy.yml

แบ็กเอนด์

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

---
backends :
    - pushover
pushover :
    user_key : hunter2
pushbullet :
    access_token : hunter2
simplepush :
    key : hunter2
slack :
    token : slacktoken
    recipient : " #slackchannel "
xmpp :
     jid : " [email protected] "
     password : " xxxx "
     mtype : " chat "
     recipient : " [email protected] "

หากคุณต้องการ mulitple configs สำหรับประเภทแบ็กเอนด์เดียวกันคุณสามารถระบุชื่อใด ๆ แล้วระบุแบ็กเอนด์ด้วยคีย์แบ็กเอนด์ ตัวอย่างเช่น: 

---
pushover :
    user_key : hunter2
cellphone :
    backend : pushover
    user_key : hunter2

ดูแบ็กเอนด์ด้านล่างสำหรับแบ็กเอนด์และตัวเลือกที่มีอยู่ ณ v2.6.0 ntfy ยังรองรับแบ็กเอนด์ของบุคคลที่สาม

pushover - pushover

พารามิเตอร์ที่จำเป็น:
  • user_key
พารามิเตอร์เสริม:
  • sound
  • priority
  • expire
  • retry
  • callback
  • api_token - ใช้โทเค็นแอปพลิเคชันของคุณเอง
  • device - กำหนดเป้าหมายอุปกรณ์หากละเว้นการแจ้งเตือนจะถูกส่งไปยังอุปกรณ์ทั้งหมด
  • url
  • url_title
  • html

Pushbullet - pushbullet

พารามิเตอร์ที่ต้องการ:
  • access_token - โทเค็นการเข้าถึง pushbullet ของคุณสร้างขึ้นที่ https://www.pushbullet.com/#settings/account
พารามิเตอร์เสริม:
  • device_iden - ตัวระบุอุปกรณ์หากถูกละเว้นการแจ้งเตือนจะถูกส่งไปยังอุปกรณ์ทั้งหมด
  • email - ส่งการแจ้งเตือนไปยังผู้ใช้ Pushbullet ด้วยอีเมลที่ระบุหรือส่งอีเมลหากไม่ใช่ผู้ใช้ Pushullet

SimplePush - simplepush

พารามิเตอร์ที่ต้องการ:
  • key - คีย์ SimplePush ของคุณสร้างขึ้นโดยการติดตั้งแอพ Android (ไม่จำเป็นต้องลงทะเบียน) ที่ https://simplepush.io
พารามิเตอร์เสริม:
  • event - ตั้งค่าเสียงเรียกเข้าและรูปแบบการสั่นสะเทือนสำหรับการแจ้งเตือนที่เข้ามา (สามารถกำหนดได้ในแอพ SimplePush)

XMPP - xmpp

ต้องใช้พารามิเตอร์:
  • jid
  • password
  • recipient
พารามิเตอร์เสริม
  • hostname (ถ้าไม่มาจาก JID)
  • port
  • path_to_certs
  • mtype

ต้องมีความพิเศษติดตั้งเช่นนี้: pip install ntfy[xmpp]

ในการตรวจสอบใบรับรอง SSL ที่เสนอโดยเซิร์ฟเวอร์: path_to_certs = "path/to/ca/cert"

หากไม่มีการติดตั้งไลบรารี DNSpython คุณจะต้องระบุชื่อโฮสต์เซิร์ฟเวอร์หากไม่ตรงกับ JID

ระบุพอร์ตหากนอกเหนือจาก 5222 หมายเหตุ: ละเว้นโดยไม่ระบุชื่อโฮสต์ที่ระบุ

หมายเหตุ: Google Hangouts ไม่รองรับ XMPP ตั้งแต่ปี 2560

โทรเลข - telegram

ต้องมีความพิเศษติดตั้งเช่นนี้: pip install ntfy[telegram]

ต้องติดตั้ง ntfy เป็น ntfy[telegram] แบ็กเอนด์นี้ได้รับการกำหนดค่าเป็นครั้งแรกที่คุณจะลองใช้: ntfy -b telegram send "Telegram configured for ntfy"

pushjet - pushjet

พารามิเตอร์ที่ต้องการ:
  • secret -The Pushjet Service Secret Token สร้างขึ้นด้วย http://docs.pushjet.io/docs/creating-a-new-service
พารามิเตอร์เสริม:
  • endpoint - จุดสิ้นสุดของพุชเจ็ท API แบบกำหนดเอง
    (ค่าเริ่มต้นเป็น https://api.pushjet.io)
  • level - ระดับความสำคัญจาก 1 (ต่ำ) ถึง 5 (สูง)
  • link

Notifico - notifico

พารามิเตอร์ที่ต้องการ:
  • webhook - ลิงค์ WebHook สร้างขึ้นที่ https://n.tkte.ch/
    (เลือกบริการ Plain Text เมื่อสร้าง webhook)

หย่อน - slack

ต้องมีความพิเศษติดตั้งเช่นนี้: pip install ntfy[slack]

พารามิเตอร์ที่ต้องการ:
  • token -โทเค็นความลับของบริการหย่อนไม่ว่าจะเป็นโทเค็นผู้ chat:write:bot รุ่นเก่าที่สร้างขึ้นที่ https://api.slack.com/custom-integrations/legacy-tokens หรือโทเค็นที่ได้รับจากการสร้างแอพที่ https://api.slack.com/apps
  • recipient - ช่อง Slack หรือผู้ใช้เพื่อส่งการแจ้งเตือนไปที่ หากคุณใช้สัญลักษณ์ # ข้อความจะส่งไปยังช่อง Slack และหากคุณใช้สัญลักษณ์ @ ข้อความจะส่งข้อความไปยังผู้ใช้ Slack

slack webhook - slack_webhook

พารามิเตอร์ที่ต้องการ:
  • url - URL ของ webhook ที่เข้ามา
  • user - ช่อง Slack หรือผู้ใช้เพื่อส่งการแจ้งเตือนไปยัง

Instapush - insta

ต้องมีความพิเศษติดตั้งเช่น pip install ntfy[instapush]

Instapush ไม่รองรับชื่อการแจ้งเตือน มันส่งการแจ้งเตือนที่ขับเคลื่อนด้วยเทมเพลตดังนั้นคุณต้องตั้งค่ากิจกรรมของคุณบนแดชบอร์ดก่อน แบ็กเอนด์เรียกว่า Insta เนื่องจาก homonymy กับ wrapper instapush python

พารามิเตอร์ที่จำเป็น:
  • appid - รหัสแอปพลิเคชัน
  • secret - แอปพลิเคชันลับ
  • event_name - เหตุการณ์ Instapush ที่จะใช้
  • trackers - อาร์เรย์ของร้านค้าที่จะใช้

หมายเหตุเกี่ยวกับตัวติดตาม: ตัวติดตามเป็นตัวยึดตำแหน่งสำหรับกิจกรรม (ประเภทของเทมเพลตการแจ้งเตือน) หากคุณกำหนดตัวติดตามมากกว่าหนึ่งตัวในกรณีของคุณคุณจะต้องให้ข้อความเพิ่มเติม ในขณะนี้วิธีเดียวที่จะทำเช่นนั้นคือการแยกแต่ละข้อความด้วยลำไส้ใหญ่ (:) ตัวละคร นอกจากนี้คุณยังสามารถหลบหนีอักขระตัวคั่น: ตัวอย่าง: 

ntfy -b insta send " message1:message2 "
ntfy -b insta send " message1:message2:with:colons "

เดิน prowl

พารามิเตอร์เสริม:
  • api_key
  • provider_key
  • priority
  • url

Linux Desktop Notifications - linux

ทำงานผ่าน DBUS ทำงานร่วมกับ DES ส่วนใหญ่เช่น Gnome, KDE, XFCE และกับ Libnotify

ควรติดตั้งการพึ่งพาต่อไปนี้ 

$ sudo apt install python-dbus # on ubuntu/debian

คุณจะต้องติดตั้งแบบอักษรที่รองรับอิโมจิ (ใน Debian Fonts-Symbola หรือ Gentoo Media-Fonts/Symbola)

พารามิเตอร์เสริม:
  • icon - ระบุเส้นทางไปยังไอคอนการแจ้งเตือนสตริงว่างสำหรับไอคอนไม่มี
  • urgency - ระบุระดับความเร่งด่วน (ต่ำปกติวิกฤต)
  • transient - ข้ามประวัติ (exp: ถาดข้อความ GNOME) (จริง, เท็จ)
  • soundfile - ระบุไฟล์เสียงการแจ้งเตือน (เช่น /usr/share/sounds/notif.wav)
  • timeout - ระบุระดับเวลาการหมดอายุการแจ้งเตือน (-1 - ค่าเริ่มต้นของระบบ 0 - อย่าหมดอายุ)

การแจ้งเตือนเดสก์ท็อป Windows - win32

ใช้ pywin32

Mac OS X Notification Center - darwin

ต้องการให้ ntfy ติดตั้งทั่วโลก (ไม่ใช่ใน VirtualEnV)

บันทึกระบบ - systemlog

ใช้โมดูล syslog Core Python ซึ่งไม่สามารถใช้ได้บนแพลตฟอร์ม Windows

พารามิเตอร์เสริม:

  • prio - ระดับลำดับความสำคัญของ Syslog ค่าเริ่มต้นคือ ALERT ค่าที่เป็นไปได้คือ:

    • โผล่ออกมา
    • เตือน
    • การตี
    • ทำผิดพลาด
    • คำเตือน
    • สังเกต
    • ข้อมูล
    • การดีบัก

  • facility - สิ่งอำนวยความสะดวก syslog ค่าเริ่มต้นคือ LOCAL5 ค่าที่เป็นไปได้คือ:

    • เคอร์น
    • ผู้ใช้
    • ส่งจดหมาย
    • เสื้อกล้าม
    • รับรองความถูกต้อง
    • LPR
    • ข่าว
    • UUCP
    • โครน
    • syslog
    • ท้องถิ่น 0
    • ท้องถิ่น 1
    • ท้องถิ่น 2
    • ท้องถิ่น 3
    • ท้องถิ่น 4
    • ท้องถิ่น 5
    • ท้องถิ่น 6
    • ท้องถิ่น 7

  • fmt - รูปแบบของข้อความที่จะส่งไปยังเครื่องบันทึกระบบ ชื่อและข้อความถูกระบุโดยใช้ตัวยึดตำแหน่งต่อไปนี้:

    • {title}
    • {message}

    ค่าเริ่มต้นคือ [{title}] {message}

TERMUX: API - termux

ต้องการแอพที่จะติดตั้งจาก Play Store และ Utility CLI ได้รับการติดตั้งด้วย apt install termux-api

pushalot - pushalot

พารามิเตอร์ที่ต้องการ:
  • auth_token - โทเค็น Auth Private Pushalot ของคุณพบที่นี่ https://pushalot.com/manager/authorizations
พารามิเตอร์เสริม:
  • source - แหล่งที่มาของการแจ้งเตือน
  • ttl - ข้อความหมดเวลาในนาที (เวลาในการอยู่)
  • url - URL เพื่อรวมไว้ในการแจ้งเตือน
  • url_title - ชื่อ URL ที่มองเห็นได้ (ไม่สนใจหากไม่ได้ระบุ URL)
  • image - URL ของรูปภาพที่รวมอยู่ในการแจ้งเตือน
  • important - การแจ้งเตือนทำเครื่องหมายเป็นสิ่งสำคัญ
  • silent - การแจ้งเตือนมาร์คเป็นเงียบ

rocket.chat - rocketchat

ต้องมีความพิเศษติดตั้งเช่นนี้: pip install ntfy[rocketchat]

พารามิเตอร์ที่จำเป็น:
  • url - URL ของอินสแตนซ์ rocket.chat ของคุณ
  • username - เข้าสู่ระบบชื่อผู้ใช้
  • password - รหัสผ่านเข้าสู่ระบบ
  • room - ห้อง/ช่องชื่อโพสต์ใน

matrix.org - matrix

ต้องมีความพิเศษติดตั้งเช่นนี้: pip install ntfy[matrix]

พารามิเตอร์ที่จำเป็น:
  • url - URL ของอินสแตนซ์ผู้ให้บริการบ้านของคุณ
  • roomId - ห้องที่จะโพสต์ใน
  • userId - เข้าสู่ระบบ USERID
  • password - รหัสผ่านเข้าสู่ระบบ
  • token - โทเค็นการเข้าถึง

คุณต้องระบุ token หรือ userId และ password

WebPush - ntfy_webpush

การสนับสนุน WebPush ได้รับการพิสูจน์โดยโมดูล NTFY ภายนอกติดตั้งเช่นนี้: pip install ntfy ntfy-webpush

พารามิเตอร์ที่จำเป็น:
  • subscription_info - วัตถุ pushsubscription
  • private_key - เส้นทางไปยังไฟล์คีย์ส่วนตัวหรือสิ่งอื่นใดที่ทำงานกับ PyWebPush

สำหรับข้อมูลเพิ่มเติมดู ntfy-webpush <https://github.com/dschep/ntfy-webpush> `_

แบ็กเอนด์ของบุคคลที่สาม

หากต้องการใช้หรือใช้แบ็กเอนด์ของคุณเองให้ระบุเส้นทางเต็มของโมดูลเป็นแบ็กเอนด์ของคุณ โมดูลจำเป็นต้องมีโมดูลที่มีฟังก์ชั่นที่เรียกว่า notify ด้วยลายเซ็นต่อไปนี้: 

 def notify ( title , message , ** kwargs ):
    """
    kwargs contains retcode if using ntfy done or ntfy shell-integration
    and all options in your backend's section of the config
    """
    pass

ตัวเลือกอื่น ๆ

ชื่อเรื่องสามารถกำหนดค่าได้ด้วยคีย์ชื่อเรื่องในการกำหนดค่า ตัวอย่าง: 

---
title : Customized Title

แบ็กเอนด์สิ่งที่ต้องทำ

  • แอร์กรัม
  • รถบ็อกซาร์

การทดสอบ 

python setup.py test

ผู้มีส่วนร่วม

  • DSCHEP - ผู้ดูแลและนักพัฒนานำ
  • Danryder - การสนับสนุน XMPP Backend & Emoji
  • OZ123 - การปรับปรุงการแจ้งเตือนเดสก์ท็อป Linux
  • Schwert - การสนับสนุน Pushjet
  • Rahiel - การสนับสนุนโทรเลข
  • tymm - การสนับสนุน SimplePush
  • Jungle -Boogie - การอัปเดตเอกสาร
  • tjbenator - ตัวเลือกการผลักดันขั้นสูง
  • Mobiusklein - Win32 Bugfix
  • Rcaloras - ผู้สร้าง Bash -Prexec โดยที่ไม่มีการรวม Bash Shell Integration สำหรับ NTFY
  • Eightnoteight - การสนับสนุน Notifico
  • Juanpabloaj - Slack Support
  • Giuseongit - การสนับสนุน Instapush
  • Jlesage - Systemlog Support
  • Sambrightman - การสนับสนุน Prowl
  • Mlesniew - สนับสนุน Pushalot
  • webworxshop - rocket.chat support
  • Rhabbachi - ตัวเลือกชั่วคราวในการแจ้งเตือนเดสก์ท็อป Linux
  • Half -shot - Matrix Support
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด