From 4fcb3891a2d954b2c7525310d3e60ee4f3fdcbef Mon Sep 17 00:00:00 2001
From: Philipp Heckel
Date: Sun, 5 Dec 2021 07:31:05 -0500
Subject: [PATCH] More docs; omg why is this taking so long
---
docs/privacy.md | 2 +-
server/index.gohtml | 90 +++++++++----------
server/static/img/android-video-overview.mp4 | Bin 0 -> 1289875 bytes
server/static/img/badge-fdroid.png | Bin 0 -> 4524 bytes
server/static/img/screenshot-docs.png | Bin 0 -> 137474 bytes
5 files changed, 46 insertions(+), 46 deletions(-)
create mode 100644 server/static/img/android-video-overview.mp4
create mode 100644 server/static/img/badge-fdroid.png
create mode 100644 server/static/img/screenshot-docs.png
diff --git a/docs/privacy.md b/docs/privacy.md
index c13f35c1..b5f0aa51 100644
--- a/docs/privacy.md
+++ b/docs/privacy.md
@@ -1,6 +1,6 @@
# Privacy policy
-I love free software and I'm doing this because it's fun and to give back. I have no bad intentions and I will
+I love free software, and I'm doing this because it's fun. I have no bad intentions, and I will
never monetize or sell your information. This service will always stay free and open.
Neither the server nor the app record any personal information, or share any of the messages and topics with
diff --git a/server/index.gohtml b/server/index.gohtml
index b1a75dab..8d2c0226 100644
--- a/server/index.gohtml
+++ b/server/index.gohtml
@@ -80,8 +80,9 @@
curl -d "Backup successful 😀" ntfy.sh /mytopic
- There are more features related to publishing messages: You can set a
- notification priority , a title , and tag messages .
+ There are more features related to publishing messages: You can set a
+ notification priority , a title ,
+ and tag messages .
Here's an example using all of them:
@@ -99,6 +100,22 @@
in this web UI , or in your own app by subscribing via the API .
+ Subscribe from your phone
+
+ Simply get the app and start publishing messages . To learn more about the app,
+ check out the documentation .
+
+
+
+
+
+
+
+
+
+ Sending push notifications to your Android phone
+
+
Subscribe in this Web UI
@@ -118,59 +135,42 @@
- Subscribe from your phone
+ Subscribe using the API
- You can use the Ntfy Android App
- to receive notifications directly on your phone. Just like the server, this app is also open source .
- Since I don't have an iPhone or a Mac, I didn't make an iOS app yet. I'd be awesome if someone else could help out .
+ There's a super simple API that you can use to integrate your own app. You can consume
+ a JSON stream ,
+ an SSE/EventSource stream (useful for web apps),
+ as well as a plain text stream .
-
-
-
-
-
- Subscribe via your app, or via the CLI
- Using EventSource in JS, you can consume
- notifications like this (see live example ):
-
-
- const eventSource = new EventSource('https:// ntfy.sh /mytopic/sse');
- eventSource.onmessage = (e) => {
- // Do something with e.data
- };
-
-
- You can also use the same /sse endpoint via curl or any other HTTP library:
-
-
- $ curl -s ntfy.sh /mytopic/sse
- event: open
- data: {"id":"weSj9RtNkj","time":1635528898,"event":"open","topic":"mytopic"}
-
- data: {"id":"p0M5y6gcCY","time":1635528909,"event":"message","topic":"mytopic","message":"Hi!"}
-
- event: keepalive
- data: {"id":"VNxNIg5fpt","time":1635528928,"event":"keepalive","topic":"test"}
-
-
- To consume JSON instead, use the /json endpoint, which prints one message per line:
+ Here's an example for JSON. Note that the connection stays open , so you can retrieve messages as they come in:
$ curl -s ntfy.sh /mytopic/json
{"id":"SLiKI64DOt","time":1635528757,"event":"open","topic":"mytopic"}
{"id":"hwQ2YpKdmg","time":1635528741,"event":"message","topic":"mytopic","message":"Hi!"}
- {"id":"DGUDShMCsc","time":1635528787,"event":"keepalive","topic":"mytopic"}
+ {"id":"DGUDShMCsc","time":1635528787,"event":"keepalive","topic":"mytopic"}
+ ...
-
- Or use the /raw endpoint if you need something super simple (empty lines are keepalive messages):
+
+
+
+
+
+ More, more, more!
+
+ ntfy has so many more features and you can learn about all of them in the documentation
+ (I tried my very best to make it the best docs ever 😉, not sure if I succeeded, hehe).
+
+
+
+
+ Forever free, forever 100% free software
+
+ I love free software, and I'm doing this because it's fun. I have no bad intentions, and I will
+ never monetize or sell your information. This service will always stay free and open. You can
+ read more in the FAQs and in the privacy policy .
-
- $ curl -s ntfy.sh /mytopic/raw
-
- This is a notification
- And another one with a smiley face 😀
-
Made with ❤️ by Philipp C. Heckel
diff --git a/server/static/img/android-video-overview.mp4 b/server/static/img/android-video-overview.mp4
new file mode 100644
index 0000000000000000000000000000000000000000..cf295099ac2356ff42573b5654e79167039afc0b
GIT binary patch
literal 1289875
zcmX`S19W6f7bqHYV%xTD+crA3G2z6vZ6_1kb~3ST+qwDv`|ew-`HI7v%M`45D3tJ@1HNTk(&vVtph6)5D*ZQnG*m2gn|iWYii{3!&3_Z{{3CK
zA$Hnzv?|$>Lc2n^N^*7W!OYG|NJnU5?*t%ZVq+$BV&-IHB?NF8v2ii7{17DRe;63#
z6vZUySP6yHMSeI<0VY2L5qk$u8-SS$Au}T*3mr2f6UPtI!o|gbn}NaI-JRae(iC8C
zV`N8f?_|#KUoZ3)F19v5JoXMQmiBhe+=M1Z#zrQ5OoUDVGd>nVQ-HCJy@@p+6E`C_
zBcYLV&LFxZRzkI$NyE}=wM)PX66iV;iF?Fbg^*yk@!)>
zOlV_oZ*64p(=zyfNM=H38%vWPWBwn4klaZy}kBT2gC!_y(%$$sD0nR_sGB$AV{DCb^`IvuTBU2-X
z|J*P(Ft#*u{;v~DC&2$4a|c+OTeuki(Ci%mb_VA54nNfYi*)!AwFY?p=;mW)WBmU>
z16xbGpC+NR3BV3u;_AZ3%J`p|PDcO5)Cu5h@gweJV(|aF`ybuOgwMpujL_EjC$Rsy
z_0!;EW}#;!bo|d5K1O=>AJE}H#s7O7dGN7w{UDrO01kYtgq99JS^60fKS})2W#srX
z0RBrSkUtPmU^pNw2*~erECO*0w!AeefWwh#13TA*vuptk5q^D;{`$ca`}C8PPHUYm
zMGT=tA!n<2v-YVVVr!LAiPY{?M`64|Vg5NNbM?%f(3U@j!~}FKXKMH$+CeGkps8Vf
z^!B=!k1uea`ipC1)({Z`ZR5fUPp@@GO3PL{`37C@5-h#k0!W{e^oaWgzWviWs=kqW
zEgvk%!YgXm_!kQiT~$X^@}QFHcHE&Kcx?l^GxEA&W$Dc26SATo!-b4D$BqA^6oO1mbS
zEnAR*r>BbsOdthM^g~iVVB(?g6d08ma|0OzU^m%j**pifx~r2~7rl$?+c?cXnXsDH
z@%}wNuz=4Cj37n|m^z|#`4A0fn;p<=>kcF>&V6E?eZcGXxVQ$DQoIZzuwSBktqh93
ztjVHT2sN*QgAJRstAM1@U)DODy5H!ef
z#F_5v2_z>LPdU&d>|!wog1sdHIk{k)Aksf7u^A!rv>d4GR@*NvhNf7zBuhkN3}JPD8aItip5|PHl3qeVG^EhDEY=UN-KN_u
zIWf*~FP{32lC|URGT|wEe94~?5D>b?I*QAHDaxV(d}cl={s`QpR7W$=oxz$S4cY(Q
zU#>)^$|F8C<~z=#d+%C+gr{n)z?5=&v503)Fk&cP(Z(b
zf9T0)1(SKp&V@{B5#N5oBE0w6`a1J?-#31_^_2_r1cuo(AU7gaTxKVc{<^b^rx}X|
zhaG=*yPV_}2Xf7F0x!p9f#D0JKJ;lGdVl{yXM!{^?@i3bRD%*JgvWF6aEUEwXv?x1
z{_ku>aFmS62q}P{Uz&a&v5%ig;V*;YZ1>crqnpml1FB5Cf(pEW93?*<-|1D78-W*?
zY;T7H6z<{gv)%SGq_`NlU<+tuT*~3vlc|pmN>qRfvM0LMzQT!_2_Slu=c%FZpEbdq
zblXUBB{VPW01SwGfWE7x!lRZ%w?^728FuMV7;~yJy6d2`uaMgsvOGCB<87Sy5l%*R
z{uM#;txmSpS!|9VpyFZB2MPDwl*v8N2iIh7zd9YJ<-#63z$-}t2I5Y?xhg_MhGvmF
zg>zS`wx*co^NBj;NZEH-8IwQ8)kF@Eg0IBk6jg~N?Z&BFDg(Ry
z7ZXRy?t+3JA%Tt3^Ny$EjQF^r0V#RXkYj@nUohT~f7=^VLH7yA^tBZfZMPL5|42EA
zAF82$82O);K(=I&VatYY};0=Cdsp$h|f_GO~>l|=e3swzK^r~0H^`GfZ1f$hJ(8|
z$##&-)Imo)#i$FNZN`qd`vDXvHE7UkL5i_A6|23@W|~<@_9^WnS&Ts^%Cf5*W4{(B
z5fRK}d)}*~%7)b$0qOuQ@t_;qd1xYgA(2>VBv>`S7+k)-^g18=OUQZn_RelMqcOZlo?p{bXLF83uUBR_
z`E)s|LRJ^2eyfXAAB+06oMF+o8K2JHVeYn_Y
z-5pbiz@{5-;fWW^r6s-Q#YZ%-w?0#6Q7|;kxmUs^)2350BeQ|~Nwp5&e9g39-)ag^
zzQ=R(4hczrWN861XPgcQOy51YmPitxR0*HsCHziqi_2C|B^
zaq#~#rjf%~AB}V%wf02QbixHIM@D<9V6Gy3Ypgo+(BtY_(WaJ|sW=Uf#en6~P<+;M
z6Q7po=H
zE9=39wnv$5QqTRZseJ`q`=>d-92usH$nvI{?010xqo_ODE~8+g+!Z*+vHZg_
zx$vgCojcV4H*i%GeV_)eM5aY8&}L5xXDeqirUJ$EETyX?t$&fTaV_cVKj|Vb+Psws(>E2y&h1X&dSA*0kYJ
zW83&XEBsq3!F(T9Ug=FQ4?!X2ccpgX9iP+BBK@|FCXdlJ6ppe^f=h0L5rv4kzcVVp
zrV{%;GL1*|Y;aA|Wto5G_(dF_eE*tC@smQh7B2nU{{x(&neI3F(L`8~-Cwe+J;QCo
z)yI%Cx;?Nd3?(KCEg0dpcmg6$l8A#IO^?#aiT`9a8|XYk
zI3mn1FaLz43v$eqZ%y+KH6@pLIx`hFa)aQ(pIQM<0|FxVL)Bc;X*jF1Z=iT&^jB+w
z#!g|&b)60v^uO*}e&E(X2gGUnN$~2}vQsw<6I?$3wbNLG?#5N3u{_)rL`fEgO}__b
z1>U$b$|M_k*}S!&^juwL35NPqS7cu*`eZi~39ZdQFB5S008fRdUnja|ZIPgfH9O?x
zl3I0$Mz1kU+F)3i-jCjm5FYn)bUBkFilGom)kD&0g9DGEOt_N*YcfFzjl(%Yv$y!K
zyv07&t-0nR8LH-otOcv@*(W8ckOx;ld8dSCK1aW!SYlGQN`HrqtbgA6FP|wJ{&jvQ
zc(@p0s=v4&MAR;#W1}V6o)q|uC#t&VWE-h@FVBKZ>SlEP@>Up^#H|;sdw?lmc#P%c
zNkVaU%ot(8TDsGllWZ^HAhSI3MPcezAd87uSAJ%3q96N<|6;7GAryn3^0F?&zB_kv
z!;BcBn6HxW8Y+|Qa-6;H>1oT%W-Yez-Fp0o;Q3yjQ_+8xd-)~y0csDqJp1qR8GyYk
zdMaS28>({#nGtAKC7gqVNUF?~0=RO>4|FyCt;z%48IsGyBI}8Pj=t)lLPt#1jzT)D
z>dU{!-;C!GprTImv)%gNq(>AkeBR4tO~OSXA88ZkHF{61JNKa!wyQ
z^#W6J(R7Fj7lq$F;EM|CBRR^qU(DH}{qq#|hb@_s&76q6GR;A;NnMY^2hvho(K}2m
z7DTc8N+3DJo9l6N#0lMy^AO$C*$36=wG;K&WXiwdc^P3}Yr2>QNR}+$9h|Vikn?|T
zLn}Cg!tljAD*+tz^_XfvDZeqOtmzwv?vp3c%v3OZN9FLTUDiCA8IC{4esxdCNo>eU*a3!E45iuIoc(31!*}VB{Q>@2<
z$>eYQrZ1GRP$-n3pv7)e*%5(o=FsoIvZd?u__L6<`Wh6E&0a@CSk*~o6AjCLpo+KCe)
zRCUyYX|q{&HPJU9nSQI#4TAk8T~P8)**Gu9wOYU_avQhnBC*0awg`^y%=qb&KuUs$
zv!6M#>xdIbA{V%DJi)H1dtZCD%)=+pT`y6aaDqfV8V9(L
zn7WX-+wFonm}UKoSb42qPvo`MuQ<<{^-xikW3ClY(Z?8X7go*hv@;$|+VgB1t+jah
zTbb(6Il+m1Qb(5gn@pY`K0PGss`mLYRztG}0yAtAX&|kdViSB=dHjYNo
zrv%a4tdp5aEE>GL_KEjBnycLPgtzh#1J^7-Sf3=Ixh44)2B4hOxOl<7ErzgQ6H<{@
zMM?IWhD(^GP<`#ZR8VRCZW_>2c2NSq#!H@9u|=e
z3i)+?=?vU_zT~FjE#5Q_+dYx$pY+JIpO>D$7NhW#77U#&o*ZIU^pqpxv4}dk7Jl;I!k3U|!F?{2|r#YXp>u-oOX`H;}j4E4YYbMs%>c#3POiDBPwd;BZy
z56;K;-go*q@vSC6xuR6D83cnReBI%Nz7E+j-R^`me+sY+$$Bf|`V
z=9S^Ou!xbnzz(7(-0YSB!>S}{>lpW0%-_U)kW8+!-sC5Hfti8#`>FlDK)FRkd_X+*
z8rE;6%7cP5d%2;=?6e&i2^au+|KbGiWuAWBnrf0t9V7zH0TwYlaKDu
zBxhxQR~=lqYTgA+t$In>%z_O@u$4b2L%XWVCl)s1=jW|^hbWB|j6wBr_>NTqCWSfR
z>w0=jW0!f7ktH=4-<-*4_K3!c>Vm{gQmXEWU2?LSOQSP@J;YTdtDHpt*RcllVU0Hj
zHtTV|08iDBoC;<7oi}fx^j<(@y7-fM8ovuH5EzTB(8(t;-Me7!4V2!f`4zDyQ?&Gu
zl#%&<`V0M)y&+>SS7A&96FJvTCk*T8?G22ED2z=`FfxSXM<=B<#37+fe@&!Q;FZPL
z<@T-?@it+G1~B`p!eA*pXvsQ%L17D)Nu-M8g)K$C8L-Z|Dsh0LdMc>E;YL+tl
zV?RNV7~6S`BW2_O$ke}XG*iFTrXuCX$LCixQ579N@1al9t0VGo$mIZl#rbOiIe}TX
z00A9QijDE!ftXS8wzn*Ikz&LvsL
zvw_qv)Uwnmw~D&3NpbET+|;;)W|M&f4~UHmy{F#kYop8q>)Ube0#f)mGw}Yk?F@u`0
zu`n@SF<8g787bm(vq=sTu!=U=
zM`#t9zp6|g=6adQpvd`-O;MubPs%yuY{mUn@8*f(f{qA7eag6nAKdorOM@G+oaz
zh2jTaV)zzlU3bw5<-Uge$Kk7Glo%~-f~W^us5kX~_5xN4Ay>gYk+m^R?*XObtl)J#
zJ2pn)A?_`(=Zv
zu7bU?1;%=Cw%=@6=!yf0Uy+be-U4lYbzP-k=z0DM&~GFaeX<$5IiQHSuv{eDEDsuB
z#ti``4OvvV$JJFu=XbxiY`@ns#g20TkEry$gZxiHRosjgkT#?AObLm%d+QFvyxW3}
z-P)1=&U3$g)Of?0Q?>m%TfKD0R!4L_E9Q
zN(8{-TQY2Tb(xJ{N)V`HGGM1
z@ja_p@?vmP#;xLil_tx@c^pWlHSQad&Xe#=A)G&3PKUIzT^5Am_vR??Iu~H|i<4(gP4@VD9q4nhmSl4da21X+pRsvEmK0X^X
zAK1C~>ZM?@=p4KXQ_vFMf&^Y03Go3du0O{kWx})#Z9@^mlo5Yo&5qi2A8?bSJ>s~K
z!D?(ULYpQ@*!94!ROz`XsBl%=fBF-f5bHrSBXOj!>iBWDTBMBlk$(u>g!Wym%F-)?
z7dQG>G8{A;O|aNu9e${ps=GUO7|S*~#C7O5p;B-d2&2O%+%9gveE<3l)NqVO
z8h=I&EV>MCC&}rF)ye7gXi2{0WO30zyxyTg!TQ2_#*((?xQNf!epUMpH8rvK!LAi$JX&H_`yv8g3-;VEqZ>l4_i@dCI@u~__kGzsaNa?QlVl!V5k1=
zX^=bSfviPV7)i3IH62U{Hwrz0|4ZPwu)v8MW7~j9ER1|kwEq<4U@=a2G-S#h@}i{O
zI_pf^J670B5XUhzgA6Ge!LnNg8Pfdk=Ma?IqS$Rr^8%t8%qKWdQwpCX@K0`2dpxe~
z>R6Q|g;|G$y^0zhC(#?UF-Rf=sa5(oSu?tpz%;EOYd|Ny58rZPN!Za?r&N1PzRq_f
zJ80yj|4o(}{9)PGUKd^?qQRwSGRe+09z=l8nI=I>c^q5vB=G8}K02Ee)jooBtGR)ynAZ9o039s$apsxfnQ{qV~tKI?@OkBnQ^
z#(vIISBZE(>dv7nHMJ%w%`(|
zq)fLgu5wSQmS%h#S_Xavnufh%aK|)T%`HF{vpaPVYo7VGkzs$iXqwG-TF-Swgot@C
z8KQe@eC^R&Ll_N|i~j|h%0orQ-XqzOwX(JsyTo~bY>*s|nM*G;<((d~8vRpQ-tKSA
zm9H?;lFrRC{nML@3|%^aZkl^5psD!TiDoyqLiHSS{S5?!#BLUonjt|M
zz7)kC{B#=|@&FJq?DUpO4XI$yrtmXrV8N%hy7|Ayrr|>$
z`gu*KLmukyNB*`gubzaNhL6y~^?#iRTwyFg>4*(*I=vs{L!fbA=6^HPJKu=k$Kt#K
zX)_MR-jP-r>TLGZ-@Q}vw$7TLBMJVaGU*jq@i`hlMMzaT8R&JzPw@`#kgkrVP&3iH
z`NXPTk9vZhobI@j@~eCUuf$9j##fgmXqg)LtQ5+Cr>0GPpd0-uTM+b{TYNvH?0n*?
zBrh+}?CVe|s6SlvFB=H07JDzQMrn%Dy~xY-kv`mnTWNHDoGU9+OfEPQ0nLiLhvH={
zqvF>rM`*bUrJG!j@YVbor8`()#@6NFR4bf%Zzmr6Pi3#Pw~dqr5MA@|yTd@UZ&+sv
z<%RH-S^R<1Ut4txIq>I*@X*pN*H;CjzSP#i}CPuv9NOmhSDPQ?u^CLNJ>
zpc}o8>_c)9evo;h0!Yr9pNgAk}R`1smmSOwo^7SU6@53JdQr$=_ot?wU_!!wUj4?L(L9u&kI#s|LQj&$N
zs)>@Ut%ig1lUsm+?jGdQ66R|mRcXp`{$3KZW1%`of7wbCPCeW2{8~iH&TOKA{Smll=-km4Lz+
zb;N8ql(8cM+UZ2wWbs{%|Ep*W+W0Qic1$4*K=-Ie8P@Ev05tb)7%cGBAuodzBCh3h&)*Aoq_Lcn_|s07+@Rtb}CL
zywk^9i`M>8O@Rq~N9CYkfdf