From c7fea49c1335b012b44cfbcba1355228b87975dc Mon Sep 17 00:00:00 2001 From: Andy <18440817+andyrb412@users.noreply.github.com> Date: Mon, 15 Sep 2025 18:56:17 +1000 Subject: [PATCH 01/46] Update authentication.md Corrected spelling --- security/authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/security/authentication.md b/security/authentication.md index c93b56e..27ef9a8 100644 --- a/security/authentication.md +++ b/security/authentication.md @@ -16,7 +16,7 @@ During the first start of the application a default admin account is created for #### Login Details -You can update the login details of your account through the profile page. Every user can update these details for there own account. +You can update the login details of your account through the profile page. Every user can update these details for their own account. * In the top right corner click on the user logo next to the bell icon. * Click on Profile From 4f038ea4721e950e14f2ebe26668650ba1b5b699 Mon Sep 17 00:00:00 2001 From: Laurent P <1441170+vadius45@users.noreply.github.com> Date: Sat, 11 Oct 2025 12:24:54 +0200 Subject: [PATCH 02/46] Update doc for new variable DEFAULT_VIEW_RANGE --- getting-started/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/environment-variables.md b/getting-started/environment-variables.md index eafc87f..557fa38 100644 --- a/getting-started/environment-variables.md +++ b/getting-started/environment-variables.md @@ -8,7 +8,7 @@ description: >- ### Application -
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
ADMIN_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ALLOWED_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
CHART_BEGIN_AT_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART_DATETIME_FORMAT | false | Set the formatting of timestamps in charts. Formatting: https://www.php.net/manual/en/datetime.format.php | j/m G:i(18/10 20:06) |
DATETIME_FORMAT | false | Set the formatting of timestamps in tables and notifications. Formatting: https://www.php.net/manual/en/datetime.format.php | j M Y, G:i:s(18 Oct 2024, 20:06:01) |
DISPLAY_TIMEZONE | false | Display timestamps in your local time. | America/New_York |
CONTENT_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false |
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
ADMIN_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ALLOWED_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
CHART_BEGIN_AT_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART_DATETIME_FORMAT | false | Set the formatting of timestamps in charts. Formatting: https://www.php.net/manual/en/datetime.format.php | j/m G:i(18/10 20:06) |
DATETIME_FORMAT | false | Set the formatting of timestamps in tables and notifications. Formatting: https://www.php.net/manual/en/datetime.format.php | j M Y, G:i:s(18 Oct 2024, 20:06:01) |
DISPLAY_TIMEZONE | false | Display timestamps in your local time. | America/New_York |
CONTENT_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false | |
DEFAULT_VIEW_RANGE | false | Set the default time range for the dashboards - Default: 24h- Values: 24h, week, month | week |
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
ADMIN_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ALLOWED_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
CHART_BEGIN_AT_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART_DATETIME_FORMAT | false | Set the formatting of timestamps in charts. Formatting: https://www.php.net/manual/en/datetime.format.php | j/m G:i(18/10 20:06) |
DATETIME_FORMAT | false | Set the formatting of timestamps in tables and notifications. Formatting: https://www.php.net/manual/en/datetime.format.php | j M Y, G:i:s(18 Oct 2024, 20:06:01) |
DISPLAY_TIMEZONE | false | Display timestamps in your local time. | America/New_York |
CONTENT_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false | |
DEFAULT_VIEW_RANGE | false | Set the default time range for the dashboards - Default: 24h- Values: 24h, week, month | week |
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
ADMIN_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ALLOWED_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
CHART_BEGIN_AT_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART_DATETIME_FORMAT | false | Set the formatting of timestamps in charts. Formatting: https://www.php.net/manual/en/datetime.format.php | j/m G:i(18/10 20:06) |
DATETIME_FORMAT | false | Set the formatting of timestamps in tables and notifications. Formatting: https://www.php.net/manual/en/datetime.format.php | j M Y, G:i:s(18 Oct 2024, 20:06:01) |
DISPLAY_TIMEZONE | false | Display timestamps in your local time. | America/New_York |
CONTENT_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false | |
DEFAULT_CHART_RANGE | false | Set the default time range for the dashboards - Default: 24h- Values: 24h, week, month | week |
{o!K`O6GW{rZZ7LyC+;tlV|>HtY~lTg+{(%xFZT`Hk1h9u)IpNqGuDgGpQx&(*<*uEC`H8shQzn1O#5U_kZbV1N?uS&MXUCC ?YJwNgCz+4l8oi>3V@-H3N=pMJfAuEa-|K7I z??~y_d)VcnhxROQaB4$2KFfV34t4nv_d{{bcnu*`e1c{^u1!YyHRe~p52D&i3u2aU z^e9~7glOp)QfPS@Q0NM1pCp7O3?#TRWV~<5J(J(%(8{ouxp*xV 3VY+d!@#ciu zk^726BJiWaap4cu8oE>3ecJkXj(D$l?ty^;vjNfpwgIHg=7Ifq7+sdCPw|bigldms zP(f@7rLtB@jp}CpfK3AT2m0x-Jt>8pm+zBQO1~C;#VRKI04j+ru~y66do_(d?K#a* z!ZO`wnP@3rA8ILKxoL?u&HVNJYut4Cl-Ay>^Z7lzJ*g?X5-f``PDv|q&<2Qce6HL< zKTj$yA5=hC+&`(C-K=n0w`EKu$x&2op}XL{;JQGl-S|>@P&>Rlp y&eiVmx$ODg zS;anhqG%s&Z+oY5%x *Xa zb;)ebmdDV<8rS+YySAP4Lh-0(@7yTQqI>=ElXZQZ)X=EVZzlCJwf#;lZ!=^@3o7#( zC*TSg3S#oqg*poS^1^9aY1GMhY11jo+(pS8LmWdIX^qJ+on%dM&7r#D>Lz2E1`|y) zt%`c F|PvO8;D${tPQJQh<_(ctg<+f## zsfLkTKWV*NE&iNc-O(! y+zMwg!2ndKJJGf?ralR)2CB3H-Hs#MZl>+$*KTJ&H7noayVq z>%QrJaIr^dC73Ae3ZLs;F @kHA z1%s$<&6hb{SFTp!DM4p-3#(*VP2IWRDydc1)wSP+k2xthKdSv`mmZWhG7-c5{86er ztcA>mM3DO0;u+f;zCy|^5OilQrP{`!u1UtBb$z7=-pdl+nPwPAE@L6{K~7$wOwl_F zH@c4ftJPAmL+wvJ`M1(9Uvn2mtGrNk&3_hw^{Ug%+pWaPQfBYVlNp>s1s>sX!;gnQ z*5jt$IJ_Z|r^=@;I8cOlhpv5aK%JQ1P1wEFed)#oLm7=~Or0HsZB=dv5B?s}Oc{^c z&1j~t CH+>2hThzK#L!m7RxeXUUwh?wP9dw*9N)bANnL*i zrI&JOu~pc1JeTTqkI@>*mGs@Go1aKbmsAku>X;i!56vA_P321?%eAS%NzTG2MfFOJ zX&vs@wYk~35VKz#O&r>0sUzv!r>l%xW#zRo^SiY=TgjtZtVLe7znAn*X-^%uZuOxb z+G;KjZt|}bo<_VJ())dx^vl3f_JiCHYHoZ_rlq#W2Cp@zs@;dy&cizsPGni)c@q+n zz*^mUj;pidofU8wd(h8`NK@Ovw@ft5_{^Qv-EKV<2}BIx>O%T>)g?Y$V3*y!MyogF zyatCV9Ue@k Ex%p9>@&@<7~GqR%>?h`-Ql?;1Sf 8K9zqxJT1)E}+FLvuR}W3O zEWYFyx+(2t4tgP9yq)2jvMrzd%CLxbA#))J$!fU&>0gD+ghq&Fg{4JWA|TJNs~t6^ zRC#3AXSri3ZwnQ8;hA61U%LBSxi^nLDuuL^rvmIf|70K(g$6Y(JQYnbOz|RPK;XQ| zRAq2^a$V8D>I>+A2gh}5X+FEQXffGlc)M+sg#XCnt`FsBP;j^{{{EugBG&!kHGCDb zG4fjOFo}r8OV@Vq)uP8**inM2269Da`_B&7W6zEA5#lG@w#)ME^Dg0TrQ5ED2O4hZ zN8TO$Fw#~1UGO=46YCk-hg&1KlwOj~>~RPp)*@MtU<*7Me%TXuLu1f_FHj)F 0*j44>Gj}I<;9)D?Q-RhN>l?DkGy-cZJne> zCggEstd-4n_)W)I;9ZCw86nxC5H;BI!ebAABFV+Trt>ZMDcseL)z1F?kLOM%ok#>_ z7Luq4m2OBP3aEalqvr9)C#P9u *`EPLx3(~Mj5;} zV8ZjWphq|+MIhlYYr@Q!HrbX1QFJ?fON_4E_1OId!M#d34QcYV_5U!9a z^c&b) zM*QG&4?roxOf_Z96ciBXf%V4-j}VCvP=GZ=;46ek{NL-6h_ndEf3_nbAcTMr9{uYW zMPT{xi3Yw8ZT?vz#|9&y0smeAU-xXJ|2i6jARGC=*3s;NeF*PV#bjiFrK+)`sj01# zg`IN^ZoU|>;fcMpmJ Af<(~vppXRi<_Gpvl|DqoufGm8!s;}3oAPdJ3A9_1e248 zt+SCkldTigKPUOG^N5=|89RdPok4cC }-IGIt%^Jfc>lS|K9nph5{@P&;Gyq;-8NGvlZxR zA#?$j{~k3V^bmw;fafB-0*Nbq0G5E6J$#UxfFIg_mcTl4r3`btEGq(n2!f3GyASS& z&}9$9SEjeU$99K#&9ZU&yUSyRK@D|v1-RJpV$b~@8IaVzg?-kQXnu!F8}gWz(vj}- zZ`J46??f=0b?DAMy|ocL%9lzlv^j)xLufLFO=`_ux#tyDqB>2?%`-i=Qf7xf-LYjs zxNQv&f6XM$sE0;HC8aLVfBpJ3v8jnCh1DoPKAlHdTU$H7qhm$efU4E)C^0My{cA-< zVsJ1j$kLKsctOgyZr8k&ixdO#5w-}z|M{nzA-kDu7!fq7bSon-&nevB-#<}lAiN9d z?0iPRDx#vQIvjPORd1P4rr)lenwG||K+DYH_TH+E>vv{5-o)4(t%pam guSx5dg2oz3_^Bsb`A~& zg56sfB&nvR2Gc2GaFBRPTe*5smW-=Eo=!DCJ6q)9aG61;!8%5-)iuSm{DZh!E~c&b zyZ?JHVT+KLpwunIsB;gDj3h2C=@JTgH)%05->D=r>FlL?>3;ken?PcjKo!Z;P462| zmG;(#9WUG!I!EzEU4kk=f|=pve= VhKej zCcdn0=&dJpnNltsQg(1~2q}?Zb8C<%_&=M(pF0&m=P4!pLc*_JQc|+<(AQ0Ls)co! zBzzxcDh*f`8*JkC_AEiRwii5)8J_ YOGV{{M6EIX-%e%`2=*A%|1Q6%NKRWjRg;%QMq2vuU_UoEcet64 zrIl4dVWH$%yE1%vyy}(VJvpB_g9WZR9!svLGLI1 yKBuWzLoiH?pgHYte)8TDE8#>U3`kf)aSfLo {T bg@GkHD*&P1gUd;k$EKK5i2v*Xk zPoIh@ftd<;s)pn+$sG9zKV@1^D6uNi2d1#EgFPmHrf)Z`NFQxP^0T17G%K*8;YMGK zvTA)Fafdp`LLDfsaoA@ThxJ5GJY UqlATp mMf|X(y-JGTmksB4T1>J}e|jM7D9dnMcL?xK 2hA;+FZqLPY?_eVyPJb#6pu{4swZ#r41fapSFh>MMr@lnBVPomnj zC;5+2i6}jO-&0I8#rx(jFC$(mA}bpvpDDnrT{K(ZQLb4ny0^c7dnos B`PCg=_NFE#GCp^|H1mu*{&*p SxpCUWfT=JRwzIXOA|PBsT`N7@82RvQ^e zus>t?A3i2X8IU-3P*GN;BAzXedsFH-ZaTX}i=XM%V6E3EK5{c65gVIG9Tc?AST{50 zXPo#?pQwl+OA>MBQvBQV=3fp7tVPbjF*$&Mdm$SjvVu=-IK{vMh6sMWx$!3CbG8si zly9PCR&<3fQWd1Vm8->LZaKbyZzgf;8bvOC&|yYCDdT;eKhWer#A<2fFeAkI4}8c~ zAdmKCm0V0u!TL)ZA;-2w9Hz8*lf&H*8~cKeiRs+K@==8MNfq17BT5q1n(q>=rKKjS z4%M98Z~N pIp? zon<2W`CkM1ok1iN6qJch-+O(T_sYr?J?g048sYtZ<7ZvXjvHeX>@H&ngjsP^SA@4^ zPSy#rB}7`a=249E)pA1g%gkA}kj?!iss@{_Pj`+}Qv$qotWxMwW&>6JAj(AN{zz@D z_OB{J3=33bj7)J#>KfwKm>sAi{1$%CQW9yJgKnwK 7V5Q97LQ+8EKPj0q0*1k5c4OCR2v z?!Dzv(^&WpARFc1lv8&)2nl)FO{DdkihA7tnMt1*MZVFRh@$=_(Dc_QX9Z2Xjziu- zDVo^D-P_wU*&Im7nBmv>@!^}rO!Pa)nagp vDVN;|uRC=F+& zX!G9`&Fov3&)Kh=R%5M)M>VXfwi@rsnQB&thikxEqmSynhesD1q){S L45mDwuch*rZHlZ4VS~2%3t7 sj6e7PDTm&-*1D`bhW+N&xl833zBfqjpb-KeM0Kek`4g*(pbxuFO| zRUG2~M$9c<|H8dOTa@k?rbb<=9?83vOq!Mw3^N e}$&B8zj 7ZdzymRue zZ$;@zbh;IhD5pq9 zwH|B^6;_0sEF>*ZDlc?JCYLSiQb)C276@EV{Je!rY~}qvt7bngL+U3r(twQ 8wA3ceUCtzV>VwzDZeR5^JsLPn7v^6g(0@>U7pF* zXMgphm-{r13I 9eTs69sac+?`inaPjc2_K1#ch!n?Jr-<#^D7YcsPTzX>_k0k^ z$iw(n9C}F{Z;pGzgJ~jp);^P_%->v{Zl*hp9J^bC^+~;dzw@}5Hy5-$!e9XF1v;$% zl+oAEj891DU#Pe8I&&^k%3=n<@X2P9!NA4AB68|r^L8eKhQ5cX2sk6dY$Sd6W+87- zJM5%5FOq$ !Bh%3 zbjB%~p@@W0IL+ttYZ}WJWlRV-_~z5}H7^&Hvcdh$>PjVD=&DP#?m+@oKiqhWDv)$f zmmM5$myTm&agSUcZ$r~FoWXj=;f(H 7BwvBy8c$--oHBWV} zH|VvFokvlXm$o-|y^68w7&J{VRxFme7hMmdGpGw@+6!TNI<1EdUZ!14v(lSeTq>=W z1!`Z5nHb}(+o#CPQDTSO_Epo=ulo9SS$gE~`_Be#V}H(Yrg-*sJ+J(@!D2Y&`etU* zBx80xN|-rH@FKarWKp=42=F>S%RT`{JlU1@as Rc ztuvi>*ZYoxOpQ$)utF4r* w$EeJU`#YHMsT*zbw@lPtPLY?^ zRED@^$$cs2nRLcKBVxP`n`yE$d@pLVQmW>J?~bGVu0tmJA;JV=g#7W~Cj>#cz5jre ze;=A)M~D=Ad@_uj#sS~9v+Oa!CUBh2-G`oH5wSFq@ruRbtd%DfmNS>D`x*Q86*E~+ zHKgT5#%PVdJQ_QkiA}&5j~-VbW5)ENrYhI1`!x|r%|&N)-v+&^120tL`i`Bef8M?h z5pJX>w6R!Zlkco|95+f*in&x=rOZev&qs5*UvWTU`Z9dd2`T%0Ei1X|o~@&;lW#rC zOgG=6mYSAYU|{Ckd>JdZIY)&Rx0?5JfFh1YR@J5e>V6FR+Ccy5HBFJMZX0U&)O+8H z`xT{y_Xaeu`*l+f=T%vmBW{s5@&s1PgEqJF+mCN*kR@3OW5E5GX(8+r- zXKcDR_4NUi&BoNnj&qC(tY5EWJk`TMcX8=F6lk<38PsT^*6scMc4TKfZ?n?(wsgKM zCwGv!RbIVP|6tGOY+NdQL@7{`NR$7tX @OkABL?h90nw^n=*ZpO3jTSL*X~HOE8k2RMc{_NF=i4n+`PWWppGx%9H~`s zw?S#YF_^3Do >HN2YOj)f9-wU%;z@O z+N>hf0q2 H^S$2H(1{dp}drmr9^c2}r>Y+}p3 z(8Zed5!padkzWkly%FNmnr`3y#LOjJEl7r;67Y!4Zcbp~Uw+81xwzD1<>d7CZ