From 1061aa789732b988a70094eefe18e970855f3579 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 20:35:39 +0200 Subject: [PATCH 1/9] Move installation.md into a setup/ directory A global 'setup/' directory will contain all about installation/setup --- docs/{ => setup}/installation.md | 0 docs/{ => setup}/setting-up-cachet.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/{ => setup}/installation.md (100%) rename docs/{ => setup}/setting-up-cachet.md (100%) diff --git a/docs/installation.md b/docs/setup/installation.md similarity index 100% rename from docs/installation.md rename to docs/setup/installation.md diff --git a/docs/setting-up-cachet.md b/docs/setup/setting-up-cachet.md similarity index 100% rename from docs/setting-up-cachet.md rename to docs/setup/setting-up-cachet.md From ae272e3707d0807f5abf49f7dd73543760c03667 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 20:41:14 +0200 Subject: [PATCH 2/9] Create the prerequisites documentation The prerequisites.md file documentation is based on the online version: https://docs.cachethq.io/docs/prerequisites --- docs/setup/prerequisites.md | 40 +++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/setup/prerequisites.md diff --git a/docs/setup/prerequisites.md b/docs/setup/prerequisites.md new file mode 100644 index 00000000..899883a4 --- /dev/null +++ b/docs/setup/prerequisites.md @@ -0,0 +1,40 @@ +# Prerequisites + +To start using Cachet, you'll need some prerequisites. + +## Application Prerequisites + +You'll need at least the following installed on your server: + +- PHP 5.5.9, you'll also need `ext-gd`, `ext-simplexml`, `mcrypt`, + `ext-xml`, `ext-mbstring` and `ext-tokenizer` installed. +- [Composer][1] +- APCu or Redis for caching. +- A database driver for your DB, such as MySQL, PostgreSQL or SQLite. +- Git + +> **SQLite** +> Whilst we support SQLite, we advise not using it for status pages +> with a high amount of traffic. + +> **MySQL Timezone Info** +> Ensure your MySQL database has been updated with the correct timezone +> information. This will ensure that metrics are shown +> correctly: [https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html][2] + +## Developer prerequisites + +If you are looking to contribute to Cachet, thank you! Your help is really +appreciated! You may need some extra dependencies; depending on what you're looking for. + +Our CSS is compiled from SCSS, so to compile this you will need the following: + +- Node.js +- NPM +- Bower +- Gulp + + + +[1]: https://getcomposer.org/ +[2]: https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html From 9fef9b227c69af45f672f098a1a31db46c16c322 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 21:02:45 +0200 Subject: [PATCH 3/9] Create CORS documentation The cors.md file is based on the online version at: https://docs.cachethq.io/docs/cors --- docs/setup/cors.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/setup/cors.md diff --git a/docs/setup/cors.md b/docs/setup/cors.md new file mode 100644 index 00000000..53357934 --- /dev/null +++ b/docs/setup/cors.md @@ -0,0 +1,17 @@ +# CORS + +Cross-original resource sharing + +> **External Access** +> By default Cachet can be accessed by any third-party server. + +You may configure your Cachet installation for CORS very easily. To blacklist everybody except one or more domains: + +- Login to your Dashboard +- Go to the Settings panel +- Click on Security +- You'll see a Allowed domains textarea, fill in any domains that you + want to access the API as a comma separated list: + +> _Text_ +> https://demo.cachethq.io,https://status.cachethq.io From dc2cd30706d944161ac6f252dc07df0da845f2b5 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 21:28:11 +0200 Subject: [PATCH 4/9] Create configuring-queue documentation The configuring-queue.md documentation is based on the online version at: https://docs.cachethq.io/docs/configuring-the-queue --- docs/setup/configuring-queue.md | 72 +++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 docs/setup/configuring-queue.md diff --git a/docs/setup/configuring-queue.md b/docs/setup/configuring-queue.md new file mode 100644 index 00000000..2fe7d2f9 --- /dev/null +++ b/docs/setup/configuring-queue.md @@ -0,0 +1,72 @@ +# Configuring the queue + +Cachet uses a queue to send Configuring Mail and Beacons without slowing down +the rest of the application. This can be setup in a variety of ways. + +## Supervisor + +The recommended setup for the queue is to use Supervisor. + +Supervisor is a process manager which makes managing a number of +long-running programs a trivial task by providing a consistent interface +through which they can be monitored and controlled. + +## Installations up to Cachet v2.3 + +`cachet.conf` + +``` +[program:cachet-queue] +command=php artisan queue:work --daemon --delay=2 --sleep=1 --tries=3 +directory=/var/www/cachet/ +redirect\_stderr=true +autostart=true +autorestart=true +user=cachet +``` + +## Installations from Cachet v2.4-dev onwards + +`cachet.conf` + +``` +[program:cachet-queue] +command=php artisan queue:work --delay=1 --sleep=1 --timeout=1800 --tries=3 +directory=/var/www/cachet/ +redirect\_stderr=true +autostart=true +autorestart=true +user=cachet +``` + +> **Update to your configuration!** +> Be sure to update the values in the example configuration above to match +> your installation setup. + +## Database Queue with Cron + +The default installation of Cachet sets the queue type to database which means +that all jobs are stored within your database and is then processed by a cron +job which calls an artisan command from within the project directory. + +You'll need to create a new cron job, in Ubuntu it's a case of running +crontab -e and adding this line: + +`* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1` + +Close the file and the cron job will now begin running, processing any +confirmation and incident emails. + +## Synchronous Queue (not recommended for larger installs) + +If you cannot add a queue job, another alternative is to process all of +the jobs immediately after they are created. + +> **Not suitable for larger installations!** +> This setup is not ideal for larger installs with hundreds of subscribers +> as each email can take a few seconds to send and would slow down your +> interaction with the system. + +To set this up change the .env file with the following setting: + +`QUEUE_DRIVER=sync` From 925e2d14a2821b2e581503bd3d7c534ff9693326 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 21:44:21 +0200 Subject: [PATCH 5/9] Create configuring mail documentation The configuration mail documentation is based on the online version at: https://docs.cachethq.io/docs/configuring-mail --- docs/setup/configuring-mail.md | 66 ++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 docs/setup/configuring-mail.md diff --git a/docs/setup/configuring-mail.md b/docs/setup/configuring-mail.md new file mode 100644 index 00000000..63d73498 --- /dev/null +++ b/docs/setup/configuring-mail.md @@ -0,0 +1,66 @@ +# Configuring Mail + +Your `.env` file will need to include the following setting keys. + +``` +MAIL_DRIVER=smtp +MAIL_HOST=mailtrap.io +MAIL_PORT=587 +MAIL_USERNAME=null +MAIL_PASSWORD=null +MAIL_ADDRESS=null +MAIL_NAME=null +MAIL_ENCRYPTION=tls +``` + +After making changes to your mail configuration you'll need to run the +following command within your Cachet installation directory. + +```bash +$ php artisan config:cache + +# If you experience any issues after running this command, run this too: +$ rm -rf bootstrap/cache/* +``` + +## Cachet + Mailgun + +Create an account with [Mailgun][1]. + +MAIL\_USERNAME should be Mailgun domain. +MAIL\_PASSWORD should be Mailgun API Key. + +Edit your `.env` file with the following variables. + +``` +MAIL_DRIVER=mailgun +MAIL_HOST=smtp.mailgun.org +MAIL_PORT=587 +MAIL_USERNAME=alt-three.com +MAIL_PASSWORD=xxxx +MAIL_ADDRESS=support@alt-three.com +MAIL_NAME="Alt Three Services Limited" +MAIL_ENCRYPTION=tls +``` + +The tls encryption setting is required to have e-mails be properly delivered. + +## Cachet + Spark Post + +Create an account with [Spark Post][2]. + +Edit your `.env` file with the following variables. + +``` +MAIL_DRIVER=smtp +MAIL_HOST=smtp.sparkpostmail.com +MAIL_PORT=587 +MAIL_USERNAME=SMTP_Injection +MAIL_PASSWORD=API_TOKEN +MAIL_ADDRESS=support@alt-three.com +MAIL_NAME="Alt Three Services Limited" +MAIL_ENCRYPTION=tls +``` + +[1]: https://mailgun.com/ +[2]: https://www.sparkpost.com/ From 14fec3f8876626c5191ff9e968c5cbcd6a90cff0 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 21:47:33 +0200 Subject: [PATCH 6/9] Create the configuring-subscribers documentation The configuring-subscribers.md documentation file is based on the online version at: https://docs.cachethq.io/docs/setup-subscribers --- docs/images/setup/enable-subscribers.png | Bin 0 -> 12670 bytes docs/setup/configuring-subscribers.md | 24 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 docs/images/setup/enable-subscribers.png create mode 100644 docs/setup/configuring-subscribers.md diff --git a/docs/images/setup/enable-subscribers.png b/docs/images/setup/enable-subscribers.png new file mode 100644 index 0000000000000000000000000000000000000000..c088c39b633f782ed13a3758a172b4d0b29fcec1 GIT binary patch literal 12670 zcmeHtWmH_twl0>SL4&&lhem>Hf(H)-m*B3AG}3r*Cpd%z4epJ*dvJ%~E{$8mW1oHQ zIp^+u$NT@ryFF_3sI^wjIjiRUX02NFRhWvB%quh!G&nf8S8}qFAK~B-`=9G7C@-J? zdt&q|;o#6ptt2E=?+0@9G zM}RL%g_e^vVSOKfM(>%H`nEk9=C#WYuOq;H`JT}}w4R^ijT;5ji{mGSLwfZ+A)PI4 z6YVRpam~B0F$&ISZ|jtuJKwHmrs3gihn-QuA)$rPD!uf3fFG%Lt{<=@M?*9NQY%wQ z&ZCd2#vmN3rw4dA(1<)U1& zjG{qT2Jd)gM!B}FjEfQ)YF`Ps7Jbvo zS+f%H*qiuBVIAiDUp6SYbQvTeqV4FQK=F&u{@9%!4r|Gr@GdHQVa@J^xAHrf{zE?wzup>VqV!b|ZXqQ=Z{ zbKpxBc$EwI?_hLIn$grzBYI^mafCBJcy+&*zu<%0UmuMU@Wb=fnD}C2(1^2Yq1F3g zP52XS2H<~YV|H_ZpuIBH@_vkMf(d!Vm;)#c9Bye*$z0+E9rJ3q7W(+ zELCd3Tm-B4p0TK=sPhu+v3##lzPzhc5&nvSN{w2Bpo5(F-c0394P{Y?kH3-x;rC({ ztPAY@z~JxhzX*x^nK%$NLN3>CD?|=4k=t=jarucygV2A|fbjI-XWM0do8KUKleZ$v zug#t^B4BfMO4eYjbyGkk1LFAUP;qFBV{voI3g3~$@#dm81j@!4ZF0X1`C+0(q!x+S zi-i}qX3WJ|%t6YTm?EgaosS1Zo(v)G@b3FqX|07r*L~E>v$o(QQtz|GND-sik^Vaq+5y58B{hs({UR11 z7Sk3*+3rgdi<*WcAAm(2O-1(_cMvrMbqA#m6@a=SNunCFD~myY7JAz~(jC~%yRNtn z=ai8v&P64VKqJePTbqmak#-Mv4|Pu@Rbhr+C{|(s;f%!j#Vye-T0_i3YPKwAKIkKX z8r@gLuM%I~1|s|(YAUQR_!SxhNAy9jU#K**HsYxNTKs+a5<_|7Cf zL_FMY^UhwJZJjY}It*e>hQ0--F+@q|N)=~k=3h=o95WksO&iM8<+{FElCiExtJFzZaIQtP=9`k9 z=9vOdOYJvJ0gA9}ICz%cetZkD$(SUX$hB#-M0;Cj^KI6<=c92$^@J9FiPB7HQd&}0 zlB7+WM%_$3#NRE~?T1^!l^S_`bc<5_s9PpxCXT-1@|Q*y7g86>J)FzK%NtLj%f<`Q zebQZ-gYsF2amu$Uyq`&56TKx8=FBB&BrzwMAzI<-B%UYDBRS%2G{YcWBsz~Oj&w+C zr-#rZBrMa5oL8KaZKLi?4WI`9z2xYu8!CZ zPYz?Hi9u9qPU{$JEUQ5lR<;ARB~{HfQnhE5I(F06mop39g5#bsmx!c|Bk$8MdC7TK zZI5hwAW;wrw?;Rp+q7HD6~;aGebkjESp_BqW-<9FzqebB>#&>f@l8QOp<2t%yR(uRV1N+;h9qhsnT z{w?VE)_M+^ik<9`JVnBY*=QIVZNZlqIdeFRcf2o4diO7uj4VeTv9C4AL6CFlquX{r$3y>w6!o>)f?^q1T3ML9N4SpaA zM}LJ{iU!6p$AQq4uw+oQvOYN8Xa&i1Z-@591;@qrM>F33>`}c`rOau`9?H(+JU7wk z)r?rho(NO)`d2>5FK zX8QTMSrIBfpMJ*4!+)u=FRA0Aqb5i#A_}WfQB7e!9RAhcKeUUJ8X7J&q0l!>o=W?i z*>(h9Yw3!4(*4siNpU3xu;N?Ek~4}jlp9nV7|vdw1$pqDMV<3)wy~Zv-FOI?3%Gmq zp_Ss>XkL`M7&iFg*DxD>>a)(AmMTV`xhX5umDfpcysCSD-dWX&b&x$E+w~z<5*X6*wKNPuiM%`k^c_EjcOKXSshFbi@#m#q5(d_qC?b ztNLhLMAuO_NcY&mby-IlzjD0jwRH9N_|vLxH6oXjK0OEiQxjrZ8W zm^YCEv5&6L0EYWC1lxe`6H=PXvJ@_Kuey5;Q)*Azmp6{k z)z^<2u-?;=0kP%BW=>pgu2YQ%xAo=TYvvOyaK+;riU-b!EP0?RV-CDD+SxBJA;YE?>juh8~D>>Y`7^cxZOH9ssTl>O{RB~ ztv=!HzUx+$B5$S|rXYyewJ-ft-WI9O$OHyUhmykK*uz1p;(NrtCYqWF=tnFC=p>wl zgn4RiEp<0GZZP))-`=)=LQ9XVRy0_5 z2?qzCVWqC+qNS)HXyRbUZe;3UY{m|UEpMwAK;GcrRfIs^GALIGcS^v2E z>@86=VZgsUFN)^G_}Lu}j&4&<@|`*e{wNdKTfK)MM0uAy_XCb9yj1r}h4IM?RxBZ5 z@SNAl&#{%Bm8?1ZO2Wfehgwz>x$f^#;om#2dgEElm!z9k$5pUDo!`G{@;X>L8C^+z z60k4_(pb>r!Q){6rTFt?h}ZHw+_~P;P$B%a{6>|fDy9kbL-|{wrSdPa{<{DbLbM-J zRgwSS1yJ}AaQlm1{?)>>ir*;DMo9i<;aSE18u@?8UE;4){|YX69IaX;v>XJ|*3Y4@ z(yzl62Phk?l_4)FTJ)FMXIiWPi`mc>4Uq!#1thxIN$CP|DRCsp|14BI2omNZ)@sSo zkZ+{`j_!=ZlQ({oYs=bL^M_^$wrv^(`C!L9t%4{eq42+;RNNY=bp+fMwt@a8TCMBT zTB)O8JK<;|C+gM>**5LgBgu#^AUBokrX=$uS3p7 z-zOM&egmDyZ1DB{??9{)rxeuB!Hp)WWHj=(PV{@gw0He_95^gT`qxs{$g*^ZiuZe61)=; z9v-2;qY+78S@ZTIz6x7a4*uRqjjAqlR>EE9zwLvFjuX%Xz7TWr%c6hT9 zQy!20Af$A*U{gL1S+u_=^cS|7VfEUG;(H|U*L#h>AXH6JVRUX#>E_B?bNhnZR(l-x zV0znlv1a@@u@OV^`g!G?#}>PqdHdb2Wd?qxc}8$6X=BCfq}I^qw#R|b>&mv+u&s5v zSaZy`_2F!&MOKoo)aq*4eN{V0I*Lo0N=DW6;nS2O8tlOEsmgVRsSF*sGg^Cfv`D&o zUJ6+lq&&VqX{#f(ukWZIdmaMEu~)f4%VEu=Qgu%R;o`hS)=`~qrSX@M41vi72-~BG zIGF{Y?ZH_pBKPP|*m0$_V~IWdUc^`kG}TzSGrcbfHxqk$sCKAE*?dTd`mP>D!h=x& zvT0A| z*d5q^U2}#SFcs*CvJDe+SuCD51}dTimhiP2p9BU4n|A2*Fr_&zwbVK_DSQFwvg z4F{m&(a(*`P}&I{)g-iC^Jj2m4N!ab7mfglLbiHI z9c*iGIvVunCzf0$72PJ}80Md2nR%hIRjS-L$*jfyxgE~1mo}Q;7@tf8CK2y?{YwI? z2UDfV&F)~XG6%LJ_EdQ}qYHpMOe%|A5_@(9zdG*-TXtI<@w`4h%AB(eV)Qv~*oi#y zxj*7tbnJR%cfIU>eFUVB*m{KBF9y6oKO7Z0iPUFt*!9Ksrjln%7&6TMm3YJ9HBU#% z>l+)Tb@PRdJ;NgNz+op)lay~sATI|O2 zQ0soI=P0=<7u#&LagP+~eHke>4x(hOqPg$R%-UGt&o2<_JJL|887^=2(xW6C`DQ<+ zxOdXyImfU(yVezw{J9-=_i#QY($<9~wp38EA^A?P>*RJPD<-q3EX)?ds;6JL{ei8M0yH>PCvI5(cHhGKnGk#3mxzF*oVpjw5zcBEaVqcQIYk3x8I4&Fe zbN(-mgR>jvU9>gPGz8Z=Bzs=$t}U7_tlq4>Ev^i;c_=(TJBxhewiEP4G2!BN5{&Kn z64&6`@q$omwoL!%3!y=U&~bg2g=MDaej&tG+sXI1tm*jdfQaDc8G|>i6A^$`%eqw` zuU@WvhqtEv*g1wbeU!dm85zJ)+@t(m5j(gnRi}tJ8!}J)i`#%KqrMVgrv5Le$AOB2 znwRy&8(!XWEoHNHGs^j^4+l-hX2&ofPpuHMyx3~~Mr|Yb~J5R6V*`P&I zLb!zB_DS2*F<`xVO!Pd{5sBbxgl|3pr;F_hQRo^G@#>sPF>x#=72SeRPQn~w1k`F0WIgkV>%79}cvn$|heLzwATPtJ5 zbY3>zVp?JPRlQujVrL3>PxAs zfu({>KJyYoKHC+ltZyyuLkXqIUJQ3h%G@7w0-4;CEcOb3KZ*M+4YcW z@vZV1N;A(95Z>^oK(f`oCVn?Cw_}k7o?&l3eeZR*S737ALzr~#q)d#c2o`slOhGac zv1)z$mLbc#svMY$bbUBKnHuA;&7EiFUSQ_EB$Tcy-nl^NJ-QiYZlniVa|FpcwD(pnE`K@FU9|cYu;K#JIJ$c++j~=je%G4^azpPZ19PTdGk0_z*=ueB~toGvjmXg1!)$b zSJmkUj1E#|VyhOwZ0}NR=$nbq{N<)5j;@v#4#)AS-Z=Ax-chU{m<6#hxloL|5Vy049@dxjf%K5>XtUI2x`ipQoyYB3< zQrFDrR<4s@hmHp`KSNe`DtMFY2U<0x8G+74^Q~;kl{(Y=cZ{y-f|+&~>qZc%4e;TC zNBM$1TXfy!zTNiq8*5lcNuTYGc}uDNWiUHVPUCc;#+Y?e+b5&vH+YFMyfG_FVPh_z z>+Y|Pr;e}E$&9AY$$&G`;s-2H%KY#)0BUBA%Sgu5@iQa?ukQm#5a)Y>oam3Mn4&kI zpHiXck{&oIBk6qCL!E7BgW||Y(C{^k-zhE#pcG&fze);!#MuVu2d(pzs!ZO62#VQn zAqgZn+S>4o2K5q}`*BWGat0En3^kO;&yhUl!dyyd6Ad#uHf&GJ+g@+}iG5oH)0gA) zxP^2o{=ftXb^#Z$M2$8|@pF23{E!Ms=Zy+uw5s+vPG}r*Z2WvtYH1_4+AE+y8TQka zqkHjrYCBxS{1_y6x$T`nYQcWQwUZ~(%OoGp+2zI0uv1`1Kk?xTw=+Z(NmV`aJ8FQ_ z#qRhDPCHi>BJpFNH%W~llGXcQngi}-?BU$@5IG0b)>x;I1S$*@o2B|ntd$@eBhm~~ zQ`z7Fo+kGb`vR?xk_ddMvvCm7tTR6mP3XymE zy*CPmk)i~y$TFg;mUF6ng=$mK2?Xj#s^T@nAsupW%7>5_C-qdbPz~4^wC`dzP!R}z zu2P<)(%XQiyZVVRwM5+txRng6|4x4_R3nLcBC1ZnHLyo{+roMnG3^AX&!0w^@S zT^c}No3&W7+NuAMH4U`B`M%JFH|C;xXa)H}>UKN7WYO}tJNc-AX;ZG;Hn}jp+;0olF1#`;IpI zwA5Nxj>_B?^0g8w6+dYwqL_9wBlv}|BYYVgLJSMhzo7|1U$Lzod2kjz&+9=CYTu&v ztEc)XWhTwK_G!I7w~U4^U`;O4_g9Z{eS30t$q|$}PKP`)#MXO9j1{XKg{0ewV~~=b zBpd!W{0JfOyRj~&c{+Sa%gQi$pQ=}+Umw34SKJc<4ILL@hrL*va}(LZi$AO?L1V5I zgcEE5)Iov2&9w2{F_T`{s8=_zxdv`=e*C$b=Hw6-$~`1kU8Y^i>!4ZK!9jGLI#3b- zh1>8+bYBHo;)+PQ#19UMD3IL`bA}b+cI0tlQkamWf#gd7OHHxg#@wb%DEeLC)=QhY zx?}LODX8A!T<9%6f9V|cIPp_l?sgzYaKnAPr3ixkEbn-KA>hq^P)l>~6w?VZi4G&A zSV38jl^#(+d;F~MR`~4)7i-f$R~@N}e(gxXlayy< zXv5`PVp@r^IO%zM_J%CDVzF6Gy}me&))bZ$zzW8K7-?uRoB~zM#WMPB$2`dnOw%(# z>tUkkMIk_pji5ZRxk$7veWLAbS*DoSJuL*3r`!?CdKVQ6s>(t!r%HK34K_*hp^pwc z9U_tp+)Idci%J0RWV&A|p{yWp80Z5>ctk;6J}B?5-g%p6N0IW4UIXgu_}BMlCn;%} zm3+hRB#QX`3w{+eLVHQUA}HE+NYniad14fI3{!E~jMQE+)D~0v`vfF@8*y>6Puyye ztvB#W-SNbN!&2^iZU_*YF8vaU>|C3*T6g71`~XNN}mYAnH^W}UNHMb)Wn^^|WR@sN*`0BNJ z+C19v(Dt}|Vh7O8dlD{$6wY)>gIliiH~GM5WLrc&C;Y@z6OKxxm66l$QDO$`_h*p4 zAz4o)M#MrU$yRyp3AHe?__BaXKoqL92S|3UFc%(G)wYf6n6k4ruQ)}0O49$~c4;T$ z*Yc8wSz~=TFx_q%Bt~116@Iq#HF0G&m`7)B>S6r2;78*fEjK+eydK||tT1bpoYbSq zsw}%1&{+LPvzf)SV^SK@7~WCBs#mhp(!2D6pNY_gd>%l6c&pF`K2WVZcXJ7-qzkk; z0Wt9?GLsd4IV-*6--{Uo=)I-_fz)m(=qRe0#U_oiaq_786vWC)d`&0Opjg-%@-`^(dqLP~P_Fd6Ghpcu>C)&EjM{ z5ipOO6C-KJjwGlhP07jM=aDx?xSjj1h64$30o97BH_>B8NQET31-BBJ(d>@^EIA|r zD5e=pYY!+E3wn|+L?l5f7<~o8spfiwVE@lZ=8o#fPUyl6MGeCmWg#y6Z@!>=2c=yc2lJ#Y{*;n{@wyhx zUNdd7I;b|a7;1ca3P=4kJ&!vo@dmb6kmbFTYDrQ!;Eidh&di$W(E3XlgVR864Ap=; zi0eIy1NJyS#cyFc?CF7$<|7XjJm`DLaTMXRep&-R1|fnW(C_t6c~0$%J^Yg(3pgyZ z<`Usui3PVR6VB-0AxrMYfk)6`s^}2G6GawHtB4mT#$psiPQpy9QSkaVR);D*iHAJt zl`a|Aov}2q&M6y{gCWnZFW)s2b+Hh)B&rt@73)!B7vmhggxvEis%A9B7f-wBy}I7{TG%(xzHVylZkGq2)H4bv z8TD^s8Spi=p-qy3wDY#7I|jcP@|1Bft|ZgLlG>g(CR*FbtEM}7Q%^rEQwb_KqQ;F; zs`>=^uHRg!80@2h&rZ3&vhH{`ltca5_YFAqLEeU(Ce-|M)}>Dji5W5r*LiW z<;ptZ@uX2Ougi^m^EzmzR_N|)sN=U~9Wo1a&EYF<_1Q9mF{yYyXy9$vU6p~HMSmvm zq&=`&i+el8@(RZe5OdTyw_T@?c9qgx4ok+Z9NSdRx$&-bs`Ox9FOiL#ThweA;0*MVv2{%4a-rFwB&&O z{LG)%<;XzekvkJCAUqd*N!=-9%{%HuQ$U0e9+v)rJ30bxBjtzwd+|ix1}&?;!ojTz zvG*FpU~HPgrI_|eQR4L!QA-Y*vYHY8p99XhCkj~%jy+a>+=%u@B_4C`u5IzCvZl#g zA^l=zG%(^gGDAY_2BJ&<`wwC?mT>zBc&@O?9dV=1lIK;EQ-X8mZh4}wqD?K7X~wsH zON%_2Gfgw)fZ_brUO#tInM?Fd)KXie$7GqjW-3jko@WL}xBsya3sU>M*E)@DHqPig`u zCpDt>VQx$6fpoXZx0dVF(Yj%!p{nKl4$K}K$wr2YDMe;!2I{%1@Z*NlLScBFCzQR0C)F0 zRZO&ZQ}&%qzN>n?ekY_&Ssjr}v3>n!LU$$&{mz@c0W$2^>g#inlbV_pPAy2ndH`c4K0+FI-)ELYH%5EU+&6Oy;L)ucKR2?z3mH zX$gIZ^@aBRcH_b3U$3M|thqq=vnQv}0hD$e{8}5z9n0J(sx_&p@7JIlo zDJ8y^8dE$z5o-}U7~id0b&Gnb*dm~#!XZSG#V6coa|j);PACsQI=ksU&k143ARf^Z z?9ksh+dUTm+>CvZDmhei`Uj~bUWAm=kt+7BMRJXZ zT_W5*^erxrIe`_|V+PfEHC%#zUy5?%4+jh>n)7H3#*fLw`vln|gouoMor2#-mj2T#uc1#H~qYGEB1q_a7O_mMNctH#&ufnRwk6$D!bmGxnr?SE!eos z!)yD<;!{;(T~@LaK=648$J9tQoG4`7iKkXJB!k^Ip>&V& z-?)>j_2K-B|MV}S_X}lZ!IjDXWY*0&tCsYA?IthG`7rMzj>e+ zdt^&$jvLxI$gI}PZ!SdkW}YO)xQyy?uBzaM=-!+ZYz;NUv?`#FZ#sAodD8d|oW z_TT8}e^ArR3gQS2o&7a|f3qgeiyJFG+S^oQgZr=1|5xQF$8$f>XeTlM9oqjgJ1;Aa zAV7LjR3`V|$WKYC9F(c@@$PN*tTa`#K}hHSoxZk9BQp&wShZF=lgY2B3 zyDKyLwaqZU{|_woAiW9^{@m#^%QV-lNf$pPoj9}L=Gvrno!?>`(d(sqnUQ8i9+>$* z6Z6j`c$nYElIlJCeVxC%Xo8-~KZ95Bi1BYHN@5lNaP0p|{TciJKfQ748y(k)lm2>@ R@{iMJa#Bi?W$!-+{2!G{P_6&~ literal 0 HcmV?d00001 diff --git a/docs/setup/configuring-subscribers.md b/docs/setup/configuring-subscribers.md new file mode 100644 index 00000000..3c1030a9 --- /dev/null +++ b/docs/setup/configuring-subscribers.md @@ -0,0 +1,24 @@ +# Configuring Subscribers + +Learn how to setup subscribers. + +One of the most powerful features of Cachet is the ability to automatically +send notification emails to anybody who has subscribed to your status +page whenever an incident is created. + +> **Hold up!** +> Before going any further, ensure that you've [configured +> the mail][1] and the [queue][2]. + +Once you've [Configuring Mail][1], you need to login to your Dashboard and enable +the Allow people to signup to email notifications? setting found in the +Application Setup panel. + +Once you've enabled this setting you'll see a Subscribe button in the footer +of your status page: + +![Enable subscribers][3] + +[1]: configuring-mail.md +[2]: configuring-queue.md +[3]: ../images/enable-subscribers.png From 33ef9753fb1f23992dafdf55a80f5ca5f291aac0 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 21:51:58 +0200 Subject: [PATCH 7/9] Create the beacons documentation The beacons documentation file is based on the online version at: https://docs.cachethq.io/docs/beacons --- docs/setup/beacons.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/setup/beacons.md diff --git a/docs/setup/beacons.md b/docs/setup/beacons.md new file mode 100644 index 00000000..589bd512 --- /dev/null +++ b/docs/setup/beacons.md @@ -0,0 +1,30 @@ +# Beacons + +> **Version Support** +> Beacons will be introduced in v2.4.0 + +Cachet will periodically communicate with our remote server. This is done so +that we're able to gather information about the current version of Cachet +and will later be used for system announcements. + +## Disabling the beacon + +To disable the beacon, you can turn off the following setting in your .env file. + +``` +CACHET_BEACON=false +``` + +## What is reported? + +We report the following information to our server: + +- A unique installation ID +- The current version of Cachet +- A support contact email (the first enabled admin's email) +- Anonymous statistics (the number of users, incidents, components and metrics) + +> **Support Contact Email** +> The contact email is used for the sole purpose of security +> announcements and will never be used for anything else. + From 83d22e957b47aa7e3b20c91874304976032adef8 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 21:57:51 +0200 Subject: [PATCH 8/9] Fix markdown issue Markdown is tested on Dillinger.io and the interpreter is not exactly the same as the one on Github, so I fix the Markdown to be more readable. --- docs/setup/beacons.md | 3 ++- docs/setup/configuring-queue.md | 2 +- docs/setup/configuring-subscribers.md | 2 +- docs/setup/cors.md | 7 ++++--- docs/setup/installation.md | 18 ++++++------------ docs/setup/prerequisites.md | 4 ++-- 6 files changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/setup/beacons.md b/docs/setup/beacons.md index 589bd512..d686a1bd 100644 --- a/docs/setup/beacons.md +++ b/docs/setup/beacons.md @@ -1,6 +1,7 @@ # Beacons > **Version Support** +> > Beacons will be introduced in v2.4.0 Cachet will periodically communicate with our remote server. This is done so @@ -24,7 +25,7 @@ We report the following information to our server: - A support contact email (the first enabled admin's email) - Anonymous statistics (the number of users, incidents, components and metrics) -> **Support Contact Email** +> **Support Contact Email** > The contact email is used for the sole purpose of security > announcements and will never be used for anything else. diff --git a/docs/setup/configuring-queue.md b/docs/setup/configuring-queue.md index 2fe7d2f9..d1bcf766 100644 --- a/docs/setup/configuring-queue.md +++ b/docs/setup/configuring-queue.md @@ -39,7 +39,7 @@ autorestart=true user=cachet ``` -> **Update to your configuration!** +> **Update to your configuration!** > Be sure to update the values in the example configuration above to match > your installation setup. diff --git a/docs/setup/configuring-subscribers.md b/docs/setup/configuring-subscribers.md index 3c1030a9..96802f7e 100644 --- a/docs/setup/configuring-subscribers.md +++ b/docs/setup/configuring-subscribers.md @@ -6,7 +6,7 @@ One of the most powerful features of Cachet is the ability to automatically send notification emails to anybody who has subscribed to your status page whenever an incident is created. -> **Hold up!** +> **Hold up!** > Before going any further, ensure that you've [configured > the mail][1] and the [queue][2]. diff --git a/docs/setup/cors.md b/docs/setup/cors.md index 53357934..03ef5fbd 100644 --- a/docs/setup/cors.md +++ b/docs/setup/cors.md @@ -2,7 +2,7 @@ Cross-original resource sharing -> **External Access** +> **External Access** > By default Cachet can be accessed by any third-party server. You may configure your Cachet installation for CORS very easily. To blacklist everybody except one or more domains: @@ -13,5 +13,6 @@ You may configure your Cachet installation for CORS very easily. To blacklist ev - You'll see a Allowed domains textarea, fill in any domains that you want to access the API as a comma separated list: -> _Text_ -> https://demo.cachethq.io,https://status.cachethq.io +``` +https://demo.cachethq.io,https://status.cachethq.io +``` diff --git a/docs/setup/installation.md b/docs/setup/installation.md index 17301cbe..2db63b30 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md @@ -4,8 +4,7 @@ This guide will detail how to install Cachet on your server. ## Download the source code with Git -> **Check out the latest version!** -> +> **Check out the latest version!** > The tags below are examples of what will be shown. > You should always run git checkout on the latest tag. @@ -35,14 +34,12 @@ file to `.env` regardless of what environment you're working on. It's now just a case of editing this new .env file and setting the values of your setup. -> **Environment Configuration Notice** -> +> **Environment Configuration Notice** > Any values with spaces in them should be contained within double quotes. The `.env` file set environment variables that will be used by the application. -> **SQLite hosts** -> +> **SQLite hosts** > If you're using SQLite then your .env file should not contain a > `DB_HOST` key. You'll also need to touch ./database/database.sqlite > and give it the required permissions. @@ -61,8 +58,7 @@ composer install --no-dev -o If you are installing Cachet as a contributor, you can forget the `--no-dev` option. -> **Tip for Windows users** -> +> **Tip for Windows users** > If you're stuck at the Composer stage, you can run > `composer install --no-dev -o --no-scripts` > which usually fixes any issues on Windows servers. @@ -81,8 +77,7 @@ php artisan app:install > Never change the `APP_KEY` after installation on production environment. > This will result in all of your encrypted/hashed data being lost. -> **Getting a 500 - Internal Server Error?** -> +> **Getting a 500 - Internal Server Error?** > If you get a 500 error when visiting your status page, you may need to > run `chmod -R 777 storage/` for it to work or `rm -rf bootstrap/cache/*` @@ -90,8 +85,7 @@ You can also try to give permissions to cache chmod -R 777 bootstrap/ ## Running Cachet on Apache -> **Required Apache Modules** -> +> **Required Apache Modules** > You need to enable `mod_rewrite` for Apache. On Debian-based systems you can do this by > > `sudo a2enmod rewrite` diff --git a/docs/setup/prerequisites.md b/docs/setup/prerequisites.md index 899883a4..faf2052a 100644 --- a/docs/setup/prerequisites.md +++ b/docs/setup/prerequisites.md @@ -13,11 +13,11 @@ You'll need at least the following installed on your server: - A database driver for your DB, such as MySQL, PostgreSQL or SQLite. - Git -> **SQLite** +> **SQLite** > Whilst we support SQLite, we advise not using it for status pages > with a high amount of traffic. -> **MySQL Timezone Info** +> **MySQL Timezone Info** > Ensure your MySQL database has been updated with the correct timezone > information. This will ensure that metrics are shown > correctly: [https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html][2] From 578a7dda7284b86ab02dc510166a7cde4c22a0a7 Mon Sep 17 00:00:00 2001 From: Anthony Bocci Date: Fri, 22 Jun 2018 22:01:35 +0200 Subject: [PATCH 9/9] Remove not used file Cachet setting documentation has been splited into many files, so this one is no longer useful. --- docs/setup/setting-up-cachet.md | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 docs/setup/setting-up-cachet.md diff --git a/docs/setup/setting-up-cachet.md b/docs/setup/setting-up-cachet.md deleted file mode 100644 index 20bb181c..00000000 --- a/docs/setup/setting-up-cachet.md +++ /dev/null @@ -1,3 +0,0 @@ -# Setting up Cachet - -This guide will detail how to setup and configure Cachet once you've installed it.