Readme

New logo and header
Favicon
2021-11-23 22:00:32 -05:00 · 2021-11-23 20:22:09 -05:00 · 2021-11-23 12:02:16 -05:00 · 2021-11-22 16:09:54 -05:00 · 2021-11-22 10:53:03 -05:00 · 2021-11-22 10:46:19 -05:00
8 changed files with 125 additions and 67 deletions
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -13,7 +13,7 @@ builds:
    goos: [linux]
    goarch: [amd64]
  -
-    id: ntfy_arm67
+    id: ntfy_armv7
    binary: ntfy
    env:
      - CGO_ENABLED=1 # required for go-sqlite3
@@ -23,9 +23,7 @@ builds:
      - "-linkmode=external -extldflags=-static -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}}"
    goos: [linux]
    goarch: [arm]
-    goarm:
-      - 6
-      - 7
+    goarm: [7]
  -
    id: ntfy_arm64
    binary: ntfy
@@ -78,12 +76,35 @@ changelog:
      - '^docs:'
      - '^test:'
 dockers:
-  - dockerfile: Dockerfile
-    ids:
-      - ntfy
-    goos: linux
+  - image_templates:
+      - &amd64_image "binwiederhier/ntfy:{{ .Tag }}-amd64"
+    use: buildx
+    dockerfile: Dockerfile
    goarch: amd64
+    build_flag_templates:
+      - "--platform=linux/amd64"
+  - image_templates:
+      - &arm64v8_image "binwiederhier/ntfy:{{ .Tag }}-arm64v8"
+    use: buildx
+    dockerfile: Dockerfile
+    build_flag_templates:
+      - "--platform=linux/arm64/v8"
+  - image_templates:
+      - &armv7_image "binwiederhier/ntfy:{{ .Tag }}-armv7"
+    use: buildx
+    dockerfile: Dockerfile
+    goarch: arm
+    goarm: 7
+    build_flag_templates:
+      - "--platform=linux/arm/v7"
+docker_manifests:
+  - name_template: "binwiederhier/ntfy:latest"
    image_templates:
-      - "binwiederhier/ntfy:latest"
-      - "binwiederhier/ntfy:{{ .Tag }}"
-      - "binwiederhier/ntfy:v{{ .Major }}.{{ .Minor }}"
+      - *amd64_image
+      - *arm64v8_image
+      - *armv7_image
+  - name_template: "binwiederhier/ntfy:{{ .Tag }}"
+    image_templates:
+      - *amd64_image
+      - *arm64v8_image
+      - *armv7_image
--- a/README.md
+++ b/README.md
@@ -136,13 +136,13 @@ sudo apt install ntfy

 **Debian/Ubuntu** (*manual install*)**:**
 ```bash
-wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.6/ntfy_1.4.6_amd64.deb
-dpkg -i ntfy_1.4.6_amd64.deb
+wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.8/ntfy_1.4.8_amd64.deb
+dpkg -i ntfy_1.4.8_amd64.deb
 ```

 **Fedora/RHEL/CentOS:**
 ```bash
-rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.4.6/ntfy_1.4.6_amd64.rpm
+rpm -ivh https://github.com/binwiederhier/ntfy/releases/download/v1.4.8/ntfy_1.4.8_amd64.rpm
 ```

 **Docker:**
@@ -169,19 +169,16 @@ go get -u heckel.io/ntfy
 **Manual install:**
 ```bash
 # x86_64/amd64
-wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.6/ntfy_1.4.6_linux_x86_64.tar.gz
+wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.8/ntfy_1.4.8_linux_x86_64.tar.gz

-# ARMv6
-wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.6/ntfy_1.4.6_linux_armv6.tar.gz
+# armv7
+wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.8/ntfy_1.4.8_linux_armv7.tar.gz

-# ARMv7
-wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.6/ntfy_1.4.6_linux_armv7.tar.gz
-
-# arm64
-wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.6/ntfy_1.4.6_linux_arm64.tar.gz
+# arm64/v8
+wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.8/ntfy_1.4.8_linux_arm64.tar.gz

 # Extract and run
-sudo tar -C /usr/bin -zxf ntfy_1.4.6_linux_x86_64.tar.gz ntfy
+sudo tar -C /usr/bin -zxf ntfy_*.tar.gz ntfy
 ./ntfy
 ```

--- a/examples/web-example-eventsource/example-sse.html
+++ b/examples/web-example-eventsource/example-sse.html
--- a/server/index.gohtml
+++ b/server/index.gohtml
@@ -34,14 +34,14 @@
 {{end}}
 </head>
 <body>
+<div id="header"><div id="headerBox"><img src="static/img/ntfy.png" alt="ntfy"/></div></div>
 <div id="main"{{if .Topic}} style="display: none"{{end}}>
-    <h1><img src="static/img/ntfy.png" alt="ntfy"/><br/>ntfy.sh | simple HTTP-based pub-sub</h1>
+    <h1>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 notifications <a href="#subscribe-phone">to your phone</a> or desktop via scripts from any computer,
-        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.
+        <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 notifications to your phone or desktop via scripts from any computer,
+        entirely <b>without signup, cost or setup</b>. It's also <a href="https://github.com/binwiederhier/ntfy">open source</a> if you want to run your own.
    </p>
-
    <div id="screenshots">
        <a href="static/img/screenshot-curl.png"><img src="static/img/screenshot-curl.png"/></a>
        <a href="static/img/screenshot-web-detail.png"><img src="static/img/screenshot-web-detail.png"/></a>
@@ -51,11 +51,9 @@
            <a href="static/img/screenshot-phone-notification.jpg"><img src="static/img/screenshot-phone-notification.jpg"/></a>
        </span>
    </div>
-
    <p>
-        There are many ways to use Ntfy. You can send yourself messages for all sorts of things: When a long process finishes or fails,
-        or to notify yourself when somebody logs into your server(s). Or you may want to use it in your own app to distribute messages to subscribed clients.
-        Endless possibilities 😀. Be sure to check out the <a href="#examples">examples below</a>.
+        There are many ways to use it: Notify yourself when a build finishes, when an rsync is done or a backup fails,
+        or know when somebody logs into your server. There are <a href="#examples">many more examples</a>, endless possibilities 😀.
    </p>

    <h2 id="publish" class="anchor">Publishing messages</h2>
@@ -64,22 +62,22 @@
        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> (via POST):
+        Here's an example showing how to publish a message using a POST request (via <tt>curl -d</tt>):
    </p>
    <code>
-        curl -d "Backup successful 😀" ntfy.sh/mytopic
+        curl -d "Backup successful 😀" <span class="ntfyUrl">ntfy.sh</span>/mytopic
    </code>
    <p class="smallMarginBottom">
-        And another one using PUT:
+        And another one using PUT (via <tt>curl -T</tt>):
    </p>
    <code>
-        echo -en "\u26A0\uFE0F Unauthorized login" | curl -sT- ntfy.sh/mytopic
+        echo -en "\u26A0\uFE0F Unauthorized login" | curl -T- <span class="ntfyUrl">ntfy.sh</span>/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/>
+        fetch('https://<span class="ntfyUrl">ntfy.sh</span>/mytopic', {<br/>
        &nbsp;&nbsp;method: 'POST', // PUT works too<br/>
        &nbsp;&nbsp;body: 'Hello from the other side.'<br/>
        })
@@ -127,7 +125,7 @@
        notifications like this (see <a href="example.html">live example</a>):
    </p>
    <code>
-        const eventSource = new EventSource('https://ntfy.sh/mytopic/sse');<br/>
+        const eventSource = new EventSource('<span class="ntfyProtocol">https://</span><span class="ntfyUrl">ntfy.sh</span>/mytopic/sse');<br/>
        eventSource.onmessage = (e) => {<br/>
        &nbsp;&nbsp;// Do something with e.data<br/>
        };
@@ -136,7 +134,7 @@
        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/>
+        $ curl -s <span class="ntfyUrl">ntfy.sh</span>/mytopic/sse<br/>
        event: open<br/>
        data: {"id":"weSj9RtNkj","time":1635528898,"event":"open","topic":"mytopic"}<br/><br/>

@@ -149,7 +147,7 @@
        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/>
+        $ curl -s <span class="ntfyUrl">ntfy.sh</span>/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"}
@@ -158,7 +156,7 @@
        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/>
+        $ curl -s <span class="ntfyUrl">ntfy.sh</span>/mytopic/raw<br/>
        <br/>
        This is a notification<br/>
        And another one with a smiley face 😀
@@ -173,7 +171,7 @@
        cached messages).
    </p>
    <code>
-        curl -s "ntfy.sh/mytopic/json?since=10m"
+        curl -s "<span class="ntfyUrl">ntfy.sh</span>/mytopic/json?since=10m"
    </code>

    <h3 id="polling" class="anchor">Polling (<tt>poll=1</tt>)</h3>
@@ -183,7 +181,7 @@
        combined with <tt>since=</tt> (defaults to <tt>since=all</tt>).
    </p>
    <code>
-        curl -s "ntfy.sh/mytopic/json?poll=1"
+        curl -s "<span class="ntfyUrl">ntfy.sh</span>/mytopic/json?poll=1"
    </code>

    <h3 id="multiple-topics" class="anchor">Subscribing to multiple topics (<tt>topic1,topic2,...</tt>)</h3>
@@ -192,7 +190,7 @@
        comma-separated list of topics in the URL. This allows you to reduce the number of connections you have to maintain:
    </p>
    <code>
-        $ curl -s ntfy.sh/mytopic1,mytopic2/json<br/>
+        $ curl -s <span class="ntfyUrl">ntfy.sh</span>/mytopic1,mytopic2/json<br/>
        {"id":"0OkXIryH3H","time":1637182619,"event":"open","topic":"mytopic1,mytopic2,mytopic3"}<br/>
        {"id":"dzJJm7BCWs","time":1637182634,"event":"message","topic":"mytopic1","message":"for topic 1"}<br/>
        {"id":"Cm02DsxUHb","time":1637182643,"event":"message","topic":"mytopic2","message":"for topic 2"}
@@ -200,7 +198,7 @@

    <h2 id="examples" class="anchor">Examples</h2>
    <p>
-        There are a million ways to use Ntfy, but here are some inspirations. I try to collect
+        There are a million ways to use ntfy, but here are some inspirations. I try to collect
        <a href="https://github.com/binwiederhier/ntfy/tree/main/examples">examples on GitHub</a>, so be sure to check
        those out, too.
    </p>
@@ -214,13 +212,13 @@
    <code>
        rsync -a root@laptop /backups/laptop \<br/>
        &nbsp;&nbsp;&& zfs snapshot ... \<br/>
-        &nbsp;&nbsp;&& curl -d "Laptop backup succeeded" ntfy.sh/backups \<br/>
-        &nbsp;&nbsp;|| echo -en "\u26A0\uFE0F Laptop backup failed" | curl -sT- ntfy.sh/backups
+        &nbsp;&nbsp;&& curl -d "Laptop backup succeeded" <span class="ntfyUrl">ntfy.sh</span>/backups \<br/>
+        &nbsp;&nbsp;|| echo -en "\u26A0\uFE0F Laptop backup failed" | curl -sT- <span class="ntfyUrl">ntfy.sh</span>/backups
    </code>

    <h3 id="example-web" class="anchor">Example: Server-sent messages in your web app</h3>
    <p>
-        Just as you can <a href="#subscribe-web">subscribe to topics in this Web UI</a>, you can use Ntfy in your own
+        Just as you can <a href="#subscribe-web">subscribe to topics in this Web UI</a>, you can use ntfy in your own
        web application. Check out the <a href="example.html">live example</a> or just look the source of this page.
    </p>

@@ -242,7 +240,7 @@
    <code>
        #!/bin/bash<br/>
        if [ "${PAM_TYPE}" = "open_session" ]; then<br/>
-        &nbsp;&nbsp;echo -en "\u26A0\uFE0F SSH login: ${PAM_USER} from ${PAM_RHOST}" | curl -T- ntfy.sh/alerts<br/>
+        &nbsp;&nbsp;echo -en "\u26A0\uFE0F SSH login: ${PAM_USER} from ${PAM_RHOST}" | curl -T- <span class="ntfyUrl">ntfy.sh</span>/alerts<br/>
        fi
    </code>

@@ -254,7 +252,7 @@
    <code>
        while read result; do<br/>
        &nbsp;&nbsp;[ -n "$result" ] && echo "$result" >> results.csv<br/>
-        done < <(stdbuf -i0 -o0 curl -s ntfy.sh/results/raw)
+        done < <(stdbuf -i0 -o0 curl -s <span class="ntfyUrl">ntfy.sh</span>/results/raw)
    </code>

    <h2 id="faq" class="anchor">FAQ</h2>
@@ -302,9 +300,24 @@
        is to facilitate instant notifications on Android.
    </p>

+    <p>
+        <b id="battery-usage" class="anchor">How much battery does the Android app use?</b><br/>
+        If you use the ntfy.sh server and you don't use the <i>instant delivery</i> feature, the Android app uses no
+        additional battery, since Firebase Cloud Messaging (FCM) is used. If you use your own server, or you use
+        <i>instant delivery</i>, the app has to maintain a constant connection to the server, which consumes about 4% of
+        battery in 17h of use (on my phone). I use it and it makes no difference to me.
+    </p>
+
+    <p>
+        <b id="instant-delivery" class="anchor">What is instant delivery?</b><br/>
+        Instant delivery is a feature in the Android app. If turned on, the app maintains a constant connection to the
+        server and listens for incoming notifications. This consumes <a href="#battery-usage">additional battery</a>,
+        but delivers notifications instantly.
+    </p>
+
    <p>
        <b id="why-no-ios" class="anchor">Why is there no iOS app (yet)?</b><br/>
-        I don't have an iPhone or a Mac, so I didn't make an iOS app yet. I'd be awesome if
+        I don't have an iPhone or a Mac, so I didn't make an iOS app yet. It'd be awesome if
        <a href="https://github.com/binwiederhier/ntfy/issues/4">someone else could help out</a>.
    </p>

@@ -325,13 +338,13 @@
 <div id="detail"{{if not .Topic}} style="display: none"{{end}}>
    <div id="detailMain">
        <button id="detailCloseButton"><img src="static/img/close_black_24dp.svg"/></button>
-        <h1><img src="static/img/ntfy.png" alt="ntfy"/><br/><span id="detailTitle"></span></h1>
+        <h1><span id="detailTitle"></span></h1>
        <p class="smallMarginBottom">
-            <b>Ntfy</b> is a simple HTTP-based pub-sub notification service. This is a Ntfy topic.
+            <b>ntfy</b> is a simple HTTP-based pub-sub notification service. This is a ntfy topic.
            To send notifications to it, simply PUT or POST to the topic URL. Here's an example using <tt>curl</tt>:
        </p>
        <code>
-            curl -d "Backup failed" <span id="detailTopicUrl"></span>
+            curl -d "Backup failed" <span id="detailTopicUrl">ntfy.sh/topic</span>
        </code>
        <p id="detailNotificationsDisallowed">
            If you'd like to receive desktop notifications when new messages arrive on this topic, you have
--- a/server/static/css/app.css
+++ b/server/static/css/app.css
@@ -4,6 +4,8 @@ html, body {
    font-family: 'Lato', sans-serif;
    color: #333;
    font-size: 1.1em;
+    margin: 0;
+    padding: 0;
 }

 html {
@@ -25,6 +27,8 @@ h1 {
    margin-top: 25px;
    margin-bottom: 18px;
    font-size: 2.5em;
+    word-wrap: break-word; /* For very long topics */
+    padding-right: 40px; /* For the X on the detail page */
 }

 h2 {
@@ -84,6 +88,7 @@ code {
 #main {
    max-width: 900px;
    margin: 0 auto 50px auto;
+    padding: 0 10px;
 }

 #error {
@@ -190,6 +195,23 @@ code {
    background-color: #fff;
 }

+/* Header */
+
+#header {
+    background: #3a9784;
+    height: 130px;
+}
+
+#header #headerBox {
+    max-width: 900px;
+    margin: 0 auto;
+    padding: 0 10px;
+}
+
+#header img {
+    margin-top: 23px;
+}
+
 /* Subscribe box */

 button {
@@ -352,13 +374,6 @@ li {
 /** Detail view */
 #detail {
    display: none;
-    position: absolute;
-    z-index: 1;
-    left: 8px;
-    right: 8px;
-    top: 0;
-    bottom: 0;
-    background: white;
 }

 #detail .detailDate {
@@ -375,7 +390,7 @@ li {
    max-width: 900px;
    margin: 0 auto;
    position: relative; /* required for close button's "position: absolute" */
-    padding-bottom: 50px; /* Chrome and Firefox behave differently regarding bottom margin */
+    padding: 0 10px 50px 10px; /* Chrome and Firefox behave differently regarding bottom margin */
 }

 #detail #detailCloseButton {
@@ -384,7 +399,7 @@ li {
    border: none;
    padding: 5px;
    position: absolute;
-    right: 0;
+    right: 10px;
    top: 10px;
    display: block;
 }
--- a/server/static/img/favicon.png
+++ b/server/static/img/favicon.png
--- a/server/static/img/ntfy.png
+++ b/server/static/img/ntfy.png
--- a/server/static/js/app.js
+++ b/server/static/js/app.js
@@ -12,6 +12,10 @@
 let topics = {};
 let currentTopic = "";
 let currentTopicUnsubscribeOnClose = false;
+let currentUrl = window.location.hostname;
+if (window.location.port) {
+    currentUrl += ':' + window.location.port
+}

 /* Main view */
 const main = document.getElementById("main");
@@ -131,15 +135,15 @@ const fetchCachedMessages = async (topic) => {

 const showDetail = (topic) => {
    currentTopic = topic;
-    history.replaceState(topic, `ntfy.sh/${topic}`, `/${topic}`);
+    history.replaceState(topic, `${currentUrl}/${topic}`, `/${topic}`);
    window.scrollTo(0, 0);
    rerenderDetailView();
    return false;
 };

 const rerenderDetailView = () => {
-    detailTitle.innerHTML = `ntfy.sh/${currentTopic}`; // document.location.replaceAll(..)
-    detailTopicUrl.innerHTML = `ntfy.sh/${currentTopic}`;
+    detailTitle.innerHTML = `${currentUrl}/${currentTopic}`; // document.location.replaceAll(..)
+    detailTopicUrl.innerHTML = `${currentUrl}/${currentTopic}`;
    while (detailEventsList.firstChild) {
        detailEventsList.removeChild(detailEventsList.firstChild);
    }
@@ -177,7 +181,7 @@ const hideDetailView = () => {
    currentTopic = "";
    history.replaceState('', originalTitle, '/');
    detailView.style.display = 'none';
-    main.style.display = '';
+    main.style.display = 'block';
    return false;
 };

@@ -347,3 +351,11 @@ document.querySelectorAll('.anchor').forEach((el) => {
        el.appendChild(anchor);
    }
 });
+
+// Change ntfy.sh url and protocol to match self-hosted one
+document.querySelectorAll('.ntfyUrl').forEach((el) => {
+    el.innerHTML = currentUrl;
+});
+document.querySelectorAll('.ntfyProtocol').forEach((el) => {
+    el.innerHTML = window.location.protocol + "//";
+});
Author	SHA1	Message	Date
Philipp Heckel	7b8185c2a7	Readme	2021-11-23 22:00:32 -05:00
Philipp Heckel	71af1af001	New logo and header	2021-11-23 20:22:09 -05:00
Philipp Heckel	9af64bf3dd	Favicon	2021-11-23 12:02:16 -05:00
Philipp Heckel	093154fa6c	Only build armv7, not armv6 anymore	2021-11-22 16:09:54 -05:00
Philipp Heckel	c247984ca9	Merge branch 'main' of github.com:binwiederhier/ntfy into main	2021-11-22 10:53:03 -05:00
Philipp Heckel	2a05715107	Multi-platform Docker images	2021-11-22 10:46:19 -05:00
Philipp C. Heckel	cb69f18c39	Merge pull request #12 from nathanaelhoun/custom-url-selfhosted Use custom url for self-hosted	2021-11-22 08:42:56 -05:00
Nathanaël Houn	fde5fda635	Use custom url in case of self-hosted	2021-11-22 14:30:09 +01:00