mirrors
/
ntfy
огледало от https://github.com/binwiederhier/ntfy


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">

    <title>ntfy.sh | simple HTTP-based pub-sub</title>
    <link rel="stylesheet" href="static/css/app.css" type="text/css">

    <!-- Mobile view -->
    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="HandheldFriendly" content="true">

    <!-- Mobile browsers, background color -->
    <meta name="theme-color" content="#39005a">
    <meta name="msapplication-navbutton-color" content="#39005a">
    <meta name="apple-mobile-web-app-status-bar-style" content="#39005a">

    <!-- Favicon, see favicon.io -->
    <link rel="icon" type="image/png" href="static/img/favicon.png">

    <!-- Previews in Google, Slack, WhatsApp, etc. -->
    <meta property="og:type" content="website" />
    <meta property="og:locale" content="en_US" />
    <meta property="og:site_name" content="ntfy.sh" />
    <meta property="og:title" content="ntfy.sh | simple HTTP-based pub-sub" />
    <meta property="og:description" content="ntfy is a simple HTTP-based pub-sub notification service. It allows you to send desktop notifications via scripts from any computer, entirely without signup or cost. Made with ❤ by Philipp C. Heckel, Apache License 2.0, source at https://heckel.io/ntfy." />
    <meta property="og:image" content="/static/img/ntfy.png" />
    <meta property="og:url" content="https://ntfy.sh" />
</head>
<body>
<div id="main">
    <h1><img src="static/img/ntfy.png" alt="ntfy"/><br/>ntfy.sh - simple HTTP-based pub-sub</h1>
    <p>
        <b>ntfy</b> (pronounce: <i>notify</i>) is a simple HTTP-based <a href="https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern">pub-sub</a> notification service.
        It allows you to send <b>desktop notifications via scripts from any computer</b>, entirely <b>without signup or cost</b>.
        It's also <a href="https://github.com/binwiederhier/ntfy">open source</a> if you want to run your own.
    </p>
    <p id="error"></p>

    <h2>Publishing messages</h2>
    <p>
        Publishing messages can be done via PUT or POST using. Topics are created on the fly by subscribing or publishing to them.
        Because there is no sign-up, <b>the topic is essentially a password</b>, so pick something that's not easily guessable.
    </p>
    <p class="smallMarginBottom">
        Here's an example showing how to publish a message using <tt>curl</tt>:
    </p>
    <code>
        curl -d "long process is done" ntfy.sh/mytopic
    </code>
    <p class="smallMarginBottom">
        Here's an example in JS with <tt>fetch()</tt> (see <a href="https://github.com/binwiederhier/ntfy/tree/main/examples">full example</a>):
    </p>
    <code>
        fetch('https://ntfy.sh/mytopic', {<br/>
        &nbsp;&nbsp;method: 'POST', // PUT works too<br/>
        &nbsp;&nbsp;body: 'Hello from the other side.'<br/>
        })
    </code>

    <h2>Subscribe to a topic</h2>
    <p>
        You can create and subscribe to a topic either in this web UI, or in your own app by subscribing to an
        <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventSource">EventSource</a>, a JSON feed, or raw feed.
    </p>

    <h3>Subscribe via web</h3>
    <p>
        If you subscribe to a topic via this web UI in the field below, messages published to any subscribed topic
        will show up as <b>desktop notification</b>.
    </p>
    <form id="subscribeForm">
        <p>
            <label for="topicField">Subscribe to topic:</label>
            <input type="text" id="topicField" placeholder="Letters, numbers, _ and -"  pattern="[-_A-Za-z]{1,64}" />
            <input type="submit" id="subscribeButton" value="Subscribe" />
        </p>
    </form>
    <p id="topicsHeader">Topics:</p>
    <ul id="topicsList"></ul>
    <audio id="notifySound" src="static/sound/mixkit-message-pop-alert-2354.mp3"></audio>

    <h3>Subscribe via your app, or via the CLI</h3>
    <p class="smallMarginBottom">
        Using <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventSource">EventSource</a> in JS, you can consume
        notifications like this (see <a href="https://github.com/binwiederhier/ntfy/tree/main/examples">full example</a>):
    </p>
    <code>
        const eventSource = new EventSource('https://ntfy.sh/mytopic/sse');<br/>
        eventSource.onmessage = (e) => {<br/>
        &nbsp;&nbsp;// Do something with e.data<br/>
        };
    </code>
    <p class="smallMarginBottom">
        You can also use the same <tt>/sse</tt> endpoint via <tt>curl</tt> or any other HTTP library:
    </p>
    <code>
        $ curl -s ntfy.sh/mytopic/sse<br/>
        event: open<br/>
        data: {"id":"weSj9RtNkj","time":1635528898,"event":"open","topic":"mytopic"}<br/><br/>

        data: {"id":"p0M5y6gcCY","time":1635528909,"event":"message","topic":"mytopic","message":"Hi!"}<br/><br/>

        event: keepalive<br/>
        data: {"id":"VNxNIg5fpt","time":1635528928,"event":"keepalive","topic":"test"}
    </code>
    <p class="smallMarginBottom">
        To consume JSON instead, use the <tt>/json</tt> endpoint, which prints one message per line:
    </p>
    <code>
        $ curl -s ntfy.sh/mytopic/json<br/>
        {"id":"SLiKI64DOt","time":1635528757,"event":"open","topic":"mytopic"}<br/>
        {"id":"hwQ2YpKdmg","time":1635528741,"event":"message","topic":"mytopic","message":"Hi!"}<br/>
        {"id":"DGUDShMCsc","time":1635528787,"event":"keepalive","topic":"mytopic"}
    </code>
    <p class="smallMarginBottom">
        Or use the <tt>/raw</tt> endpoint if you need something super simple (empty lines are keepalive messages):
    </p>
    <code>
        $ curl -s ntfy.sh/mytopic/raw<br/>
        <br/>
        This is a notification
    </code>

    <h3>Message buffering and polling</h3>
    <p class="smallMarginBottom">
        Messages are buffered in memory for a few hours to account for network interruptions of subscribers.
        You can read back what you missed by using the <tt>since=...</tt> query parameter. It takes either a
        duration (e.g. <tt>10m</tt> or <tt>30s</tt>) or a Unix timestamp (e.g. <tt>1635528757</tt>):
    </p>
    <code>
        $ curl -s "ntfy.sh/mytopic/json?since=10m"<br/>
        # Same output as above, but includes messages from up to 10 minutes ago
    </code>
    <p class="smallMarginBottom">
        You can also just poll for messages if you don't like the long-standing connection using the <tt>poll=1</tt>
        query parameter. The connection will end after all available messages have been read. This parameter has to be
        combined with <tt>since=</tt>.
    </p>
    <code>
        $ curl -s "ntfy.sh/mytopic/json?poll=1&since=10m"<br/>
        # Returns messages from up to 10 minutes ago and ends the connection
    </code>
    <h2>FAQ</h2>
    <p>
        <b>Isn't this like ...?</b><br/>
        Who knows. I didn't do a lot of research before making this. It was fun making it.
    </p>

    <p>
        <b>Can I use this in my app? Will it stay free?</b><br/>
        Yes. As long as you don't abuse it, it'll be available and free of charge. I do not plan on monetizing
        the service.
    </p>

    <p>
        <b>What are the uptime guarantees?</b><br/>
        Best effort.
    </p>

    <p>
        <b>Will you know what topics exist, can you spy on me?</b><br/>
        If you don't trust me or your messages are sensitive, run your own server. It's <a href="https://github.com/binwiederhier/ntfy">open source</a>.
        That said, the logs do not contain any topic names or other details about you. Check the code if you don't believe me.
    </p>

    <center id="ironicCenterTagDontFreakOut"><i>Made with ❤️ by <a href="https://heckel.io">Philipp C. Heckel</a></i></center>
</div>
<script src="static/js/app.js"></script>
</body>
</html>