Compare commits
1917 Commits
Author | SHA1 | Date |
---|---|---|
Alicia Bot | 93c2c77f6b | |
liss-bot | d6af666230 | |
liss-bot | beb262871e | |
Tobias | a7c15ce36f | |
Tobias | 2f86b16491 | |
Alicia Sykes | 5854db4205 | |
Alicia Sykes | c3aa2b5282 | |
Alicia Sykes | d92ae25700 | |
Alicia Sykes | 3fb87fa9b8 | |
Alicia Sykes | b5415ca5b9 | |
Alicia Sykes | 749f3b21da | |
Alicia Sykes | e970fc69c1 | |
Alicia Sykes | a9c46c362d | |
Alicia Sykes | c6f72ad84a | |
Alicia Sykes | 31bf46a406 | |
Alicia Sykes | 83059bc536 | |
Alicia Sykes | a327bf2349 | |
Alicia Sykes | 21eb2a604d | |
Alicia Sykes | db9d7e362d | |
Alicia Sykes | 85de40d950 | |
Alicia Sykes | fd421cda15 | |
Alicia Sykes | 98b3fda407 | |
Alicia Sykes | 27f10d76db | |
Alicia Sykes | 29626ebb06 | |
Alicia Bot | f9f365aa3a | |
liss-bot | 292a46f402 | |
liss-bot | f766e990b9 | |
Alicia Sykes | 25ba708a9f | |
Alicia Sykes | 0813b796ab | |
Alicia Sykes | 1f6b433148 | |
Alicia Sykes | 99643acddf | |
Alicia Sykes | 9d683dcbf0 | |
Alicia Sykes | 3416615d30 | |
Alicia Sykes | db63362327 | |
Alicia Sykes | 9e6fb17d93 | |
Alicia Sykes | 4594c99b57 | |
Alicia Sykes | f77c192e66 | |
Alicia Sykes | ca96e0c1de | |
Alicia Sykes | 1bbb91b3fe | |
Alicia Sykes | d58cde69f6 | |
Alicia Sykes | f68d65264c | |
Alicia Sykes | 27bbdef6df | |
Alicia Sykes | 94307da70b | |
Alicia Sykes | d34c4b55f5 | |
Alicia Sykes | 915a5dfd38 | |
Alicia Sykes | be513a0952 | |
Alicia Sykes | 2ce3b29ad2 | |
Alicia Sykes | a138602670 | |
Alicia Sykes | ecef01b034 | |
Alicia Sykes | f295958c44 | |
Alicia Bot | 382f8f3ec0 | |
liss-bot | 1e72debe5f | |
liss-bot | 54a00ee099 | |
Alicia Sykes | fa6d1925b7 | |
Alicia Sykes | 931915f366 | |
Alicia Sykes | ff2be31df4 | |
Alicia Sykes | f1867d3cc0 | |
Alicia Sykes | d043c21264 | |
Alicia Sykes | 7f011878b4 | |
Alicia Sykes | 6a6fcd4be9 | |
Alicia Sykes | b711f77cf7 | |
Alicia Sykes | c1f23d2fce | |
Alicia Sykes | 23576873de | |
Alicia Sykes | 3c9e5bd369 | |
Alicia Sykes | c456bd6bd6 | |
Alicia Sykes | 133718972d | |
Alicia Sykes | a82d10a0c8 | |
Alicia Sykes | f353780ad4 | |
Alicia Sykes | 88498d3887 | |
Alicia Sykes | 25e774ca79 | |
Alicia Sykes | 75f65de8f6 | |
Alicia Sykes | 27a8c8fa56 | |
Alicia Sykes | f98441644b | |
Alicia Sykes | ca0ec003e7 | |
Alicia Bot | 6f94ac8764 | |
liss-bot | edf2eb8c98 | |
liss-bot | 6623127702 | |
Alicia Sykes | ae8357fa6e | |
Alicia Sykes | 5214583ad0 | |
Alicia Sykes | 77236779c8 | |
Alicia Sykes | bbb9ce7272 | |
Alicia Sykes | 4ea77a1015 | |
Alicia Sykes | 91e4cfe14d | |
Alicia Sykes | e1a95405c1 | |
Alicia Sykes | 5b11c0af34 | |
Alicia Sykes | 4d851b6e86 | |
Alicia Sykes | 7f45c29931 | |
Alicia Sykes | a6381a4a7e | |
Alicia Sykes | 743b5340f8 | |
Alicia Sykes | 0a56db5397 | |
Alicia Sykes | 016b6dff09 | |
Alicia Sykes | b66ce53669 | |
Alicia Sykes | a32e76935e | |
Alicia Sykes | c1c75f78ba | |
Alicia Sykes | ee735fe342 | |
Alicia Sykes | 49eb262465 | |
Alicia Sykes | 6fa782d6a8 | |
Alicia Sykes | 2e38a33fa7 | |
Alicia Sykes | c6ab08f7f0 | |
Alicia Sykes | a1bf7a6931 | |
Alicia Sykes | 31b40e60f6 | |
Alicia Sykes | 18e2338735 | |
Alicia Sykes | fd45aa6bd1 | |
Alicia Sykes | 5f6aadcb95 | |
Alicia Bot | d77045bee1 | |
liss-bot | b97c48bc35 | |
liss-bot | 7cde9fea34 | |
Alicia Sykes | e2e581de59 | |
Alicia Sykes | 492bddd192 | |
Alicia Sykes | 6547452d1d | |
Alicia Sykes | 61127b046b | |
Alicia Sykes | ecacd145e0 | |
Alicia Sykes | a9548fe8f4 | |
Alicia Sykes | e219296d15 | |
Alicia Bot | c24d169511 | |
Alicia Bot | a3e703aa8e | |
liss-bot | c4d7e4907a | |
liss-bot | 62779c1668 | |
Alicia Sykes | 041e5d8c28 | |
r1a | 07391dd4d1 | |
Alicia Sykes | 5d26f8a607 | |
Mihai | 8656606d46 | |
Alicia Sykes | 60fc852255 | |
z3r0l1nk | 12d07fd301 | |
z3r0l1nk | b6ac9ff909 | |
Mihai | f94ef50b99 | |
Alicia Bot | 0618aaa93e | |
liss-bot | 594beeb5b0 | |
liss-bot | 2636d54cc9 | |
Alicia Bot | 99a2153e9a | |
liss-bot | dcf1107dae | |
liss-bot | b213fa1e18 | |
Alicia Sykes | 6268584741 | |
GuilhermeLCS | b2e5597e49 | |
GuilhermeLCS | ee3e45a56e | |
Dyauss | b55b7f7778 | |
Alicia Sykes | 762c6789b1 | |
Alicia Sykes | 2ca71efa29 | |
Alicia Sykes | a6960a804f | |
Tobias | e3f6609b52 | |
Tobias | e7fbc5c690 | |
Alicia Sykes | 6dd18dfca2 | |
Alicia Bot | 129c6d71de | |
Alicia Bot | ae68f8cddb | |
liss-bot | fa48ec83b2 | |
liss-bot | 2981a677a5 | |
Alicia Sykes | 8371218c73 | |
Alicia Sykes | 828f25de37 | |
Jimmeh | c93c041858 | |
Alicia Sykes | 1eed8e5313 | |
Alicia Sykes | c2368e1af2 | |
Alicia Sykes | 2de5c8fef5 | |
Alicia Sykes | b1892d8c32 | |
Alicia Sykes | 8a76fc8e34 | |
Alicia Sykes | 0229ad6a76 | |
Alicia Sykes | 02bdbb3dc1 | |
Jimmeh | f62f628805 | |
Jimmeh | 4471e316ff | |
Jimmeh | 98ed7d1190 | |
Jimmeh | 59a52c652b | |
Jimmeh | f304cbc74f | |
Jimmeh | e8845d90e3 | |
Jimmeh | 6f937fbe00 | |
Tobias | 631883a0d8 | |
Tobias | 3f11b0024c | |
Alicia Sykes | 3c5531dcd1 | |
Alicia Sykes | 147016278a | |
Alicia Sykes | 1f6bb48463 | |
Alicia Sykes | a6a2ee232a | |
Alicia Sykes | 1ed49c3340 | |
Alicia Sykes | aef7f785ef | |
Alicia Sykes | 427e46a702 | |
Alicia Sykes | da12eb65a0 | |
Alicia Sykes | 08e6bc6c27 | |
Alicia Sykes | 4886e97f2c | |
Alicia Sykes | 0d79fcf8a5 | |
Jimmeh | 777b2a1319 | |
Alicia Sykes | 2caec6a8a9 | |
Alicia Sykes | 472932806d | |
Alicia Sykes | 70651b75f7 | |
Alicia Sykes | 5600d26d5e | |
Alicia Sykes | 124e86e407 | |
Alicia Sykes | 0abc2584bd | |
Alicia Sykes | 502d34e460 | |
Alicia Sykes | 02923fa64c | |
Alicia Sykes | dbb750d306 | |
Alicia Sykes | 0a8df26914 | |
Alicia Sykes | 4fdfb6ecc1 | |
Alicia Sykes | d25a80dd48 | |
Alicia Sykes | 47762390d4 | |
Alicia Sykes | e290451040 | |
Alicia Sykes | 453f15c8d9 | |
Alicia Sykes | 5a029afb52 | |
Alicia Sykes | d4247b4fee | |
Alicia Sykes | 02db1db2ef | |
Alicia Sykes | 0d7051e46e | |
repo-visualizer | fcd502fb1f | |
Alicia Bot | 8b43ce6213 | |
Alicia Bot | 031a956f29 | |
liss-bot | 7785ea761b | |
liss-bot | 4ee08328ea | |
Alicia Sykes | df866ba408 | |
Alicia Sykes | 48fa5fc21e | |
Alicia Sykes | b69daeb24a | |
Tammes Burghard | 1d09b61367 | |
Tammes Burghard | 32f9745bee | |
Alicia Sykes | 48602bcd40 | |
Alicia Sykes | dab3440448 | |
Alicia Sykes | 417028b185 | |
Alicia Sykes | 27995f8500 | |
Alicia Sykes | 938222e1ef | |
Alicia Sykes | a155e2ca2e | |
Alicia Sykes | e626c6b0f4 | |
Alicia Sykes | dbc758c8b6 | |
Alicia Sykes | f5789a3a25 | |
Tobias | 4f56ff663e | |
Alicia Sykes | 5b2c0e970f | |
Alicia Sykes | 1658090008 | |
Alicia Sykes | 97a75b3643 | |
Alicia Sykes | 92f742a48a | |
repo-visualizer | c9133cb3c6 | |
Alicia Bot | da67e891a2 | |
Alicia Bot | fd77a3cab1 | |
liss-bot | cdeb4945c8 | |
liss-bot | e385f2f889 | |
Alicia Sykes | faafa60ed9 | |
Tobias | b05f057c34 | |
Tobias | 13f47d28a1 | |
Alicia Sykes | 16e071964c | |
Alicia Sykes | 006eb6c771 | |
Alicia Sykes | 8c5cf6feef | |
Tobias | a04f05a1bf | |
Tobias | f2dc237366 | |
Alicia Sykes | 65c868693e | |
Alicia Sykes | ded96b5578 | |
Alicia Sykes | b5482ee01d | |
Alicia Sykes | 74c61f0bfb | |
Alicia Sykes | c8b3047356 | |
Alicia Sykes | 73f6145c5f | |
Alicia Sykes | 8d8583fc10 | |
Tobias | 106364d370 | |
Tobias | 27bdcc0ef1 | |
Tobias | 05ef7fa757 | |
Alicia Sykes | 8bc5a15eb2 | |
Alicia Sykes | 90f291581b | |
Tobias | 1169ccf7fa | |
Tobias | 7d60ec2f8e | |
Tobias | 8dca503179 | |
Alicia Sykes | 644476cc5e | |
Alicia Sykes | 1f5274baca | |
Tobias | 076b1d14b2 | |
repo-visualizer | 6da8e7cbad | |
Alicia Bot | 1455035867 | |
Alicia Bot | 155736b495 | |
liss-bot | 3637a2ef88 | |
liss-bot | c62cfe62a5 | |
Alicia Sykes | 0894f71056 | |
Alicia Sykes | 804f2c13e6 | |
Tobias | f2641de0c1 | |
repo-visualizer | 8aad120bd8 | |
Alicia Bot | 09330f9c3f | |
liss-bot | 0bd9055293 | |
liss-bot | da38f289c0 | |
Hendrik Strydom | e8403bada2 | |
Al Saleh | 4a570edaee | |
Al Saleh | 05aaa1c9b5 | |
Alicia Sykes | b10853fd33 | |
repo-visualizer | 61bd84be73 | |
Alicia Bot | f567613182 | |
Alicia Bot | dddd96ea70 | |
liss-bot | c56aa85c04 | |
liss-bot | da723fde14 | |
Tobias | 25addadfc3 | |
markxoe | bc94fff775 | |
Aly Mohamed | 0baf10911d | |
repo-visualizer | 3aabdce82f | |
Alicia Bot | 5c18c92060 | |
Alicia Bot | 093d577e31 | |
liss-bot | 50db21bc81 | |
liss-bot | 15c7e8c78f | |
Alicia Sykes | 297e837b04 | |
repo-visualizer | 8217dc35b9 | |
Alicia Bot | ac4f6f5015 | |
Alicia Bot | 6757d17f4e | |
liss-bot | 260bb75823 | |
liss-bot | fd19f2b26a | |
zigotica | e818c701b8 | |
zigotica | 19da2ec829 | |
repo-visualizer | d77c188a7e | |
Alicia Bot | 53820acea3 | |
liss-bot | 252782066b | |
liss-bot | f61d0db695 | |
Celestial.y | a4e76a5ef2 | |
repo-visualizer | 263d8e40f1 | |
Alicia Bot | a00127a338 | |
liss-bot | bd46e1077a | |
liss-bot | c5326c57de | |
Alicia Sykes | a0ad224679 | |
Tobias | 210f099992 | |
Alicia Sykes | c9229fde27 | |
Alicia Sykes | 604ce976f9 | |
Alicia Sykes | 8e3c54f2d0 | |
Alicia Sykes | 3e75854520 | |
Alicia Sykes | 42709dbf32 | |
Alicia Sykes | 85fb8b156b | |
Alicia Sykes | 0a3f266134 | |
Alicia Sykes | 1e9ba1b747 | |
Alicia Sykes | d8c0919afc | |
Alicia Sykes | c4b687550d | |
Alicia Sykes | eb749ebcd0 | |
Alicia Sykes | be1775d3ad | |
repo-visualizer | 9c324db2ae | |
Alicia Bot | 0088fded40 | |
Alicia Bot | 7768c73a0a | |
liss-bot | c50f21c54e | |
liss-bot | 31ef6d4f8c | |
Alicia Sykes | c1f4271aa9 | |
Alicia Sykes | 89ea73062e | |
Alicia Sykes | e7bc1457d7 | |
Michael D | 69caa99c90 | |
repo-visualizer | fd658689e3 | |
Alicia Bot | a81b90eb9d | |
liss-bot | fa5267fd46 | |
liss-bot | 21eac2c9ab | |
Alicia Sykes | dd71683fa9 | |
Alicia Sykes | 777fae2503 | |
mmihaly | e754fcd98c | |
OKAMOTO Shigehiro | 696f87a4a5 | |
mmihaly | 3bf58308ff | |
Alicia Sykes | 40c9b41805 | |
Alicia Sykes | f69de12705 | |
Alicia Sykes | 2d350ae7f2 | |
Alicia Sykes | b7cf4749c6 | |
repo-visualizer | 93c213319e | |
Alicia Bot | 45de177ae2 | |
liss-bot | 050fda6fe2 | |
liss-bot | 1eb4883dfa | |
repo-visualizer | 3b64f45c03 | |
Alicia Bot | 6bf1c7f100 | |
liss-bot | d424471d27 | |
liss-bot | f6aa791b5e | |
Alicia Sykes | 86e6c898a4 | |
FedelloKirfed | ee13b0108c | |
repo-visualizer | 4324a3a8af | |
Alicia Bot | d133c2eb02 | |
Alicia Bot | 82c5f8713c | |
liss-bot | 6d55e5db05 | |
liss-bot | fc30b66c7f | |
Shahzzad Ali | 38148e1ef3 | |
Alicia Sykes | 945e8c6871 | |
repo-visualizer | 737cf0777b | |
Alicia Bot | 3f814b2a6c | |
Alicia Bot | bd1c82f912 | |
liss-bot | 6980789be1 | |
liss-bot | 52d541f7c2 | |
Todd E Johnson | 821ed3433b | |
Todd E Johnson | 756d640d06 | |
Todd E Johnson | 27dfe6219a | |
JJ Munguia | 0ef0bf0dd5 | |
repo-visualizer | 1a05b5a910 | |
Alicia Bot | 8c0f06da60 | |
Alicia Bot | 6c7974a3c1 | |
liss-bot | 290afb949c | |
liss-bot | 57373a2b12 | |
Alicia Sykes | 718a03dce6 | |
Todd E Johnson | 4aa34f66dc | |
Alicia Sykes | e511c2b8f7 | |
Alicia Sykes | 6a39aaac6b | |
Stavros Kois | 2839821ab1 | |
repo-visualizer | 50dc62373d | |
Alicia Bot | e3a849f2f7 | |
liss-bot | e9a287bdd6 | |
liss-bot | fe19cbdd0d | |
dependabot[bot] | b357de752a | |
repo-visualizer | 282e70dbd0 | |
Alicia Bot | 64a563dc40 | |
Alicia Bot | b6e431c626 | |
liss-bot | aac275da13 | |
liss-bot | 8572eb2a5b | |
Alicia Sykes | d2e49494ae | |
repo-visualizer | 60e4eb203d | |
Alicia Bot | 7a3ba9acf3 | |
Alicia Bot | 4e7fc904f6 | |
liss-bot | 812ad0c996 | |
Alicia Sykes | 56bd835ccc | |
Sacha FROMENT | 5adf9efa17 | |
dependabot[bot] | c231270b05 | |
Alicia Sykes | 974c11627d | |
Max Kulik | 9b570fa853 | |
dependabot[bot] | 362d093962 | |
5idereal | f67940fcf8 | |
repo-visualizer | 23053ab1e7 | |
Alicia Bot | 220eacb41c | |
Alicia Bot | a7c4572282 | |
liss-bot | d75da81d24 | |
snyk-bot | 7990401be6 | |
Alicia Sykes | 466d99f0de | |
Denis Savosin | e888adb1c7 | |
Eduardo Gomez | 7d3ea067b5 | |
Denis Savosin | 84454b0502 | |
kt-alt | d50c9731e8 | |
Alicia Sykes | 8a821c2a31 | |
kt-alt | cf57efb8b1 | |
repo-visualizer | 4c906210a0 | |
Alicia Bot | 77313bcf9a | |
Alicia Bot | f5513dd14b | |
liss-bot | e57ec7d21e | |
liss-bot | f55a75e84b | |
Nicholas Malcolm | 9bbd8f4ae4 | |
Alicia Sykes | 923c3c4fc5 | |
rokiden | dec5a0820a | |
repo-visualizer | 388f482d25 | |
Alicia Bot | 1876e914f8 | |
liss-bot | 102992df3b | |
liss-bot | 2388955441 | |
repo-visualizer | 4c75ce6bc4 | |
Alicia Bot | 8c5bde658c | |
Alicia Bot | 307dbed137 | |
liss-bot | 88f09c4885 | |
Alicia Sykes | 99bf9bca4a | |
repo-visualizer | 9cff2cadd0 | |
Alicia Bot | fb3edd66e3 | |
Alicia Bot | d3b6af7035 | |
rokiden | 00bc03f257 | |
repo-visualizer | edeeb74c6c | |
Alicia Bot | 20100b5e54 | |
Alicia Bot | 77c62555d8 | |
Alicia Sykes | 879effb1cc | |
repo-visualizer | dd221d7c23 | |
Alicia Bot | 005bb1d2a1 | |
Alicia Bot | 2aeee1cc9c | |
liss-bot | 2d2857d3de | |
Alicia Sykes | c3542693d7 | |
Harald Töpfer | ab450a13e4 | |
repo-visualizer | 1b99b5e3b6 | |
Alicia Bot | e3d47070c1 | |
Alicia Bot | 0e3aa0aca4 | |
liss-bot | a8cd6138e6 | |
liss-bot | 9d91e33f65 | |
Alicia Sykes | 4786020741 | |
Alicia Sykes | 344a109166 | |
repo-visualizer | 943b27e6f5 | |
Alicia Bot | 986b2d79f6 | |
Alicia Bot | 5ddcfd3722 | |
liss-bot | d0fe47ebf9 | |
liss-bot | ab2ea32fb6 | |
allozavrr | 3a32cc4341 | |
Alicia Sykes | 3e1e42da5f | |
wozboz | a75afcec0f | |
wozboz | 225f69cdb3 | |
repo-visualizer | 766962943b | |
Alicia Bot | cf0c269bec | |
Alicia Bot | a03f94fd25 | |
liss-bot | 59f3b75f4f | |
liss-bot | d9773c9c36 | |
Alicia Sykes | d4126baa88 | |
Alicia Sykes | c45e05866d | |
Alicia Sykes | 39ab92deaa | |
repo-visualizer | 31f3b2bf57 | |
Alicia Bot | ae83e6049b | |
Alicia Bot | e8dbe4c143 | |
liss-bot | e191b275cf | |
liss-bot | 3f42982441 | |
wozboz | be0f51d46a | |
wozboz | f7a0fb24a9 | |
Alicia Sykes | ce4e71b4da | |
zcq100 | 274ec7fffe | |
repo-visualizer | c6f01c2aa3 | |
Alicia Bot | be817a29f9 | |
liss-bot | 7124b4f16a | |
liss-bot | 86debd7588 | |
Shawn Salat | c0285d410e | |
repo-visualizer | 544f031b10 | |
Alicia Bot | c774e81e0a | |
liss-bot | cd5d096479 | |
liss-bot | d0fa998502 | |
repo-visualizer | be5e2cd217 | |
Alicia Bot | 66e6b1a5f2 | |
Alicia Bot | 7670fe17ea | |
liss-bot | f4dbbbda67 | |
repo-visualizer | e341d5f02f | |
Alicia Bot | aeb77c9770 | |
Alicia Bot | ce250d0c48 | |
liss-bot | c5e4bb9a7f | |
Alicia Sykes | 1b583c3f76 | |
Alicia Sykes | c901288eb1 | |
Alicia Sykes | 1fd7e6b15c | |
Alicia Sykes | 3c25fb8494 | |
repo-visualizer | c7309d4a38 | |
Alicia Bot | 2e5eb191f2 | |
Alicia Bot | 69990d432f | |
liss-bot | 3b034c1ac5 | |
Alicia Sykes | c0b6eee89a | |
Ethan Hann | 02565d3ef6 | |
repo-visualizer | ddab65e44a | |
Alicia Bot | fbd80725cf | |
Berk Sümbül | ab83cf4d22 | |
Berk Sümbül | 06532391e7 | |
Berk Sümbül | 55cd1324c0 | |
Alicia Bot | bd7c8c2754 | |
Julian | 54b0a05493 | |
repo-visualizer | ea04247be0 | |
Alicia Bot | 268299b95c | |
Alicia Sykes | 4813d49e42 | |
Alicia Sykes | 51a9b4bfbe | |
Alicia Sykes | d469672527 | |
repo-visualizer | d96297e0f8 | |
Alicia Bot | 22e6a5c266 | |
Alicia Bot | 579b65a969 | |
liss-bot | e0b5818a88 | |
liss-bot | aff8394325 | |
Alicia Sykes | ece9548b59 | |
Alicia Sykes | 81c612995e | |
Alicia Sykes | d221844f2f | |
Alicia Sykes | d718905779 | |
Alicia Sykes | 067076f1d4 | |
Andreas Violaris | 8e9aec080a | |
Andreas Violaris | de33ac2a72 | |
Andreas Violaris | 5977c92235 | |
Andreas Violaris | c50ae1392f | |
Chris Nielsen | 03ae38577e | |
Chris Nielsen | f46bcc2edd | |
Chris Nielsen | 7280820ba5 | |
Chris Nielsen | 1e2854df93 | |
Alicia Sykes | 020e0ba472 | |
Alicia Sykes | 2324755e0e | |
root | e1d4adb2ed | |
Alicia Sykes | fdd936931e | |
Alicia Sykes | f1d3547399 | |
repo-visualizer | f4c82be988 | |
Alicia Bot | fccb0dd890 | |
root | b7d7927b7c | |
repo-visualizer | ff5b2d5082 | |
Alicia Bot | 58a374ce6e | |
Alicia Bot | 086b98b86f | |
liss-bot | ed0a8bbecf | |
liss-bot | cdd36571b6 | |
Josua Blejeru | 040b472a05 | |
Josua Blejeru | 2d77a155d5 | |
Josua Blejeru | 7e1057d059 | |
Josua Blejeru | 503d662065 | |
Josua Blejeru | 098600365a | |
Josua Blejeru | cfdd4a13e8 | |
Josua Blejeru | c1512012f9 | |
Bhasher | c418b7b7ae | |
Josua Blejeru | 1a42a41a53 | |
repo-visualizer | 09e61a5fa4 | |
Alicia Bot | f91e46369f | |
Alicia Bot | f841e9c33a | |
liss-bot | 755a4a328b | |
liss-bot | fa41239bb2 | |
Alicia Sykes | 68d47c25d2 | |
Alicia Sykes | 79bbc3785a | |
Alicia Sykes | 2ec404121a | |
Alicia Sykes | 9c73bb91b9 | |
repo-visualizer | 56fd803f93 | |
Alicia Bot | 8e41778a38 | |
Alicia Bot | caac4a3ffa | |
liss-bot | 0738eb14c8 | |
liss-bot | 744272eaff | |
Chris Nielsen | e3360349bb | |
huangshaohuai | b615833b5f | |
baifengheixi | 7feb4f7da6 | |
repo-visualizer | c71476d4e8 | |
Alicia Bot | 5275f21374 | |
liss-bot | e5141a64d8 | |
liss-bot | b31ebae953 | |
Alicia Sykes | 9a416a4653 | |
Alicia Sykes | bc9e193a7d | |
Garrett Brown | d22b8de524 | |
ssrangisetti | 3f3ffac63b | |
ssrangisetti | 13775b3f57 | |
repo-visualizer | 62ce3bfe5d | |
Alicia Bot | da2f0eeaca | |
Alicia Bot | 40e3c169b7 | |
liss-bot | e3467a7740 | |
liss-bot | 45486a97e6 | |
Alicia Sykes | 2c3ed81e35 | |
Alicia Sykes | 600eacedeb | |
Alicia Sykes | ba47fb767d | |
Alicia Sykes | 5aea6be90c | |
hockeymikey | 7466ae6c9e | |
hockeymikey | 7cb6db93f4 | |
repo-visualizer | 8ca21edd22 | |
Alicia Bot | 0805d9ce43 | |
Alicia Bot | cecde20ee6 | |
liss-bot | 3e264bf131 | |
liss-bot | 96bef092f4 | |
repo-visualizer | 62b0e6b702 | |
Alicia Bot | e8762d5e56 | |
repo-visualizer | fd31a66d06 | |
Alicia Bot | 6860f132e9 | |
Alicia Bot | d7802a279a | |
liss-bot | 2214c0c63d | |
liss-bot | c088a0cbc3 | |
Alicia Sykes | c8653e525e | |
Luis Pabon | df5ada9340 | |
repo-visualizer | 9c90814dff | |
Alicia Bot | e26671f86e | |
repo-visualizer | f7face1c79 | |
Alicia Bot | cf0bdd8a5a | |
Alicia Bot | cd61df97bf | |
liss-bot | 8864604e78 | |
Alicia Sykes | 45e06d2e66 | |
Alicia Sykes | 27b835258c | |
Alicia Bot | bb6b980f66 | |
Alicia Bot | 992ea92235 | |
liss-bot | 0727ae4a93 | |
liss-bot | 04ce19d785 | |
poisonadder7 | cfc7c29147 | |
repo-visualizer | baf9b5a66e | |
Alicia Bot | abe73f2fca | |
liss-bot | ad4d4c2386 | |
liss-bot | e6223a4cfa | |
Alicia Sykes | 0cc8935b5f | |
EVOTk | 1d419a50ac | |
EVOTk | a1ac11e66a | |
repo-visualizer | 50baed7d01 | |
Alicia Bot | 2be9ecc02a | |
Alicia Bot | 854efe9de5 | |
Alicia Sykes | 8fbf769a62 | |
Alicia Sykes | 8798dcf5e3 | |
Alicia Sykes | 0d8d7fc28c | |
Alicia Sykes | 6651333253 | |
Alicia Sykes | 794fa57956 | |
Alicia Sykes | a6e685b5e1 | |
Alicia Sykes | 4f0af68c5f | |
Alicia Sykes | 3e35b56414 | |
Alicia Sykes | d5b70c1d94 | |
Alicia Sykes | 4fc3abf511 | |
Alicia Sykes | 743232e597 | |
Alicia Sykes | c3749c6837 | |
repo-visualizer | e48f8418b9 | |
Alicia Bot | ed4898d761 | |
Alicia Bot | 34449481a1 | |
liss-bot | bf73117a9f | |
liss-bot | be7fe22b42 | |
Alicia Sykes | 0319b8b1ed | |
Alicia Sykes | b4496fb910 | |
Alicia Sykes | 386e688762 | |
Alicia Sykes | 896b7093f3 | |
Alicia Sykes | f8c74e6b65 | |
Alicia Sykes | 422be768a0 | |
Alicia Sykes | fed55a01d3 | |
zcq100 | 5d8c01d14b | |
Alicia Sykes | 2e053064d3 | |
Alicia Sykes | 7200d87d6a | |
Alicia Sykes | 70a6cc6b64 | |
Alicia Sykes | 940879a7a7 | |
Alicia Sykes | 387d9ee5c3 | |
Alicia Sykes | 08e5e5b48e | |
Alicia Sykes | b18895b227 | |
repo-visualizer | 64d61fc894 | |
Alicia Bot | c17f92a549 | |
Alicia Bot | e4f9d617e3 | |
liss-bot | 5e86db0a3c | |
Alicia Sykes | 2f0e74d140 | |
Matthias Bilger | 281f173d14 | |
soaibsafi | 992f2bd2d7 | |
Matthias Bilger | 27e7ae3547 | |
Alicia Sykes | f7d1eefdff | |
Alicia Sykes | ba6fa376a5 | |
snyk-bot | 981be1ca04 | |
repo-visualizer | bdf274d8e1 | |
Alicia Bot | 405085edee | |
Alicia Bot | 143a7a7971 | |
liss-bot | c70fc83cb2 | |
liss-bot | 94162881df | |
Marcell Fülöp | 99fa9bcc32 | |
Marcell Fülöp | d9740427eb | |
Marcell Fülöp | 3e7b51da33 | |
repo-visualizer | 354fc99af5 | |
Alicia Bot | 9f8da93de3 | |
Alicia Bot | 53633a2bfd | |
liss-bot | 7cea06f362 | |
Alicia Sykes | dc8e651fb9 | |
Alicia Sykes | b177b7d855 | |
Alicia Sykes | 2772f8fda6 | |
Alexander Mnich | f17cbc381d | |
Alicia Sykes | 7080e3c980 | |
Alicia Sykes | 221aeb5441 | |
Alicia Sykes | 4d5a79fec9 | |
repo-visualizer | d44b0c7a6a | |
Alicia Bot | fd232f4ab6 | |
liss-bot | f774481fbf | |
liss-bot | d68a03bcf1 | |
Sergio | c7c4df7a55 | |
liss-bot | 8fbffd31bd | |
liss-bot | 61d2562e21 | |
Alicia Bot | 10828bf2da | |
Alicia Bot | cbde5743c3 | |
Alicia Sykes | f731c0f755 | |
Mert Sefa AKGUN | 382f823e53 | |
Alicia Sykes | adf56fa334 | |
Alberto | 8ef419b767 | |
Alberto Caravaca | f3c854378c | |
Matthias Bilger | c50773e727 | |
Alicia Sykes | 18c2af774d | |
Matthias Bilger | 59118a54dd | |
Alicia Sykes | a91a283f1b | |
Matthias Bilger | 75b06f8af8 | |
Matthias Bilger | 1e84f51825 | |
Matthias Bilger | 4cb3332e3e | |
repo-visualizer | 39a55333a9 | |
Alicia Bot | 8d8dc81793 | |
Alicia Bot | 6d63ed8441 | |
liss-bot | 53cd128395 | |
liss-bot | 9f0c6af5b4 | |
Alicia Sykes | b388adcaec | |
Alicia Sykes | ddd7c0f4be | |
rtm516 | 3c5177dd70 | |
rtm516 | 37f0a669fd | |
Alberto Caravaca | 1ba01ba5f3 | |
Alberto Caravaca | 0d9689883c | |
Alicia Sykes | 4a5024ce26 | |
Alberto Caravaca | c867a90919 | |
Alberto Caravaca | 5cfc9b1bd8 | |
kxenox | 678e7119f8 | |
itsmejoeeey | 12eadccfda | |
itsmejoeeey | 8ec5f30a5d | |
Alicia Bot | c957ab6cfe | |
Alicia Bot | 53e33dded3 | |
BySempron | 728eb0256e | |
Matthias Bilger | b404bb09be | |
Matthias Bilger | db8abb2831 | |
Matthias Bilger | 0948a3f845 | |
Matthias Bilger | 120c351f40 | |
Matthias Bilger | f43966fdb0 | |
Matthias Bilger | f14eaf5f0b | |
Matthias Bilger | 97ccdd44b2 | |
repo-visualizer | f11e6bfd44 | |
Alicia Bot | 785976e055 | |
Alicia Bot | ae160050be | |
liss-bot | 0fd28a132f | |
liss-bot | 3df6453e61 | |
DimitriDR | f214667f51 | |
Alicia Sykes | a5f3c20810 | |
Alicia Sykes | 0fc664fb08 | |
Matthias Bilger | f0a5c249b0 | |
DimitriDR | d3ced73cf3 | |
DimitriDR | 6b376f1dad | |
Matthias Bilger | d4528a1afe | |
DimitriDR | 3016128cbc | |
Matthias Bilger | 8e5c378386 | |
Matthias Bilger | 71510eeb93 | |
Matthias Bilger | 9a70d1cd8d | |
Alicia Sykes | 9ab6c59f19 | |
Alicia Sykes | 15d7e9936d | |
Alicia Sykes | f4f2c5f134 | |
repo-visualizer | 7841955bc5 | |
Alicia Bot | 1b0265c09a | |
liss-bot | fca21c6597 | |
liss-bot | 8fa4be9e1b | |
Alexander Mnich | 02713110b4 | |
Dylan-Bs | db017c0888 | |
Kieran Eglin | da3b5bc4b7 | |
repo-visualizer | 2f3cc1c354 | |
Alicia Bot | 8cd2e757f6 | |
Alicia Sykes | bf60719035 | |
Alicia Sykes | a5baede11c | |
Tuzi555 | 15a09cd83b | |
Tuzi555 | 94247c3c04 | |
Tuzi555 | 9682446b95 | |
repo-visualizer | 92d12915de | |
Alicia Bot | aea271a61c | |
Alicia Bot | 805a8bcea1 | |
liss-bot | cb0bc80dd1 | |
liss-bot | 857886ab76 | |
repo-visualizer | 8e71ee73e8 | |
Alicia Bot | 6071ca5b1b | |
Alicia Bot | 34b6637b74 | |
liss-bot | e5104a11d9 | |
liss-bot | 92aa9643d8 | |
Alicia Sykes | 5711790b1a | |
Alicia Sykes | 94ce53f80b | |
Alicia Sykes | bb8419f077 | |
Alicia Sykes | f00132d4a3 | |
Alicia Sykes | 71291c1ce9 | |
repo-visualizer | 286131bec9 | |
Alicia Bot | e7423c03ea | |
Alicia Bot | 1141f5f2d7 | |
liss-bot | 01bf72c0f2 | |
liss-bot | 8c9987b090 | |
snyk-bot | e01165ade5 | |
Alicia Sykes | 6ee0097152 | |
Alicia Sykes | 3f81acd47e | |
Alicia Sykes | 8a6ffce179 | |
jrobles98 | 6f1320449d | |
repo-visualizer | 049bcb1786 | |
Alicia Bot | 7f7feb4bfa | |
Alicia Bot | 1dc37a10b6 | |
liss-bot | b79f9ade41 | |
Alicia Sykes | 475a9a1469 | |
Totto16 | 74370ac557 | |
Alicia Sykes | 77aee8b0ee | |
Totto16 | 96684f57c8 | |
Totto16 | becb50dc58 | |
Totto16 | 49334ae3c1 | |
repo-visualizer | 5d5dd0a50e | |
Alicia Bot | 80784d8d8f | |
Alicia Bot | 559adbb458 | |
liss-bot | 331004c18a | |
liss-bot | e08e1642b6 | |
repo-visualizer | 17ab10bc92 | |
Alicia Bot | c7d2ec8dfe | |
liss-bot | aaf690c05d | |
liss-bot | bb137fd93f | |
Alicia Sykes | 8a55fc3bf2 | |
repo-visualizer | 23e4b8b859 | |
Alicia Bot | 36679b4b1b | |
Alicia Bot | 7d3bb8f9ce | |
liss-bot | ccb184e033 | |
liss-bot | c19bdbf1b9 | |
Alicia Sykes | e8b30b9c25 | |
Alicia Sykes | 0eca672c68 | |
Alicia Sykes | 4d3a25c1bd | |
Alicia Sykes | 9f07ba0843 | |
Alicia Sykes | 3cde47c7b7 | |
Alicia Sykes | d7d5c0291c | |
repo-visualizer | 71c4936be4 | |
Alicia Bot | a903bebc14 | |
liss-bot | 0f342629e8 | |
Alicia Sykes | 20e513a1a5 | |
Alicia Sykes | 43c2dfc3d4 | |
Thomas Dissert | 5d11c58ac4 | |
Thomas Dissert | b658d94adc | |
snyk-bot | 79cc7cb06e | |
Alicia Sykes | ba3ce9cb9d | |
Magnus Sundström | 98bc738c55 | |
Magnus Sundström | c25572612e | |
repo-visualizer | b498d8d0d5 | |
Alicia Bot | 436f84f657 | |
Alicia Bot | b5ae84340b | |
liss-bot | ad07ba9fc4 | |
Alicia Sykes | c05d80bb6f | |
Dawid Pietrykowski | 6be5917ced | |
Magnus Sundström | c8de78adf0 | |
Magnus Sundström | 9b2e8bfbc5 | |
repo-visualizer | d60152b719 | |
Alicia Bot | 48a100f65c | |
liss-bot | 21f51b1054 | |
liss-bot | 271b79db3f | |
Magnus Sundström | 91f862836d | |
Magnus Sundström | 19b478617f | |
Bumsoo Kim | 9e013a7a95 | |
Alicia Sykes | 29eb5d8545 | |
repo-visualizer | 502af5b651 | |
Alicia Bot | f1a3721a5f | |
rtm516 | b48a341cdd | |
repo-visualizer | 29814a9fec | |
Alicia Bot | 21061e982f | |
Desmond Kyeremeh | fe6989cab4 | |
Alicia Sykes | c0836acc5e | |
repo-visualizer | 2ee9534b59 | |
Alicia Bot | f8271b26eb | |
Alicia Bot | d34aae35a2 | |
liss-bot | 02842e6c75 | |
liss-bot | 5ac0a6bcf5 | |
Alicia Sykes | 723da99d58 | |
Alicia Sykes | e1d9f85aa0 | |
Alicia Bot | 49954b9f08 | |
Alicia Bot | a8714a1a02 | |
liss-bot | 1992111a48 | |
liss-bot | 7d0d97148e | |
repo-visualizer | 49f8199764 | |
kristian | 6c3e45c362 | |
kristian | 6d644f5459 | |
Alicia Sykes | 4a90a9de65 | |
Alicia Sykes | 5f96b6ccf8 | |
Alicia Sykes | c0677c46ea | |
Alicia Sykes | 933fb9c4d7 | |
Ángel Fernández Sánchez | b4b298e959 | |
kristian | 46420d4f15 | |
kristian | 5a3fbe5672 | |
repo-visualizer | ef59eb25f4 | |
Alicia Bot | 50b05d845b | |
Alicia Bot | 0c68e90da5 | |
liss-bot | 53060d875b | |
liss-bot | 2b8735897b | |
Smexhy | ae2e741f6e | |
Alicia Sykes | 32c857504f | |
Alicia Sykes | edf71fd0ad | |
Alicia Sykes | b965989a98 | |
Alicia Sykes | e2fb5fcaf5 | |
Alicia Sykes | 1046b44c99 | |
Alicia Sykes | 89a06afe1a | |
kristian | a9adddc0ce | |
sur1v | 60d0b0329d | |
kristian | 9c15314af8 | |
Alicia Sykes | 8d300d42a4 | |
Alicia Sykes | 6fcb31f12a | |
Alicia Sykes | 86b56f6b48 | |
Alicia Sykes | 830a0f3229 | |
Maxime Moreillon | d268ca2f91 | |
repo-visualizer | ba879dc2d7 | |
Alicia Bot | 7f51ddf302 | |
liss-bot | e724d329c9 | |
liss-bot | fe37188eac | |
imlonghao | a393da96ce | |
repo-visualizer | 9cfc1e3e8b | |
Alicia Bot | 105612bb4a | |
Alicia Bot | c3efcb7b8d | |
liss-bot | 04d824719f | |
liss-bot | 47a54a5d0f | |
cauterize | 38ad08a101 | |
cauterize | 813c475a9c | |
Ian Neal | ae8a050337 | |
Artyom | 8346d393ce | |
laker j.v | 3868f427f5 | |
Alicia Sykes | 2db398c8b0 | |
David Alasow | 2bf51cd03d | |
David Alasow | ca8085c482 | |
David Alasow | 2d731d3ed3 | |
David Alasow | 99463413b1 | |
repo-visualizer | bb1e6fa7c9 | |
Alicia Bot | 66cb6486a7 | |
liss-bot | 714834f1b3 | |
liss-bot | 34c337a8e5 | |
Rúben Silva | bb3492c5f2 | |
Alicia Sykes | cdf1bb9529 | |
Alicia Sykes | 0de29d013c | |
Bjorn Lammers | 71e6cf0f3d | |
Alicia Sykes | 8f893c36d7 | |
repo-visualizer | ba1fd77509 | |
Alicia Bot | 1290f9057d | |
liss-bot | 9360b34b20 | |
liss-bot | 0830615281 | |
Alicia Bot | 12b3331b17 | |
Alicia Sykes | 99892835d1 | |
repo-visualizer | 6affa43625 | |
Alicia Bot | 3d3c028b7f | |
liss-bot | 18361c3f28 | |
liss-bot | 3c525f22e2 | |
Alicia Sykes | c9cd395313 | |
Alicia Sykes | 18f6e4d268 | |
Alicia Sykes | 07a81eb075 | |
Michael | 623d4d76ad | |
Alicia Sykes | 0523c1933e | |
Alicia Sykes | 89cf918b9f | |
repo-visualizer | 60a1242c42 | |
Alicia Bot | 4cec2ab193 | |
Alicia Bot | d343f2deec | |
liss-bot | 2b23e8af41 | |
liss-bot | 30147cf886 | |
Alicia Sykes | 8eb08143be | |
Alicia Sykes | 81073c4c45 | |
Prince Carl Velasco | 79fe84d732 | |
Alicia Sykes | b0c52b53c9 | |
Alicia Sykes | d25de1147c | |
repo-visualizer | 69dded5e58 | |
Alicia Bot | 341dbe0a5e | |
Alicia Bot | 76a89bacef | |
liss-bot | 5eff45f851 | |
liss-bot | f95cfb4e63 | |
Alicia Sykes | 8588ba5772 | |
Alicia Sykes | 311a1607f8 | |
Alicia Sykes | ac9d585a17 | |
Alicia Sykes | 37954eaeb0 | |
Alicia Sykes | ad9df7a67c | |
Alicia Sykes | fc09c1d73d | |
Alicia Sykes | 57be9d20e2 | |
Alicia Sykes | b025fdfb58 | |
snyk-bot | 4705bedc2d | |
Alicia Sykes | efa49a5b25 | |
Alicia Sykes | e663fb7639 | |
Jammo2k5 | 4b5dc05c28 | |
Jammo2k5 | 19e312b777 | |
Jammo2k5 | 53e3082dc2 | |
Jammo2k5 | bbfe9a9def | |
Jammo2k5 | 74fc7419da | |
Jammo2k5 | 8d22d88471 | |
Alicia Sykes | 88568e8435 | |
Alicia Sykes | 55bde6c78a | |
Alicia Sykes | bb01612f1a | |
Alicia Sykes | b2ab89ad5a | |
repo-visualizer | 3402f122db | |
Alicia Bot | feee716d59 | |
liss-bot | 38d317c505 | |
liss-bot | 409aaf6f10 | |
Alicia Sykes | deb055b9bc | |
Alicia Sykes | 6be38b9f58 | |
Alicia Sykes | e9ff44ac91 | |
snyk-bot | 5bedc6fbac | |
Alicia Sykes | f3bdcef019 | |
Alucarddelta | 6c2a707287 | |
Alucarddelta | 8d33d91362 | |
Alucarddelta | b10a88b022 | |
repo-visualizer | 963fe5d3f8 | |
Alicia Bot | abf3af4b47 | |
liss-bot | 4c19b1a873 | |
liss-bot | bb1b8d2d9e | |
Alicia Sykes | cb74ce9c77 | |
Jyotirmoy Bandyopadhayaya | 19ed765a82 | |
Alicia Sykes | 6ba7d6d918 | |
Alicia Sykes | bd759d63fd | |
flechaig | b4db66f339 | |
Alicia Sykes | 6f7c89deeb | |
Steffen Schmidt | dfc3b5aa8b | |
repo-visualizer | 773e1076bf | |
Alicia Bot | 7f8d78c52b | |
Alicia Bot | 97ee994b37 | |
liss-bot | 6bd3a094df | |
liss-bot | 4967719a58 | |
Alicia Sykes | be5a573185 | |
Alicia Sykes | edc6f19ab7 | |
Lissy93 | 43239586a6 | |
Lissy93 | 869a5993e8 | |
Lissy93 | eff49995b9 | |
Lissy93 | 4210c985b7 | |
Alicia Sykes | 113f31a93a | |
Alicia Sykes | 338fbbfc56 | |
Alicia Sykes | 263c5f2c36 | |
Alicia Sykes | 4d38f71c9f | |
Alicia Sykes | eba0c41287 | |
Alicia Sykes | d9884e64e8 | |
Alicia Sykes | cc0287d129 | |
Alicia Sykes | 6dfec528af | |
Alicia Sykes | cc80e6812c | |
Alicia Sykes | ebf9c1f91a | |
Alicia Sykes | a2442c7349 | |
Alicia Sykes | 7e861b71ae | |
Alicia Sykes | 685c949421 | |
Alicia Sykes | 9235123f10 | |
Alicia Sykes | 2daabed9dd | |
Alicia Sykes | 7ab32858e2 | |
Alicia Sykes | b876fa10af | |
Marcell Fülöp | 736f0e95ed | |
Doug Lock | 4b65fedfe4 | |
Alicia Bot | f9195ac33a | |
Alicia Bot | 5c81d53606 | |
repo-visualizer | cb80dd195c | |
Alicia Sykes | 138ea8bd01 | |
Alicia Sykes | 51f6e30026 | |
Marcell Fülöp | 91d4fd55c0 | |
Alicia Sykes | a3a26ce063 | |
patrickheeney | 542a9fe9bd | |
Alicia Sykes | a877ff2f8e | |
patrickheeney | 4c87092be5 | |
Alicia Sykes | 90163dd612 | |
Alicia Sykes | 7bb66953d1 | |
Marcell Fülöp | 2933df20dd | |
Alicia Sykes | 4172512e88 | |
Marcell Fülöp | f21f44ce21 | |
Alicia Sykes | 0674ad8fe8 | |
k073l | 45900da025 | |
k073l | bbb0f16ead | |
Alicia Sykes | dbb261c859 | |
Marcell Fülöp | c9cd8da2d9 | |
Marcell Fülöp | 2ee853d33f | |
Marcell Fülöp | f00b76299d | |
Marcell Fülöp | 278a6fc7b7 | |
Marcell Fülöp | 7d8d3078b2 | |
Marcell Fülöp | ee46f2a33e | |
Marcell Fülöp | 168fe94391 | |
Alicia Sykes | 6443d5b6c0 | |
Markus Krause | 6cddee4f8c | |
Marcell Fülöp | 3ac0585c5c | |
Marcell Fülöp | cf25dbce4a | |
Marcell Fülöp | 991cf0bf5a | |
Marcell Fülöp | db0fc0454d | |
Marcell Fülöp | 4b930939c7 | |
Marcell Fülöp | 4c015bb25d | |
Marcell Fülöp | e76f552830 | |
Marcell Fülöp | 821af62426 | |
repo-visualizer | 10bfacb492 | |
Alicia Bot | 752a00bbb3 | |
Alicia Bot | 3ef80fc132 | |
liss-bot | 8c416bde24 | |
liss-bot | 192312e11f | |
Marcell Fülöp | a43988f3cd | |
repo-visualizer | ab83d124bd | |
Alicia Bot | ec6207d4e0 | |
Alicia Bot | 28f667ba74 | |
liss-bot | 0d71fd818c | |
liss-bot | 07bf39af45 | |
Marcell Fülöp | caf131df23 | |
Marcell Fülöp | ff1bcdbab8 | |
Marcell Fülöp | 0bf6fee180 | |
Alicia Sykes | 9786c8b554 | |
Alicia Sykes | e24fa10f0f | |
Alicia Sykes | da72f680b3 | |
Alicia Sykes | b10b587442 | |
Alicia Sykes | 330d812bfd | |
Alicia Sykes | 2ef5b66e9e | |
Alicia Sykes | 9faab35a57 | |
Marcell Fülöp | 2d6c499192 | |
Alicia Sykes | ee27dc8a1a | |
Alicia Sykes | 41fd411769 | |
bogyeong | 8a703cf434 | |
bogyeong | 814a8a73c3 | |
bogyeong | e51464cf01 | |
Alicia Sykes | 1114f7d243 | |
pablomalo | aad252e3d4 | |
snyk-bot | 97b25080e0 | |
Alicia Sykes | 1777a00bc5 | |
zcq100 | 9085c105b8 | |
repo-visualizer | fdfe9cd3a0 | |
Alicia Bot | f91e232a2b | |
Alicia Bot | 43f26f51c5 | |
liss-bot | f6a42fa44a | |
liss-bot | b720f59e8e | |
Alicia Sykes | b98b85dd50 | |
Alicia Sykes | e451f86e3e | |
Alicia Sykes | 9575090d5c | |
Alicia Sykes | 36eccc2c64 | |
Alicia Sykes | 86f08926b6 | |
Alicia Sykes | 6ad582b469 | |
Alicia Sykes | ac97be20be | |
Alicia Sykes | 972e3f7571 | |
Alicia Sykes | 1ad89958bc | |
Alicia Sykes | 5c896fded5 | |
Alicia Sykes | c823a2e9bd | |
Alicia Sykes | f7bba8068a | |
Alicia Sykes | b931d4e6cd | |
Alicia Sykes | 577de74ac4 | |
Alicia Sykes | dcd72e7763 | |
Alicia Sykes | 1c252cc76d | |
Alicia Sykes | 072ebbd68a | |
Alicia Sykes | 3a65d12e67 | |
Alicia Sykes | 7b99e9092b | |
Alicia Sykes | b974b68852 | |
Alicia Sykes | 51abcf0f17 | |
Alicia Sykes | 218a76d953 | |
Alicia Sykes | d0721cef61 | |
Alicia Sykes | 83dcc37985 | |
Alicia Sykes | fea51a1a75 | |
Alicia Sykes | c8acd6e1bc | |
Alicia Sykes | 659d85036b | |
M Asenov | 0ca5540372 | |
Alicia Sykes | ef786dbb7c | |
Alejandro Pinar Ruiz | 48a367fb25 | |
Alicia Sykes | d470f5b813 | |
Alejandro Pinar Ruiz | d57138d6f8 | |
Alejandro Pinar Ruiz | 8650b8cfb0 | |
Alejandro Pinar Ruiz | d0e25dfb52 | |
Alejandro Pinar Ruiz | f4709195c6 | |
Alejandro Pinar Ruiz | 82b2543d9c | |
Alejandro Pinar Ruiz | 994435677c | |
Alejandro Pinar Ruiz | dfd3aabd27 | |
Alejandro Pinar Ruiz | f13d252443 | |
Alejandro Pinar Ruiz | d1706689a5 | |
Alejandro Pinar Ruiz | 3bc80cfaad | |
Alejandro Pinar Ruiz | cd72ff06ec | |
Alejandro Pinar Ruiz | c33e03f4f5 | |
Alejandro Pinar Ruiz | 04774c23ed | |
Alejandro Pinar Ruiz | 18776bd8cb | |
Alicia Sykes | 052fcfa7ef | |
Alicia Sykes | cf002116f8 | |
Alicia Sykes | 5c45f4fbc6 | |
Alicia Sykes | 2df49eb853 | |
Alicia Sykes | 9a0afd7c99 | |
Alicia Sykes | 76f22b032d | |
Alicia Sykes | 59505a0d42 | |
Alicia Sykes | 53292f28fb | |
Alicia Sykes | b5e5b566fc | |
Alicia Sykes | 226d958b08 | |
Alicia Sykes | 8af15f606d | |
Alicia Sykes | 86435fc7d6 | |
Alicia Sykes | 97b18e7488 | |
dr460nf1r3 | ce0a674fbf | |
Alicia Sykes | 71f87159a4 | |
Alicia Sykes | c4d48d64a4 | |
repo-visualizer | 30572c0ceb | |
Alicia Bot | 5826817ef6 | |
Alicia Bot | b3b069942b | |
liss-bot | f679da278c | |
liss-bot | 1c53cd9b7d | |
Alicia Sykes | 73935ed4bb | |
Alicia Sykes | afdd342533 | |
Alicia Sykes | c81e6c69d3 | |
Alicia Sykes | 1778498e36 | |
Alicia Sykes | bc43caaf96 | |
Alicia Sykes | c520d8314f | |
Alicia Sykes | 2d49f1cda4 | |
Alicia Sykes | c8010f50a7 | |
Alicia Sykes | 5ecf86600a | |
Alejandro Pinar Ruiz | 87d66ae847 | |
repo-visualizer | 5b9a273838 | |
Alicia Bot | ff57a9aac2 | |
Alicia Bot | a16a96045c | |
liss-bot | 3a095778a4 | |
liss-bot | a0052a9524 | |
Alicia Sykes | ec39a8bce5 | |
PlusaN | f700f31904 | |
Alicia Sykes | ac72ad243e | |
Alicia Sykes | 78bed0fb92 | |
Alicia Sykes | 6d2e37d007 | |
Alicia Sykes | 6ed5cd5b53 | |
Alicia Sykes | 8b5a6054d6 | |
Alicia Sykes | abc102df9f | |
Alicia Sykes | 00b872e671 | |
Alicia Sykes | 7e547e7463 | |
Alicia Sykes | 0ed084c147 | |
Alicia Sykes | 0d66e54b59 | |
Alicia Sykes | 16acf36528 | |
Alicia Sykes | 4f04e01aec | |
Alicia Sykes | e2b9c15360 | |
Alicia Sykes | 333ee83890 | |
Alicia Sykes | 8c43442b39 | |
Alicia Sykes | 19b71313d5 | |
Alicia Sykes | c04e80b44e | |
Alicia Sykes | 75eef87691 | |
Alicia Sykes | 3b2ea020fa | |
Alicia Sykes | 33a2693c7f | |
Alicia Sykes | 9eda048842 | |
repo-visualizer | 545f645e9f | |
Alicia Bot | 7905b9c2e3 | |
Alicia Bot | cde8388ace | |
liss-bot | bad0b697fd | |
liss-bot | 4ca916014d | |
Alicia Sykes | e456249515 | |
Jemy SCHNEPP | 8c84f2aaf8 | |
Alicia Sykes | 2fe0110762 | |
Alicia Sykes | 3417b46eee | |
Alicia Sykes | 9b33a6e277 | |
Alicia Sykes | 24e487cde5 | |
Alicia Sykes | 064c64465e | |
Alicia Sykes | 7b39bde573 | |
Alicia Sykes | 4287092ea2 | |
Alicia Sykes | bcb1b70447 | |
Alicia Sykes | 4e0959feff | |
stanly0726 | 3fd62e0f48 | |
stanly0726 | afa3b55061 | |
stanly0726 | 0b320bc38d | |
repo-visualizer | 9a2c65d58d | |
Alicia Bot | 15337a0b19 | |
Alicia Bot | 4f3a22106a | |
liss-bot | 5f9e644783 | |
Alicia Sykes | 6ec0bd20a1 | |
Alicia Sykes | 7165a9a913 | |
Alicia Sykes | af5a26b0da | |
Alicia Sykes | decd3be6b0 | |
Alicia Sykes | 40d1236b2d | |
Alicia Sykes | c87e13cb70 | |
Alicia Sykes | 8c15ab4c84 | |
Alicia Sykes | 437ec2eac6 | |
Alicia Sykes | 7d91d51fa6 | |
Alicia Sykes | f107dbfc00 | |
Alicia Sykes | f6df1e7750 | |
Alicia Sykes | 138003c9b4 | |
Alicia Sykes | 854d04afca | |
Alicia Sykes | e454f6e0d2 | |
Leonardo Colman Lopes | cf5d872703 | |
Alicia Bot | 5a83004981 | |
Alicia Bot | 05cfcf46fa | |
liss-bot | 600824f403 | |
repo-visualizer | 9b8d931af2 | |
Alicia Sykes | eb9a5abec5 | |
Alicia Sykes | 52a0ba5a6c | |
Alicia Sykes | 238c51ae64 | |
Alicia Sykes | a7a7032b1d | |
Alicia Sykes | a9496391cd | |
Alicia Sykes | 6bf0ecba34 | |
Alicia Sykes | 1aecf32466 | |
Alicia Sykes | d765eeb7e0 | |
Alicia Sykes | dfb12ec8d2 | |
Alicia Sykes | 6018a49bed | |
Alicia Sykes | 64a3b5b8e3 | |
Alicia Sykes | 493540b949 | |
Alicia Sykes | 6c47715a02 | |
Walkx | 9def34e86c | |
Walkx | 2ccc89ef30 | |
Walkx | 56fcc3adaf | |
Walkx | b98c9b5e45 | |
Erwan Miran | cb35676251 | |
Alicia Sykes | a0ac7979e4 | |
Alicia Sykes | d5c5c4fc85 | |
Alicia Sykes | bc391e285c | |
Alicia Sykes | 45fa35a384 | |
Alicia Sykes | 3347dc9f61 | |
Alicia Sykes | 8acb8cd6b2 | |
CHAIYEON CHO | 0da8b394a5 | |
Alicia Sykes | 9ca11a5f63 | |
Alicia Sykes | dd49ad77a5 | |
Alicia Sykes | 7706041d61 | |
Alicia Sykes | 61761e750a | |
Alicia Sykes | 5ab619f195 | |
Alicia Sykes | f5a8c30257 | |
repo-visualizer | 7766c0a48c | |
Alicia Bot | 24cf5bc606 | |
Alicia Bot | b08c371376 | |
liss-bot | c54efa4fd3 | |
Alicia Sykes | c678bc5655 | |
Alicia Sykes | 558690ad98 | |
Alicia Sykes | c6127f852f | |
CHAIYEON CHO | 9d627b1c86 | |
Rémy GRANDIN | 5aab049a43 | |
Rémy GRANDIN | 044b7ed94d | |
Rémy GRANDIN | 6e7b0e4dd5 | |
Rémy GRANDIN | 1d69fc8617 | |
Alicia Sykes | 1bc9964374 | |
Alicia Sykes | 036bc008c5 | |
Alicia Sykes | cf7587b4ee | |
repo-visualizer | 05f5d71801 | |
Alicia Bot | 86eec6d78f | |
Alicia Sykes | 32ca8996d2 | |
Alicia Sykes | 07f6bfeddc | |
Alicia Sykes | a784a2fe30 | |
Alicia Sykes | cc1b9c823b | |
Alicia Sykes | 252bc164cc | |
Alicia Sykes | 525259bcff | |
Alicia Sykes | 0e51416db7 | |
Alicia Sykes | 4c713bfce6 | |
Alicia Sykes | a6f3c90722 | |
Alicia Sykes | b1de7bc7e5 | |
Alicia Sykes | 6c1c2ece84 | |
repo-visualizer | 83739534ef | |
Alicia Bot | 35479df7b0 | |
liss-bot | ab8e9d0be3 | |
liss-bot | 3af99664a5 | |
Alicia Sykes | da297a5e4a | |
Alicia Sykes | 099cbbba53 | |
Alicia Sykes | e6bc0ee90d | |
Alicia Sykes | 8a6b46b49d | |
Alicia Sykes | 689797a170 | |
Alicia Sykes | 57abd67cf9 | |
Alicia Sykes | 151028c8cf | |
Alicia Sykes | ab6e64af58 | |
Alicia Sykes | 4932a86f3c | |
Alicia Sykes | edad7fde41 | |
Alicia Sykes | f0cb8fe4f2 | |
Alicia Bot | 4353654a31 | |
liss-bot | d6601a979a | |
liss-bot | 338bb66d03 | |
Alicia Sykes | 680f5b17ab | |
Alicia Sykes | ad677de933 | |
Alicia Sykes | d9e04564a0 | |
Alicia Sykes | 7102b25216 | |
Alicia Sykes | acfb7f267a | |
Alicia Sykes | 00709acd51 | |
Alicia Sykes | 51de80a735 | |
Alicia Sykes | 1187787ef3 | |
Alicia Sykes | d077b1b9c9 | |
Alicia Sykes | 83ce9b8e5c | |
Alicia Sykes | dda5325528 | |
Alicia Sykes | 829021aa0f | |
Alicia Sykes | f9fb76a97c | |
Alicia Sykes | 3694a3ad03 | |
Alicia Sykes | c2559bc731 | |
Alicia Sykes | 93a531a3f2 | |
Alicia Sykes | 45583ae2a8 | |
Alicia Sykes | 5480f23db7 | |
Alicia Sykes | 6220f9b7f8 | |
Alicia Sykes | 979a776b68 | |
Alicia Sykes | 56798fbdc4 | |
Alicia Sykes | 730a67435e | |
Alicia Sykes | e616d9043f | |
Alicia Sykes | 3d9c646ad3 | |
Alicia Sykes | c3c04723fd | |
Alicia Sykes | 68b77587ff | |
Alicia Sykes | f4443d0077 | |
Alicia Sykes | 88d8ee6b1d | |
repo-visualizer | b51935f049 | |
Alicia Bot | b353a88927 | |
Alicia Bot | 3a4007004a | |
liss-bot | 772e19dc2f | |
Alicia Sykes | 879b3b8f32 | |
Alicia Sykes | 16aa14fcbb | |
Alicia Sykes | cd50ceb0a0 | |
Alicia Sykes | 1c85d454b9 | |
Alicia Sykes | a9ae53ef7c | |
Alicia Sykes | b7c84bb1dd | |
Alicia Sykes | fd2b3d831c | |
Alicia Sykes | 1f3ed135de | |
Alicia Sykes | 6702b9335f | |
Alicia Sykes | 7c6c06bc24 | |
Alicia Sykes | 9a2383c206 | |
Alicia Sykes | f250890f3b | |
Alicia Sykes | 837fa12eeb | |
0n1cOn3 | 84b6e9146b | |
repo-visualizer | 7814b59502 | |
Alicia Bot | fc36cca2cc | |
Alicia Bot | 925bf8c53b | |
liss-bot | ad08c6d58f | |
liss-bot | 9ee7e85b0d | |
Alicia Sykes | ad8546c858 | |
Steven Kast | 40a56ceb58 | |
Alicia Sykes | f286487b75 | |
Alicia Sykes | f39cdb5987 | |
aterox | b05c6ea069 | |
Alicia Sykes | 55396e9517 | |
aterox | 79754dc1e9 | |
aterox | 38337ed693 | |
Alessandro Del Prete | ad0c9f1349 | |
Alicia Bot | f87e2fcd78 | |
Alicia Bot | 76e76a0558 | |
liss-bot | 8626b3d068 | |
Alicia Sykes | 0e101b6330 | |
Alicia Sykes | 9e383e0638 | |
Alicia Sykes | 5ff099ea1f | |
Alicia Sykes | 4779434924 | |
Alicia Sykes | eae43492a8 | |
Alessandro Del Prete | b1ed8c4613 | |
repo-visualizer | 17209f926b | |
Alicia Bot | aa5b0d8feb | |
Alicia Bot | 8f822d417a | |
liss-bot | 9dd7636716 | |
Alicia Sykes | 4c19d8c797 | |
Alicia Sykes | 2051b20696 | |
aterox | 8ee7847648 | |
aterox | fe0d2d5b55 | |
Alicia Sykes | 06beb757a4 | |
aterox | 1c49b79c48 | |
aterox | 4e7537f24c | |
Alicia Sykes | 55f8ee6d43 | |
Alicia Sykes | c1fc473cf2 | |
Alicia Sykes | 70810b4d26 | |
aterox | a4e5402e5a | |
aterox | 6ee5286ebf | |
aterox | 955439fcfe | |
Alicia Sykes | 93911c2520 | |
aterox | d0acd2f75d | |
aterox | b3c680d462 | |
aterox | 50acc0f711 | |
aterox | b6a5dfbec1 | |
aterox | 9c35fe4027 | |
aterox | 3d4a8ecf6d | |
aterox | 727f6b1fc0 | |
aterox | 6553f1463d | |
repo-visualizer | e4fb3f6ad3 | |
Alicia Bot | a4cbda26af | |
liss-bot | 91b4882a59 | |
liss-bot | bb1183f5c6 | |
aterox | 5c1bfc8855 | |
Alicia Sykes | 57c06bde2e | |
aterox | 63663c1da0 | |
aterox | 7c86d6085b | |
aterox | aeec449dc7 | |
Alicia Sykes | 45e8444bb2 | |
Alicia Sykes | df3e8e6f13 | |
tazboyz16 | 72e8087c77 | |
Alicia Bot | 4c4790ec83 | |
liss-bot | f6d3fa42dd | |
liss-bot | 6068375c9e | |
Alicia Sykes | 4b7e49e8ab | |
Alicia Sykes | 7ba5cc23b7 | |
Alicia Sykes | f7a8395f4a | |
Alicia Sykes | 1062251a15 | |
Alicia Sykes | 6bb2298c28 | |
Alicia Sykes | 36db80fb3f | |
snyk-bot | 0fd5976573 | |
snyk-bot | ce5ea35d46 | |
repo-visualizer | 2c6f9948b6 | |
Alicia Bot | fb7a1e5ce4 | |
liss-bot | 1aa63e5a1c | |
liss-bot | 426a4fd652 | |
Alicia Sykes | f2c5de73bd | |
Alicia Sykes | 4701eedc3b | |
repo-visualizer | 57bbee70c5 | |
Alicia Bot | bb40627401 | |
Alicia Bot | 2981168082 | |
liss-bot | e1ffb4535b | |
liss-bot | be093a1f68 | |
Alicia Sykes | 5aff97a09e | |
Jeremy Chauvin | bbbcd09b44 | |
Alicia Sykes | 6a88f4725b | |
Alicia Sykes | c7758e8873 | |
Alicia Sykes | 2e63da041a | |
Singebob | 4f4f9963c7 | |
Alicia Sykes | ea760d9772 | |
Alicia Sykes | 757179d3c6 | |
Alicia Sykes | 11c59504dc | |
Alicia Sykes | bb4658e16c | |
Alicia Sykes | 9a21f3919b | |
Alicia Sykes | 23f2c1af74 | |
Alicia Sykes | 075bca98ce | |
Alicia Sykes | cde8060e23 | |
Alicia Sykes | 94e6190053 | |
Alicia Sykes | 7b6815a318 | |
Alicia Sykes | c9283fc3be | |
Alicia Sykes | 8dd392ff8b | |
Alicia Sykes | 2bf821784d | |
Alicia Sykes | d2bbca9f38 | |
Alicia Sykes | 1626b94285 | |
Alicia Sykes | 20b7a6b062 | |
Alicia Sykes | c1607cb19b | |
Alicia Sykes | cfe3a48405 | |
Alicia Sykes | 40045a637c | |
repo-visualizer | ed3cc78184 | |
Alicia Bot | 83d1f8ff76 | |
liss-bot | 03b7aba66d | |
liss-bot | 406f27b25d | |
Alicia Sykes | e2a3195fb4 | |
Alicia Sykes | e83990fa29 | |
Alicia Sykes | 17719daae8 | |
Alicia Sykes | fd99837b78 | |
Alicia Sykes | 04082763d3 | |
Alicia Sykes | ca9498ba4a | |
Alicia Sykes | 0146e996cf | |
Alicia Sykes | 0b07abeb18 | |
Alicia Sykes | eb377d287e | |
Alicia Sykes | d5f0c19fbf | |
Alicia Sykes | 20f231c632 | |
Alicia Sykes | c8ad80b79c | |
Alicia Sykes | 69f709001f | |
Alicia Sykes | af3343e15a | |
Alicia Sykes | e194d741ac | |
Alicia Sykes | e8cee3bd4d | |
Alicia Sykes | a65c3c569e | |
Alicia Sykes | 76e5a1b77b | |
Alicia Sykes | 61bbfcb885 | |
Alicia Sykes | f7c3c80b33 | |
Alicia Sykes | c3b93e4164 | |
Alicia Sykes | 45edc9731a | |
Alicia Sykes | 86837105cf | |
Alicia Sykes | c4f1be2b76 | |
Alicia Sykes | 5bc9a5f660 | |
Alicia Sykes | 33855dca40 | |
Alicia Sykes | 64bfafd3fa | |
Alicia Sykes | b18db08574 | |
Alicia Sykes | e5ccdd9e97 | |
repo-visualizer | b0cc37ac33 | |
Alicia Bot | 7428838c55 | |
Alicia Bot | 8e82e450ec | |
liss-bot | 7d8c048e3c | |
liss-bot | 137aee21ee | |
Alicia Sykes | 1294b43007 | |
Alicia Sykes | 824082ba8c | |
Alicia Sykes | 669e1e7566 | |
Alicia Sykes | 6288b32a22 | |
Alicia Sykes | ce7c4eeb8b | |
Alicia Sykes | cadae7c113 | |
Alicia Sykes | 827d3bcc01 | |
Alicia Sykes | d727b9db0f | |
Alicia Sykes | 8ca2c15930 | |
Alicia Sykes | b2c68bd064 | |
Alicia Sykes | 4fb910f1fa | |
Alicia Sykes | e3a39bc4b5 | |
Alicia Sykes | 051ad842ec | |
Alicia Sykes | cd2c7519c0 | |
Alicia Sykes | 2135ed77ca | |
Alicia Sykes | 969679fc49 | |
Alicia Sykes | ebae510294 | |
Alicia Sykes | c55799ad89 | |
Alicia Sykes | 3d8dc8b472 | |
Alicia Sykes | 159ff3db0f | |
Alicia Sykes | f1919af520 | |
Alicia Sykes | c9faf78772 | |
Alicia Sykes | e4cf491f36 | |
Alicia Sykes | 4b2d2c5f19 | |
Alicia Sykes | 56866d5a31 | |
Alicia Sykes | b0c493fb89 | |
Ruben Silva | eb06140fa4 | |
Ruben Silva | e3c7dc0f5d | |
Alicia Sykes | 0a639b0f08 | |
Alicia Sykes | 947d616f94 | |
Alicia Sykes | a5944c1d06 | |
Alicia Sykes | 11291ae0e6 | |
Alicia Sykes | e472d91102 | |
Alicia Sykes | ad1fae5b66 | |
Alicia Sykes | d07a5f7e6f | |
Alicia Sykes | 3ea8fc960e | |
snyk-bot | 995720dfe2 | |
Alicia Sykes | e1a78db853 | |
Alicia Sykes | 67326ed395 | |
Alicia Sykes | 6b9484a0fe | |
repo-visualizer | 0edaa2818e | |
Alicia Bot | 2f50261f72 | |
Alicia Bot | 86f1a1b0f9 | |
liss-bot | 49dd4d320a | |
Alicia Sykes | 73dfd2e2a4 | |
Alicia Sykes | 0ee25507c1 | |
icy-comet | b577650fea | |
Alicia Sykes | 0b354bf4d9 | |
Alicia Sykes | 63bd6e21aa | |
Alicia Sykes | 73c929c8bb | |
Alicia Sykes | 31702a62c3 | |
Alicia Sykes | aa1dc7b300 | |
Alicia Sykes | fd2bf9c887 | |
Alicia Sykes | 3f1f284e63 | |
Alicia Sykes | 3d5dbed0b6 | |
Alicia Sykes | 31a3e652c5 | |
Alicia Sykes | dfa9d7c5e8 | |
Alicia Sykes | b4a3126134 | |
Alicia Sykes | 7cc4b26e34 | |
Alicia Sykes | e6ba3243c3 | |
Alicia Sykes | 7f67ea6a5f | |
Alicia Sykes | eb1bc69155 | |
Alicia Sykes | 6e2ae6d3fc | |
Alicia Sykes | 35ccf1bf7b | |
Alicia Sykes | 34e109ddeb | |
Alicia Sykes | 5570cd257f | |
Alicia Sykes | 488cfc1c7b | |
Alicia Sykes | 33b132c463 | |
Alicia Sykes | 5f8a83fd47 | |
Alicia Sykes | f463fbdf51 | |
Alicia Bot | 2847b66251 | |
Alicia Bot | d71c3f4b37 | |
liss-bot | 5e189fc685 | |
Alicia Sykes | 7f5a5ed861 | |
Alicia Sykes | 730280a448 | |
Alicia Sykes | edbd770a2d | |
Alicia Sykes | 5b6e75766d | |
Alicia Sykes | 4be9e1f320 | |
Alicia Sykes | 7c9b4ec669 | |
Alicia Sykes | 8b7b09005d | |
Alicia Sykes | 23f7a748a7 | |
Alicia Sykes | 71325c7f3c | |
Alicia Sykes | 24793c8108 | |
Alicia Sykes | f4697bfffd | |
Alicia Sykes | eb3905bb8d | |
repo-visualizer | e19c7d9ea7 | |
Alicia Bot | b8e6c6da9f | |
Alicia Bot | 11952da5af | |
liss-bot | 0912a9045f | |
Alicia Sykes | f097e1901a | |
Alicia Sykes | 425fd41ed7 | |
Alicia Sykes | 407384de63 | |
Alicia Sykes | c3b6d2b0e0 | |
Alicia Sykes | 25bc577fb1 | |
Alicia Sykes | 4278764101 | |
Alicia Sykes | 6cc711ae23 | |
Alicia Sykes | 35dee3e3b2 | |
Alicia Sykes | 6ddf629c40 | |
Alicia Sykes | 7d52aed2d7 | |
Alicia Sykes | bf39553e1d | |
Alicia Sykes | cf98a96a15 | |
Alicia Sykes | 2c9ae46207 | |
Alicia Sykes | 9cd8c21d8e | |
Alicia Sykes | 6cd9eac49b | |
Alicia Sykes | 58a085a550 | |
Alicia Sykes | b96af21bc9 | |
Alicia Sykes | 7953ccf3c8 | |
Alicia Sykes | c8f33d85bf | |
Alicia Sykes | 63904366ce | |
Alicia Sykes | 7b7c427c97 | |
Alicia Sykes | 1f307d3193 | |
Alicia Sykes | dfea4e317c | |
snyk-bot | 0d9869e6e7 | |
Alicia Sykes | 987ee2d2f3 | |
Alicia Sykes | ea3ffa5d36 | |
Alicia Sykes | b3dcc5e43f | |
Alicia Sykes | 2e593fcf92 | |
Alicia Sykes | 8fd71702c7 | |
Alicia Sykes | 88727cf2e2 | |
Ishan Jain | 1eba866bba | |
Alicia Sykes | 6d9e34c90f | |
Alicia Sykes | 6b8a5ee086 | |
Alicia Sykes | 9148195b84 | |
Alicia Sykes | f25aa07d5f | |
Alicia Sykes | b76b8eb620 | |
Alicia Sykes | 63a0d18813 | |
Alicia Sykes | 323123e6c0 | |
Alicia Sykes | 45700d7875 | |
Alicia Sykes | 967daac95d | |
Alicia Sykes | ddf105ee65 | |
Alicia Sykes | cd0673013b | |
Alicia Sykes | b1da435656 | |
Alicia Sykes | ce4acc1e1a | |
repo-visualizer | e58dde2b01 | |
Alicia Bot | f6c307cea9 | |
Alicia Bot | b7de536466 | |
liss-bot | 0bee86eb6b | |
liss-bot | 71a1e43c6f | |
Alicia Sykes | 8b1282c5e1 | |
snyk-bot | 4e87acccce | |
Alicia Sykes | b4fb238243 | |
Xert | 55a84053e2 | |
snyk-bot | 24b285a888 | |
Alicia Sykes | c5bbcebe06 | |
Alicia Sykes | 3d2051b087 | |
Alicia Sykes | ed158169eb | |
Alicia Sykes | d10e6a8987 | |
Alicia Sykes | 2ec59660de | |
repo-visualizer | fd8a454afd | |
Alicia Bot | c89d69cef3 | |
liss-bot | cd579019ea | |
liss-bot | 2fb9f53fa7 | |
Alicia Sykes | 3a3364f156 | |
Alicia Sykes | e3b3f3c5a8 | |
Alicia Sykes | 4e64ccff3b | |
Alicia Sykes | 8349206770 | |
Alicia Sykes | 7fd1cab362 | |
Alicia Sykes | 9884087975 | |
Alicia Sykes | e253a35b05 | |
Alicia Sykes | 4a14b27cf3 | |
Alicia Sykes | 9ebdf67a44 | |
Alicia Sykes | 5a9017cdf7 | |
Alicia Sykes | 37e8a003f9 | |
Alicia Sykes | a889c0e78a | |
Alicia Sykes | f5c11b3dc6 | |
Alicia Sykes | 710b3ea7ad | |
Alicia Sykes | 2ee01f603c | |
Alicia Sykes | d516bb02fa | |
Alicia Sykes | 1c8021964b | |
Alicia Sykes | 7b030d8e5b | |
Alicia Bot | 3fe287d66d | |
liss-bot | fdca62b336 | |
liss-bot | 38998d1504 | |
Alicia Sykes | d4d8ea5a5f | |
snyk-bot | a16d3739c7 | |
Leonardo Covarrubias | 4a841b90e7 | |
repo-visualizer | d715cd97bb | |
Alicia Bot | b73e798f63 | |
Alicia Bot | 64a3e2c0c4 | |
liss-bot | b1bb9f5f02 | |
liss-bot | 805438c8a2 | |
Leonardo Covarrubias | 0c8a2c853d | |
Leonardo Covarrubias | 8a5329d50c | |
Leonardo Covarrubias | 37476f1152 | |
Alicia Sykes | 64bf1cbfc3 | |
Leonardo Covarrubias | dd30099ad8 | |
BOZG | 158919d882 | |
Leonardo Covarrubias | da98ea5cf2 | |
Alicia Sykes | 65ffa0efc4 | |
Kieren Connell | 59694c57cc | |
Alicia Sykes | 3b7d5a6ff7 | |
Alicia Sykes | 746a3774b6 | |
Alicia Sykes | 2925525fe4 | |
Alicia Sykes | 5fd6ffc9c8 | |
Alicia Sykes | 47762a1dd8 | |
Alicia Sykes | 6e310628f7 | |
Alicia Sykes | 661b1aab07 | |
Alicia Sykes | eb4e45dfb5 | |
Alicia Sykes | 395aea292e | |
Alicia Sykes | 1914d25b45 | |
Alicia Sykes | e3f2b910ec | |
Alicia Sykes | 7f968a708a | |
Alicia Sykes | d2ff1438e2 | |
Alicia Sykes | 25fa6ebae8 | |
Alicia Sykes | 312450a898 | |
Alicia Sykes | f1239f3aea | |
Alicia Sykes | d60060edfb | |
Alicia Sykes | bf3ccc13d0 | |
Alicia Sykes | 3cbf7949c3 | |
Alicia Sykes | 93a6ec08ba | |
Alicia Sykes | 7f4948aa04 | |
Alicia Sykes | d59466c7b5 | |
Alicia Sykes | 1f5d3f45fc | |
Alicia Sykes | 04a91cf689 | |
Alicia Sykes | aad7ab9b1f | |
Alicia Sykes | c650743384 | |
Alicia Sykes | c4ac847fc4 | |
Alicia Sykes | 9933766adf | |
Alicia Sykes | 5684bf06e8 | |
Alicia Sykes | 8791ed9322 | |
Alicia Sykes | a6b96483eb | |
Alicia Sykes | 41d9ead46b | |
Alicia Sykes | 9ab84195c2 | |
Alicia Sykes | e628650dd1 | |
Alicia Sykes | 7cd6e64b30 | |
Alicia Sykes | 27404f6044 | |
Alicia Sykes | 3ffdf753cc | |
Alicia Sykes | 051ed1841c | |
Alicia Sykes | 76ea9e0cee | |
Alicia Sykes | 15eddb1565 | |
Alicia Sykes | fac3e8e456 | |
Alicie | 43664702bc | |
Alicie | 2763e9ee00 | |
Alicie | 6e3d26d077 | |
Alicie | 5867601f1a | |
Alicie | 1296ca0bda | |
Alicia Sykes | 8ad6a2d76c | |
Alicia Sykes | 9c6c35ea89 | |
Alicia Sykes | 1324b43c0e | |
Alicia Sykes | 970b417f44 | |
Alicia Sykes | 802fb625d7 | |
repo-visualizer | 735aefae30 | |
Alicia Bot | 28d7b4a0e3 | |
liss-bot | 828385433b | |
liss-bot | c0a327d3da | |
Alicia Sykes | 6c0fb6fd41 | |
Alicia Sykes | 6fe13d13e5 | |
Alicia Sykes | 0da8c31899 | |
Alicia Sykes | ce8cdd3bfd | |
Alicia Sykes | e55c51abd7 | |
Alicia Sykes | c591a03f66 | |
Alicia Sykes | 83f61bec19 | |
Alicia Sykes | 20d42c96c8 | |
Alicia Sykes | 63dfa11b02 | |
Alicia Sykes | 0c5133fbc9 | |
Alicia Sykes | ad0be86c7f | |
Alicia Sykes | 33d500b6fc | |
Alicia Sykes | c99c517262 | |
Alicia Sykes | 90dd351756 | |
Alicia Sykes | 631470c431 | |
Alicia Sykes | 96005e72cd | |
Alicia Sykes | d085496c9c | |
Alicia Sykes | 0074c636b6 | |
Alicia Sykes | c1d10d2791 | |
Alicia Sykes | 5194ba2244 | |
Alicia Sykes | c4134e033b | |
Alicia Sykes | c17b93c1d4 | |
Alicia Sykes | 7a63fdc6c7 | |
Alicia Sykes | f243d9b916 | |
Alicia Sykes | b31c44f94d | |
Alicia Sykes | 0653c17550 | |
Alicia Sykes | c56079c7bd | |
Alicia Sykes | 5d5528a4a1 | |
Alicia Sykes | ff6fb33d00 | |
Alicia Sykes | 901c873d4e | |
Alicia Sykes | 8ae310ebd3 | |
Alicia Sykes | 676d1cb106 | |
Alicia Sykes | 58cb439086 | |
Alicia Sykes | f46d1df72a | |
Alicia Sykes | d855c46ca3 | |
Alicia Sykes | 8686a99be7 | |
repo-visualizer | d9be708de1 | |
Alicia Bot | 57ef6183a2 | |
liss-bot | 6b89c641ee | |
liss-bot | b01100b80c | |
Alicia Sykes | 0b868af5bb | |
Alicia Sykes | 9cbf08678b | |
Alicia Sykes | 79c55af986 | |
Alicia Sykes | dece5c58aa | |
Alicia Sykes | fad1e5ff50 | |
Alicia Sykes | 7084ca12d0 | |
Alicia Sykes | 24cf0d1e0d | |
Alicia Sykes | 08de6b8f17 | |
Alicia Sykes | be5188ef7d | |
Alicia Sykes | b7cd2d4c06 | |
Alicia Sykes | 599a5cc8d2 | |
Alicia Sykes | a23d56591c | |
Alicia Sykes | 771e2f3717 | |
Alicia Sykes | e0b09d48ee | |
Alicia Sykes | 6e84dacd51 | |
Alicia Sykes | 382d43f52c | |
Alicia Sykes | c5f9f5e216 | |
Alicia Sykes | f1bc2a2888 | |
Alicia Sykes | 283d8c750e | |
Alicia Sykes | 66067b002f | |
Alicia Sykes | 3da76ce299 | |
Alicia Sykes | 6df95c9387 | |
Kashif Sohail | d6e1cdaf2d | |
Kashif Sohail | 058a94aa45 | |
Alicia Sykes | f61366ca48 | |
Alicia Sykes | 642cfc655b | |
Alicia Sykes | 5cb588a586 | |
Alicia Sykes | 0a4d021b4e | |
Alicia Sykes | 19d3c03001 | |
Alicia Sykes | 70f99ea1e9 | |
Alicia Sykes | f9a0005740 | |
Alicia Sykes | aa770d6629 | |
Alicia Sykes | 2075cbc222 | |
Alicia Sykes | ae8179ecd7 | |
Alicia Sykes | d9759c06b3 | |
Alicia Sykes | 51b7e639cc | |
Kashif Sohail | e869978516 | |
Alicia Sykes | a77cb9430f | |
Kashif Sohail | 93a1e6becb | |
Kashif Sohail | 756a50d054 | |
Kashif Sohail | e4df372427 | |
Kashif Sohail | f0883fbf0a | |
Kashif Sohail | 502dcfb120 | |
Kashif Sohail | 37f7d685fe | |
repo-visualizer | ec1dfce255 | |
Alicia Bot | 954e982727 | |
liss-bot | e272b3a052 | |
liss-bot | 824585d139 | |
Alicia Sykes | bea82219c4 | |
Alicia Sykes | 9503a6d81b | |
Alicia Sykes | 464eef9338 | |
Alicia Sykes | f6e11921ef | |
Alicia Sykes | 9d21fa48d0 | |
Alicia Sykes | 985b0000fa | |
Alicia Sykes | d3c4fb50ae | |
Alicia Sykes | d5432774cc | |
Alicia Sykes | 65733d2af7 | |
Alicia Sykes | ebd4c48300 | |
Alicia Sykes | c12eac2bbf | |
Alicia Sykes | e8fa255e2e | |
Alicia Sykes | 9915100c13 | |
Alicia Bot | 86fc819233 | |
Alicia Bot | 0adc2bbdd5 | |
liss-bot | 604bfccafb | |
Alicia Sykes | 8e63522b02 | |
Walkx | 5cba511ae8 | |
Alicia Sykes | cf7e021a82 | |
Alicia Sykes | c38a094a63 | |
Alicia Sykes | e7627a3b1b | |
Walkx | 723a0c4904 | |
Walkx | 5783a82ac6 | |
Alicia Sykes | 16f91da8e7 | |
Alicia Sykes | a41797ecd1 | |
snyk-bot | c59d37f1de | |
snyk-bot | 84ba711df5 | |
Alicia Bot | e93e1234a9 | |
Alicia Bot | 01dd5ea59b | |
liss-bot | a4fcd61303 | |
liss-bot | a237c1be81 | |
Alicia Sykes | 30a1513e4c | |
Alicia Sykes | 8b0a38f758 | |
Alicia Sykes | c6052edd86 | |
BOZG | b514a99720 | |
Alicia Bot | 4a5b9db8b7 | |
liss-bot | 0937a7d7ee | |
liss-bot | 7c19babf2b | |
Alicia Sykes | a58b82c873 | |
Alicia Sykes | 65ea1dd1b6 | |
Alicia Sykes | fddf650e84 | |
Alicia Sykes | 2e57ea908b | |
Alicia Sykes | 4d9e36cf7a | |
Alicia Sykes | 1466df0274 | |
snyk-bot | 14b4d0a3e7 | |
Alicia Sykes | 2032481980 | |
Alicia Sykes | 68640afc87 | |
Alicia Sykes | d35bd9457b | |
Alicia Sykes | 49b405a717 | |
repo-visualizer | f8ec2cc73c | |
Alicia Bot | 7163f7065b | |
Alicia Bot | 43126b4fd3 | |
Alicia Sykes | 3f8b180553 | |
Alicia Sykes | de97f562a1 | |
Alicia Sykes | 7851467397 | |
Alicia Sykes | f6686d99ad | |
Alicia Sykes | 01fe0f0dbd | |
Alicia Sykes | c14eaf0aa2 | |
Alicia Sykes | 57554ddcdf | |
Alicia Sykes | c9f2483c3e | |
Alicia Sykes | 080e68445c | |
Alicia Sykes | a0672c57d0 | |
Alicia Sykes | 490c8e73fa | |
Alicia Sykes | 6b4fbfe25b | |
Alicia Sykes | 50164bf790 | |
Alicia Sykes | 85648bc32f | |
Alicia Sykes | eeaa924962 | |
Alicia Sykes | cd3a304744 |
|
@ -21,4 +21,4 @@ indent_size = 2
|
|||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
# Licensed under MIT, (C) 2021 Alicia Sykes <https://aliciasykes.com>
|
||||
# Licensed under MIT, (C) 2024 Alicia Sykes <https://aliciasykes.com>
|
103
.env
|
@ -1,33 +1,70 @@
|
|||
# Store environmental variables here. All variables are optional.
|
||||
# Lines beginning in '#' are ignored.
|
||||
|
||||
# Can be either development, production or test
|
||||
# NODE_ENV=production
|
||||
|
||||
# The port to expose the running application on
|
||||
# PORT=4000
|
||||
|
||||
# If you've proved SSL certs, then can set HTTPS port
|
||||
# SSL_PORT=4001
|
||||
|
||||
# The host that Dashy is running on, domain or IP
|
||||
# HOST=localhost
|
||||
|
||||
# The default base path for serving up static assets
|
||||
# BASE_URL=./
|
||||
|
||||
# Optionally, specify the path of SSL private + public keys
|
||||
# SSL_PRIV_KEY_PATH=/etc/ssl/certs/dashy-priv.key
|
||||
# SSL_PUB_KEY_PATH=/etc/ssl/certs/dashy-pub.pem
|
||||
|
||||
# Usually the same as BASE_URL, but accessible in frontend
|
||||
# VUE_APP_DOMAIN=https://dashy.to
|
||||
|
||||
# Should enable SRI for build script and link resources
|
||||
# INTEGRITY=true
|
||||
|
||||
# Computed automatically on build. Indicates if running in container
|
||||
# IS_DOCKER=true
|
||||
|
||||
# Again, set automatically using package.json during build time
|
||||
# VUE_APP_VERSION=2.0.0
|
||||
# Store environmental variables here. All variables are optional.
|
||||
# Lines beginning in '#' are ignored.
|
||||
|
||||
# Can be either development, production or test
|
||||
# NODE_ENV=production
|
||||
|
||||
# The port to expose the running application on
|
||||
# PORT=4000
|
||||
|
||||
# If you've proved SSL certs, then can set HTTPS port
|
||||
# SSL_PORT=4001
|
||||
|
||||
# The host that Dashy is running on, domain or IP
|
||||
# HOST=localhost
|
||||
|
||||
# The default base path for serving up static assets
|
||||
# BASE_URL=./
|
||||
|
||||
# Optionally, specify the path of SSL private + public keys
|
||||
# SSL_PRIV_KEY_PATH=/etc/ssl/certs/dashy-priv.key
|
||||
# SSL_PUB_KEY_PATH=/etc/ssl/certs/dashy-pub.pem
|
||||
|
||||
# If SSL enabled, choose whether or not to redirect http to https
|
||||
# Defaults to true
|
||||
# REDIRECT_HTTPS=true
|
||||
|
||||
# The path to the user data directory
|
||||
# USER_DATA_DIR=user-data
|
||||
|
||||
# Enable HTTP basic auth to protect your *.yml config files
|
||||
# ENABLE_HTTP_AUTH=true
|
||||
|
||||
# Enable basic HTTP auth to protect your *.yml config files
|
||||
# BASIC_AUTH_USERNAME
|
||||
# BASIC_AUTH_PASSWORD
|
||||
|
||||
# If you'd like frontend to automatically authenticate when basic auth enabled, set credentials here too
|
||||
# VUE_APP_BASIC_AUTH_USERNAME
|
||||
# VUE_APP_BASIC_AUTH_PASSWORD
|
||||
|
||||
# Override where the path to the configuration file is, can be a remote URL
|
||||
# VUE_APP_CONFIG_PATH=/conf.yml
|
||||
|
||||
# Usually the same as BASE_URL, but accessible in frontend
|
||||
# VUE_APP_DOMAIN=https://dashy.to
|
||||
|
||||
# Override the page title for the frontend app
|
||||
# VUE_APP_TITLE=''
|
||||
|
||||
# Set the default view to load on startup (can be `minimal`, `workspace` or `home`)
|
||||
# VUE_APP_STARTING_VIEW=home
|
||||
|
||||
# Set the Vue app routing mode (can be 'hash', 'history' or 'abstract')
|
||||
# VUE_APP_ROUTING_MODE=history
|
||||
|
||||
# Should enable SRI for build script and link resources
|
||||
# INTEGRITY=true
|
||||
|
||||
# Computed automatically on build. Indicates if running in container
|
||||
# IS_DOCKER=true
|
||||
|
||||
# Again, set automatically using package.json during build time
|
||||
# VUE_APP_VERSION=2.0.0
|
||||
|
||||
# Directory for conf.yml backups
|
||||
# BACKUP_DIR=./user-data/config-backups
|
||||
|
||||
# Setup any other user defined vars by prepending VUE_APP_ to the var name
|
||||
# VUE_APP_pihole_ip=http://your.pihole.ip
|
||||
# VUE_APP_pihole_key=your_pihole_secret_key
|
||||
|
|
|
@ -1,33 +1,167 @@
|
|||
0n1cOn3 <0n1cOn3@gmx.ch> - 1 commits
|
||||
5idereal <nelson22768384@gmail.com> - 1 commits
|
||||
Alberto <3170731+albcp@users.noreply.github.com> - 1 commits
|
||||
Alicia <liss-bot@d0h.co> - 1 commits
|
||||
Aly Mohamed <alydemah@gmail.com> - 1 commits
|
||||
Artyom <32810520+AaronPorts@users.noreply.github.com> - 1 commits
|
||||
BRAVO68WEB <jbandyopadhayaya@gmail.com> - 1 commits
|
||||
Begin <support@begin.com> - 1 commits
|
||||
Bhasher <github.it@bhasher.com> - 1 commits
|
||||
Bjorn Lammers <walkxnl@gmail.com> - 1 commits
|
||||
Bumsoo Kim <bskim45@gmail.com> - 1 commits
|
||||
BySempron <barquin_rkz@hotmail.com> - 1 commits
|
||||
Celestial.y <celestial.y@outlook.com> - 1 commits
|
||||
CrazyWolf13 <CrazyWolf13@users.noreply.github.com> - 1 commits
|
||||
David <skaarj1989@gmail.com> - 1 commits
|
||||
DeepSource <o> - 1 commits
|
||||
Devin <uh> - 1 commits
|
||||
Dawid Pietrykowski <d.pietrykowski16@gmail.com> - 1 commits
|
||||
DeepSource Bot <bot@deepsource.io> - 1 commits
|
||||
Desmond Kyeremeh <elDekyfin@gmail.com> - 1 commits
|
||||
Devin Buhl <devin.kray@gmail.com> - 1 commits
|
||||
Doug Lock <doug@douglock.co.uk> - 1 commits
|
||||
Dylan-Bs <35694107+Dylan-Bs@users.noreply.github.com> - 1 commits
|
||||
Eduardo Gomez <edugof@users.noreply.github.com> - 1 commits
|
||||
Erwan Miran <emiran.ext@orange.com> - 1 commits
|
||||
Ethan Hann <github.q2oay@slmail.me> - 1 commits
|
||||
FedelloKirfed <fedellokirfed@proton.me> - 1 commits
|
||||
FormatToday <616099456@qq.com> - 1 commits
|
||||
Iaroslav <ronski> - 1 commits
|
||||
Rune <jørnerå> - 1 commits
|
||||
Ryan <urne> - 1 commits
|
||||
Shreya <o> - 1 commits
|
||||
Garrett Brown <gdbrown09@gmail.com> - 1 commits
|
||||
Harald Töpfer <62364169+hubortje@users.noreply.github.com> - 1 commits
|
||||
Hendrik Strydom <56320839+FraglyG@users.noreply.github.com> - 1 commits
|
||||
Ian Neal <wopr@wopr.tech> - 1 commits
|
||||
Iaroslav Dronskii <iaroslav@dronskii.ru> - 1 commits
|
||||
Ishan Jain <ishan@jain.se> - 1 commits
|
||||
JJ Munguia <jj@jjmung.dev> - 1 commits
|
||||
Jemy SCHNEPP <dev@leethium.fr> - 1 commits
|
||||
Jeremy Chauvin <jeremychauvin10@gmail.com> - 1 commits
|
||||
Julian <julian.thanner@gmx.de> - 1 commits
|
||||
Kieran Eglin <kieran.eglin@gmail.com> - 1 commits
|
||||
Kieren Connell <Kieren@kierenconnell.com> - 1 commits
|
||||
Leonardo Colman Lopes <leonardo.dev@colman.com.br> - 1 commits
|
||||
Luis Pabon <luis.pabon@auronconsulting.co.uk> - 1 commits
|
||||
M Asenov <m.assenov@gmail.com> - 1 commits
|
||||
Markus Krause <Krause.Markus@gmx.com> - 1 commits
|
||||
Max Kulik <pearelectronics@live.com> - 1 commits
|
||||
Maxime Moreillon <m.moreillon@gmail.com> - 1 commits
|
||||
Mert Sefa AKGUN <git@msakg.com> - 1 commits
|
||||
Michael <michaellavaire@gmail.com> - 1 commits
|
||||
Nicholas Malcolm <bubylou@pm.me> - 1 commits
|
||||
OKAMOTO Shigehiro <primary@goahi.live> - 1 commits
|
||||
PlusaN <61884717+PlusaN@users.noreply.github.com> - 1 commits
|
||||
Prince Carl Velasco <princevelasco16@gmail.com> - 1 commits
|
||||
Rune Bjørnerås <rune.bjorneras@gmail.com> - 1 commits
|
||||
Ryan Turner <ryan.e.t@gmail.com> - 1 commits
|
||||
Rúben Silva <rubensilva945@gmail.com> - 1 commits
|
||||
Sacha FROMENT <sacha@sacha.house> - 1 commits
|
||||
Sergio <15928132+BySempron@users.noreply.github.com> - 1 commits
|
||||
Shahzzad Ali <shazzgit@gmail.com> - 1 commits
|
||||
Shawn Salat <31082405+ThinkSalat@users.noreply.github.com> - 1 commits
|
||||
Shreya Roy <shreyaroy.2604@gmail.com> - 1 commits
|
||||
Singebob <jeremy.chauvin@systeme-u.fr> - 1 commits
|
||||
Smexhy <roman.bartik@icloud.com> - 1 commits
|
||||
Stavros Kois <47820033+stavros-k@users.noreply.github.com> - 1 commits
|
||||
Steffen Schmidt <service.github@nocer.net> - 1 commits
|
||||
Steven Kast <steven.m.kast@gmail.com> - 1 commits
|
||||
Xert <xertdev@gmail.com> - 1 commits
|
||||
allozavrr <razviyarrr@gmail.com> - 1 commits
|
||||
baifengheixi <98794233+baifengheixi@users.noreply.github.com> - 1 commits
|
||||
deepsource-io[bot] <deepsource-io[bot]@users.noreply.github.com> - 1 commits
|
||||
dr460nf1r3 <njcrypted@protonmail.com> - 1 commits
|
||||
flechaig <flechaig@users.noreply.github.com> - 1 commits
|
||||
huangshaohuai <huangshaohuai@163.com> - 1 commits
|
||||
icy-comet <50461557+icy-comet@users.noreply.github.com> - 1 commits
|
||||
imlonghao <github@esd.cc> - 1 commits
|
||||
jnach <33467747+jnach@users.noreply.github.com> - 1 commits
|
||||
Brendan <'Lear> - 2 commits
|
||||
Dan <ilber> - 2 commits
|
||||
jrobles98 <jose98_21@hotmail.com> - 1 commits
|
||||
kxenox <floriandel@msn.com> - 1 commits
|
||||
laker j.v <la@laker.gay> - 1 commits
|
||||
markxoe <mark@oude-elberink.de> - 1 commits
|
||||
pablomalo <paul.gouin50@gmail.com> - 1 commits
|
||||
poisonadder7 <github.com@loginz.uk> - 1 commits
|
||||
rtm516 <ryantmilner@hotmail.co.uk> - 1 commits
|
||||
soaibsafi <soaib.safi@gmail.com> - 1 commits
|
||||
ssrangisetti <46807508+ssrangisetti@users.noreply.github.com> - 1 commits
|
||||
ssrangisetti <ssrangisetti@protonmail.com> - 1 commits
|
||||
sur1v <gsuriv@gmail.com> - 1 commits
|
||||
tazboyz16 <tazboyz_16@yahoo.com> - 1 commits
|
||||
zcq100 <zcq100@gmail.com> - 1 commits
|
||||
Ángel Fernández Sánchez <angelfx19@gmail.com> - 1 commits
|
||||
Al Saleh <alayham@alayham.com> - 2 commits
|
||||
Alejandro Pinar Ruiz <37040888+pinarruiz@users.noreply.github.com> - 2 commits
|
||||
Alessandro Del Prete <alessandro.delprete@gmail.com> - 2 commits
|
||||
Alexander Mnich <56564725+a-mnich@users.noreply.github.com> - 2 commits
|
||||
BOZG <sr@bozg.se> - 2 commits
|
||||
Brendan O'Leary <boleary@gitlab.com> - 2 commits
|
||||
CHAIYEON CHO <stoutcho21@gmail.com> - 2 commits
|
||||
Dan Gilbert <ddg@daentech.co.uk> - 2 commits
|
||||
Denis Savosin <dsavosin@at-consulting.ru> - 2 commits
|
||||
Mihai <31653632+z3r0l1nk@users.noreply.github.com> - 2 commits
|
||||
Ruben Silva <rubensilva945@gmail.com> - 2 commits
|
||||
Tammes Burghard <kde@kuchenmampfer.de> - 2 commits
|
||||
Thomas Dissert <dissertthomas@gmail.com> - 2 commits
|
||||
cauterize <cauterize@programmer.net> - 2 commits
|
||||
hockeymikey <hockeymikey@hockeymikey.com> - 2 commits
|
||||
itsmejoeeey <9375730+itsmejoeeey@users.noreply.github.com> - 2 commits
|
||||
k073l <21180271+k073l@users.noreply.github.com> - 2 commits
|
||||
kt-alt <kiettrang@hotmail.com> - 2 commits
|
||||
liss-bot <87835202+liss-bot@users.noreply.github.com> - 2 commits
|
||||
ᗪєνιη <υн> - 2 commits
|
||||
Niklas <abe> - 4 commits
|
||||
mmihaly <mmihaly@gmail.com> - 2 commits
|
||||
patrickheeney <patrickheeney@gmail.com> - 2 commits
|
||||
rokiden <cheto@bk.ru> - 2 commits
|
||||
root <root@dashy-dev.alayham.com> - 2 commits
|
||||
rtm516 <rtm516@users.noreply.github.com> - 2 commits
|
||||
z3r0l1nk <stroescu.mihai@gmail.com> - 2 commits
|
||||
zcq100 <m@zcq100.com> - 2 commits
|
||||
ᗪєνιη ᗷυнʟ <onedr0p@users.noreply.github.com> - 2 commits
|
||||
Alucarddelta <dreyer.brent@gmail.com> - 3 commits
|
||||
Berk Sümbül <mail@berksmbl.com> - 3 commits
|
||||
Tuzi555 <jakub.tuzar@gmail.com> - 3 commits
|
||||
Walkx <71191962+walkxcode@users.noreply.github.com> - 3 commits
|
||||
aterox <kenneth@kenneth.church> - 3 commits
|
||||
bogyeong <boggyhint@gmail.com> - 3 commits
|
||||
stanly0726 <37040069+stanly0726@users.noreply.github.com> - 3 commits
|
||||
Andreas Violaris <48277853+aviolaris@users.noreply.github.com> - 4 commits
|
||||
David Alasow <davidalasow@gmail.com> - 4 commits
|
||||
DimitriDR <dimitridroeck@gmail.com> - 4 commits
|
||||
Lissy93 <alicia@omg.lol> - 4 commits
|
||||
Niklas Zabel <nzabel@Mini-von-Niklas.fritz.box> - 4 commits
|
||||
Rémy GRANDIN <remy.gr@ndin.fr> - 4 commits
|
||||
Todd E Johnson <todd@toddejohnson.net> - 4 commits
|
||||
Totto16 <tobiausgais@gmail.com> - 4 commits
|
||||
Walkx <walkxnl@gmail.com> - 4 commits
|
||||
wozboz <philip@iuno.tech> - 4 commits
|
||||
Alberto Caravaca <3170731+albcp@users.noreply.github.com> - 5 commits
|
||||
Alicie <gh@d0h.co> - 5 commits
|
||||
Benjamin Montgomery <bmontgom@montynet.org> - 5 commits
|
||||
Chris Nielsen <nielsen.chris@gmail.com> - 5 commits
|
||||
UrekD <urek.denis@gmail.com> - 5 commits
|
||||
Erik <roo> - 6 commits
|
||||
Erik Vroon <erik.vroon22@gmail.com> - 6 commits
|
||||
Jammo2k5 <jammo2k5@hotmail.co.uk> - 6 commits
|
||||
Leonardo Covarrubias <leos@leocov.com> - 6 commits
|
||||
Magnus Sundström <kmvsundstrom@gmail.com> - 6 commits
|
||||
dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> - 6 commits
|
||||
kristian <kristianbrasel@gmail.com> - 6 commits
|
||||
liss-bot <liss-bot@users.noreply.github.com> - 6 commits
|
||||
repo-visualizer <repo-visualizer@users.noreply.github.com> - 14 commits
|
||||
snyk-bot <snyk-bot@snyk.io> - 15 commits
|
||||
Alicia <yke> - 16 commits
|
||||
Josua Blejeru <josua@blejeru.com> - 8 commits
|
||||
Tobias <tobias.meier109@gmail.com> - 8 commits
|
||||
Jimmeh <jimmeh@gmail.com> - 9 commits
|
||||
Kashif Sohail <kashif.ezone@gmail.com> - 9 commits
|
||||
Liss-Bot <liss-bot@d0h.co> - 11 commits
|
||||
Tobias <96661824+CrazyWolf13@users.noreply.github.com> - 12 commits
|
||||
Alejandro Pinar Ruiz <alejandropinarruiz@gmail.com> - 14 commits
|
||||
Alicia Sykes <=> - 16 commits
|
||||
github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> - 16 commits
|
||||
snyk-bot <snyk-bot@users.noreply.github.com> - 18 commits
|
||||
EVOTk <45015615+EVOTk@users.noreply.github.com> - 22 commits
|
||||
Alicia <o> - 24 commits
|
||||
Alicia <yke> - 25 commits
|
||||
liss-bot <liss-bot@d0h.co> - 35 commits
|
||||
Matthias Bilger <matthias@bilger.info> - 19 commits
|
||||
aterox <church.kennetha@gmail.com> - 19 commits
|
||||
EVOTk <45015615+EVOTk@users.noreply.github.com> - 24 commits
|
||||
snyk-bot <snyk-bot@snyk.io> - 24 commits
|
||||
Marcell Fülöp <marekful@protonmail.com> - 27 commits
|
||||
Alicia Sykes <alicia@futr.ai> - 28 commits
|
||||
Lissy93 <gh@d0h.co> - 78 commits
|
||||
Lissy93 <Lissy93@users.noreply.github.com> - 201 commits
|
||||
Alicia <yke> - 283 commits
|
||||
Alicia <yke> - 1168 commits
|
||||
repo-visualizer <repo-visualizer@users.noreply.github.com> - 128 commits
|
||||
Lissy93 <Lissy93@users.noreply.github.com> - 222 commits
|
||||
Alicia Bot <87835202+liss-bot@users.noreply.github.com> - 240 commits
|
||||
liss-bot <liss-bot@d0h.co> - 244 commits
|
||||
Alicia Sykes <gh@d0h.co> - 439 commits
|
||||
Alicia Sykes <alicia@omg.lol> - 471 commits
|
||||
Alicia Sykes <sykes.alicia@gmail.com> - 1488 commits
|
||||
|
|
|
@ -1,5 +1,158 @@
|
|||
# Changelog
|
||||
|
||||
## ✨ 2.1.1 Improvements [PR #775](https://github.com/Lissy93/dashy/pull/775)
|
||||
- Stop status checks when item destroyed
|
||||
- #767 by @marekful
|
||||
- Add Elizabeth + non-underground lines to TFL widget
|
||||
- #766 by @dougaldhub
|
||||
- Ensure first SSL certificate check finished before second
|
||||
- #760 by @marekful
|
||||
- Huge improvment to the way widgets are defined
|
||||
- #758 by @patrickheeney
|
||||
- Update APOD widget to use https://apod.as93.net
|
||||
- #745 by @k073l
|
||||
- Small docs update
|
||||
- #741 by @markusdd
|
||||
- A set of awesome NextCloud widgets
|
||||
- #740 by @marekful
|
||||
- Option to show / hide detailed info for StatPing widget
|
||||
- #714 by @marekful
|
||||
- Korean translations
|
||||
- #711 by @boggy-cs
|
||||
- Small docs update
|
||||
- #705 by @pablomalo
|
||||
|
||||
## ✨ 2.0.9 Adds Multi-Page Support [PR #685](https://github.com/Lissy93/dashy/pull/685)
|
||||
- Adds Widgets for AdGuard
|
||||
|
||||
## ✨ 2.0.9 Adds Multi-Page Support [PR #663](https://github.com/Lissy93/dashy/pull/663)
|
||||
- Fix KeyCloak API URL (#564)
|
||||
- Fix guest has config access (#590)
|
||||
- Fix collapsible content in multi-page support (#626)
|
||||
- Fix layout and item size buttons ( #629)
|
||||
- Refactor make request in RSS widget (#632)
|
||||
- Fix material-design-icons header in schema (#640)
|
||||
- Add option to hide seconds in clock widget (#644)
|
||||
- Fix pageInfo not being read in router (#645)
|
||||
- Fix startingView not honored (#646)
|
||||
- Fix Status Check default (#651)
|
||||
- Add option to hide image in SportsScores Widget (#654)
|
||||
- Add Adventure-basic theme (#655)
|
||||
- Write docs for sub-items (#657)
|
||||
- Add Font-Awesome displaying as square to troubleshooting guide (#659)
|
||||
- Show expand / collapse in context menu (#660)
|
||||
- Only deploy new release when relevant files have changed
|
||||
|
||||
## ✨ 2.0.8 Adds Multi-Page Support [PR #617](https://github.com/Lissy93/dashy/pull/617)
|
||||
- Adds support for multiple pages per-dashboard
|
||||
- Adds new attribute at root of main config file: `pages`
|
||||
- Updates router and nav-bar to automatically create paths for both local and remote configs
|
||||
|
||||
## ⚡️ 2.0.7 Improves handling of Sections and Items [PR #595](https://github.com/Lissy93/dashy/pull/595)
|
||||
- Adds functionality for sub-items / item-groups
|
||||
- Creates an item mixin, for reusing functionality
|
||||
- Item width calculated based on parent section width
|
||||
- Improved mobile support, long-press for right-click
|
||||
- Adds 2 new themes (`lissy` and `charry-blossom`)
|
||||
- Adds 2 new widgets (`mullvad-status`, and `blacklist-check`)
|
||||
|
||||
## 🐛 2.0.6 Fixes user requested issues [PR #557](https://github.com/Lissy93/dashy/pull/557)
|
||||
- Allows middle click open new tab, Re: #492
|
||||
- Implements Max redirects for status checks, Re: #494
|
||||
- Adds Gitpod config for cloud-ready IDE, Re: #497
|
||||
- Adss new screenshots to showcase, Re: #505
|
||||
- Fixes excess space below footer, Re: #522
|
||||
- Allows iframe content to be viewed full-screen, Re: #524
|
||||
- Fixes Glances widgets with Authorization headers, Re: #546
|
||||
- Adds target attribute to nav links, Re: #552
|
||||
- Removes fixed max-width on wide-screens, Re: #554
|
||||
- Adds missing type attribute to external CSS, Re: #560
|
||||
- Updates path to Keycloak API, Re: #564
|
||||
- Fixes link to @walkxhub homelab icons, Re #568
|
||||
- Fixes local image path on sub-page, Re: #570
|
||||
- Adds typecheck on edit item tags, Re: #575
|
||||
- Fixes item size in config not honored, Re: #576
|
||||
|
||||
## ✨ 2.0.5 - Bug Fixes and a few New Features
|
||||
|
||||
#### Partially revert 2.0.4, fixing several issues caused by `conf.yml` not being loaded at startup.
|
||||
This change requires a rebuild of the application when several options under `appConfig` are changed.
|
||||
Fixes #544 #555
|
||||
|
||||
#### Several other changes since 2.0.4, including:
|
||||
The `Add New Section` button on the UI editor now displays if no sections are present. #536
|
||||
When using SSL, the server can now redirect from HTTP to HTTPS. This is enabled by default when using SSL. #538
|
||||
Section context menus are now accessible on mobile, and will no longer clip off the screen. #541
|
||||
Italian translations have been added. #556
|
||||
|
||||
## ✨ 2.0.4 - Dynamic Config Loading [PR #528](https://github.com/Lissy93/dashy/pull/528)
|
||||
- `conf.yml` is now loaded dynamically and the app now only needs a browser refresh on config change, not a full rebuild!
|
||||
|
||||
## 🐛 2.0.3 - Bug Fixes [PR #488](https://github.com/Lissy93/dashy/pull/488)
|
||||
- Press enter to submit login form (Re: #483)
|
||||
- Allow disabling write to local storage and disk (Re: #485)
|
||||
- Fix malformed YAML from export config (Re: #482)
|
||||
- Allow global option for useProxy (Re: #486)
|
||||
- Look into arrow key navigation error (Re: #463)
|
||||
- Disallow displaying config (Re: #455)
|
||||
- Round values in Glances Alerts widget (Re: #454)
|
||||
- Create a CPU temp widget (Re: #452)
|
||||
- Add to docs: Keycloak in Kubernetes (Re: #479)
|
||||
- Add a widget for displaying images (Re: #487)
|
||||
|
||||
## ⬆️ 2.0.2 - Dependency Updates [PR #471](https://github.com/Lissy93/dashy/pull/471)
|
||||
- Updates Alpine version for main Dockerfile
|
||||
- Updates node_modules to latest stable versions
|
||||
|
||||
## 🐛 2.0.1 - Fixes Section Height [PR #462](https://github.com/Lissy93/dashy/pull/462)
|
||||
- Adds `cutToHeight` to config schema (Re: #461)
|
||||
- Removes the full-height CSS from colorful theme
|
||||
- Improved config validation warnings in JSON editor
|
||||
- Removes empty Keycloak block from appConfig editor
|
||||
- Adds typechecking to search and clear search for Safari
|
||||
|
||||
## ⚡️ 2.0.0 - Small Fixes and Docker Multi-Arch Build [PR #451](https://github.com/Lissy93/dashy/pull/451)
|
||||
- Fixes full-height sections for mobile and Safari (Re: #432, #442)
|
||||
- Fixes empty section visible in search (Re: #447)
|
||||
- Fixes numbers omited from tag names (Re: #430)
|
||||
- Option for custom status code in status check (Re: #456, #448)
|
||||
- Adds @stuu3k's dashboard to showcase (Re: #446)
|
||||
- Switches recover and death count in Covid widget (Re: #148)
|
||||
- Improved contrast in light material theme
|
||||
- Adds new script to lint, test, build and publish a multi-architecture Docker image to various registries
|
||||
|
||||
## 💄 1.9.9 - Minor UI + Docs Updates [PR #431](https://github.com/Lissy93/dashy/pull/431)
|
||||
- Improved theme support for widgets
|
||||
- Better widget layout in Workspace and Minimal views
|
||||
- Updates lots of the docs
|
||||
|
||||
## ✨ 1.9.8 - More Widgets and Widget Improvements [PR #425](https://github.com/Lissy93/dashy/pull/425)
|
||||
- Fixes several minor widget issues raised by users
|
||||
- Adds several new widgets, for monitoring system
|
||||
- Better widget data requests and error handling
|
||||
- Implements widget support into Workspace view
|
||||
|
||||
## 🐛 1.9.7 - Minor UI Editor Bug fixes [PR #416](https://github.com/Lissy93/dashy/pull/416)
|
||||
- Fixes unable to edit item bug (#415)
|
||||
- Fixes unable to add new app bug (#390)
|
||||
- Fixes nav links visibility (#389)
|
||||
|
||||
## ⚡️ 1.9.6 - Adds Proxy Support for Widget Requests [PR #392](https://github.com/Lissy93/dashy/pull/392)
|
||||
- Refactors widget mixin to include data requests, so that code can be shared between widgets
|
||||
- Adds a Node endpoint for proxying requests server-side, used for APIs that are not CORS enabled
|
||||
- Adds option to config file for user to force proxying of requests
|
||||
- Writes a Netlify cloud function to support proxying when the app is hosted on Netlify
|
||||
|
||||
## 🐛 1.9.5 - Bug fixes and Minor Improvements [PR #388](https://github.com/Lissy93/dashy/pull/388)
|
||||
- Adds icon.horse to supported favicon APIs
|
||||
- Fixes tile move bug, Re: #366
|
||||
- Fixes save items without title bug, Re: #377
|
||||
|
||||
## ✨ 1.9.4 - Widget Support [PR #382](https://github.com/Lissy93/dashy/pull/382)
|
||||
- Adds support for dynamic content, through widgets
|
||||
- Adds 30+ pre-built widgets for general info and self-hosted services
|
||||
- Writes docs on widget usage
|
||||
|
||||
## ⚡️ 1.9.2 - Native SSL Support + Performance Improvements [PR #326](https://github.com/Lissy93/dashy/pull/326)
|
||||
- Updates the server to use Express, removing serve-static, connect and body-parser
|
||||
- Adds native support for passing in self-signed SSL certificates and updates docs
|
||||
|
|
|
@ -14,14 +14,25 @@ body:
|
|||
- Self-Hosted (Docker)
|
||||
- Self-Hosted (Bare Metal)
|
||||
- Cloud Service (Static)
|
||||
- Other (Specify below)
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: system
|
||||
attributes:
|
||||
label: System
|
||||
description: >-
|
||||
For deployment issues, specify your [distro or OS](https://whatsmyos.com/) and/ or Docker version.
|
||||
For client-side issues, include your [browser version](https://www.whatsmybrowser.org/)
|
||||
placeholder: e.g. Firefox 101, Manjaro Linux 21.3.0, Docker 20.10.16
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of Dashy are you running?
|
||||
placeholder: 1.6.9 ← should look like this (check config menu)
|
||||
placeholder: 4.2.0 ← should look like this (check config menu)
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
|
@ -29,6 +40,7 @@ body:
|
|||
attributes:
|
||||
label: Describe the problem
|
||||
description: Please describe exactly what is not working, include the steps to reproduce, actual result and expected result
|
||||
placeholder: When doing ABC then DEF, I expect to see XYZ, but I actually see ZYX
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
|
@ -45,11 +57,13 @@ body:
|
|||
label: Please tick the boxes
|
||||
description: Before submitting, please ensure that
|
||||
options:
|
||||
- label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
|
||||
- label: You have explained the issue clearly, and included all relevant info
|
||||
required: true
|
||||
- label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy
|
||||
required: true
|
||||
- label: You've checked that this [issue hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
|
||||
required: true
|
||||
- label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
|
||||
- label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide ![important](https://img.shields.io/badge/Important!-F6094E)
|
||||
required: true
|
||||
- label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
|
||||
required: true
|
||||
|
@ -57,7 +71,9 @@ body:
|
|||
attributes:
|
||||
value: |-
|
||||
## Thanks 🙏
|
||||
Sorry you are having issues with Dashy, and thank you for raising this ticket - in doing so you are helping to make the app better for everyone 💪
|
||||
You should expect a reply within the next 48 hours :)
|
||||
<img align="left" width="160" src="https://i.ibb.co/S5vCnhL/gh-thanks.gif" alt="🐙" />
|
||||
Thank you for raising this ticket - in doing so you are helping to make the app better for everyone 💪<br>
|
||||
You should expect a reply within the next 48 hours :)<br>
|
||||
⭐️ Consider dropping the repo a star if you're enjoying Dashy!<br>
|
||||
validations:
|
||||
required: false
|
||||
required: false
|
||||
|
|
|
@ -1,62 +1,64 @@
|
|||
name: Question 🤷♂️
|
||||
description: Got a question about Dashy, deployment, development or usage?
|
||||
title: '[QUESTION] <title>'
|
||||
labels: ['🤷♂️ Question']
|
||||
|
||||
body:
|
||||
# Filed 1 - Intro Text
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >
|
||||
Thanks for using Dashy! Questions are welcome, but in the future will be moving over to
|
||||
[Discussions](https://github.com/Lissy93/dashy/discussions) page.
|
||||
Quick questions should be asked [here](https://github.com/Lissy93/dashy/discussions/148) instead.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
# Field 2 - The actual question
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: Outline your question in a clear and concise manner
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 3 - Category
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: Category
|
||||
description: What part of the application does this relate to?
|
||||
options:
|
||||
- Setup and Deployment
|
||||
- Configuration
|
||||
- App Usage
|
||||
- Development
|
||||
- Documentation
|
||||
- Alternate Views
|
||||
- Authentication
|
||||
- Using Icons
|
||||
- Language Support
|
||||
- Search & Shortcuts
|
||||
- Status Checking
|
||||
- Theming & Layout
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 4 - User has RTFM first, and agrees to code of conduct, etc
|
||||
- type: checkboxes
|
||||
id: idiot-check
|
||||
attributes:
|
||||
label: Please tick the boxes
|
||||
description: Before submitting, please ensure that
|
||||
options:
|
||||
- label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
|
||||
required: true
|
||||
- label: You've checked that this [question hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
|
||||
required: true
|
||||
- label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
|
||||
required: true
|
||||
- label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
|
||||
required: true
|
||||
name: Question 🤷♂️
|
||||
description: Got a question about Dashy, deployment, development or usage?
|
||||
title: '[QUESTION] <title>'
|
||||
labels: ['🤷♂️ Question']
|
||||
|
||||
body:
|
||||
# Filed 1 - Intro Text
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >
|
||||
Thanks for using Dashy! Questions are welcome, but in the future will be moving over to
|
||||
[Discussions](https://github.com/Lissy93/dashy/discussions) page.
|
||||
Quick questions should be asked [here](https://github.com/Lissy93/dashy/discussions/148) instead.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
# Field 2 - The actual question
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: Outline your question in a clear and concise manner
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 3 - Category
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: Category
|
||||
description: What part of the application does this relate to?
|
||||
options:
|
||||
- Setup and Deployment
|
||||
- Configuration
|
||||
- App Usage
|
||||
- Development
|
||||
- Documentation
|
||||
- Alternate Views
|
||||
- Authentication
|
||||
- Using Icons
|
||||
- Widgets
|
||||
- Actions
|
||||
- Language Support
|
||||
- Search & Shortcuts
|
||||
- Status Checking
|
||||
- Theming & Layout
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 4 - User has RTFM first, and agrees to code of conduct, etc
|
||||
- type: checkboxes
|
||||
id: idiot-check
|
||||
attributes:
|
||||
label: Please tick the boxes
|
||||
description: Before submitting, please ensure that
|
||||
options:
|
||||
- label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
|
||||
required: true
|
||||
- label: You've checked that this [question hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
|
||||
required: true
|
||||
- label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
|
||||
required: true
|
||||
- label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
|
||||
required: true
|
||||
|
|
|
@ -0,0 +1,45 @@
|
|||
## ✨ 2.1.1 Improvements [PR #775](https://github.com/Lissy93/dashy/pull/775)
|
||||
|
||||
#### Bug Fixes 🐛
|
||||
|
||||
- Update APOD widget to use https://apod.as93.net
|
||||
- #745 by @k073l
|
||||
- Fixes theme applying bug (#774)
|
||||
|
||||
#### Improvements ⚡️
|
||||
|
||||
- Stop status checks when item destroyed
|
||||
- #767 by @marekful
|
||||
- Ensure first SSL certificate check finished before second
|
||||
- #760 by @marekful
|
||||
- Huge improvement to the way widgets are defined
|
||||
- #758 by @patrickheeney
|
||||
|
||||
#### Features ✨
|
||||
|
||||
- A set of awesome NextCloud widgets
|
||||
- #740 by @marekful
|
||||
- Add Elizabeth + non-underground lines to TFL widget
|
||||
- #766 by @dougaldhub
|
||||
- Option to show / hide detailed info for StatPing widget
|
||||
- #714 by @marekful
|
||||
- Korean translations
|
||||
- #711 by @boggy-cs
|
||||
- Adds option to force ignore widget errors
|
||||
|
||||
#### Docs 📕
|
||||
|
||||
- Small docs update
|
||||
- #741 by @markusdd
|
||||
- Small docs update
|
||||
- #705 by @pablomalo
|
||||
- Adds Dipanghosh's dash to showcase
|
||||
|
||||
---
|
||||
|
||||
|
||||
Big thanks to the above developers, for their awesome work on this release!
|
||||
|
||||
V 2.1.2 is in the works, and includes an overhaul of how the config is loaded, so stay tuned for that!
|
||||
|
||||
And Happy Friday!
|
|
@ -1,157 +1,18 @@
|
|||
# 3rd-Party Software for Dashy
|
||||
---
|
||||
|
||||
The following 3rd-party software packages may be used by or distributed with **dashy**. Any information relevant to third-party vendors listed below are collected using common, reasonable means.
|
||||
|
||||
|
||||
Date generated | Revision ID
|
||||
:------------: | :----------:
|
||||
10/02/21 | cc7101a871e151a2dea7830d1e492ef6ef05fd53
|
||||
01/22/22 | cc7101a871e151a2dea7830d1e492ef6ef05fd53
|
||||
|
||||
---
|
||||
|
||||
## Dependencies
|
||||
|
||||
### [@sentry/tracing (6.11.0)](https://www.npmjs.com/package/@sentry/tracing)
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Sentry (https://sentry.io/) and individual contributors.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
Apache-2.0
|
||||
|
||||
```
|
||||
Copyright 2020 Google LLC
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### [@sentry/vue (6.11.0)](https://www.npmjs.com/package/@sentry/vue)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
**Multi-license:**MIT, **Multi-license:**BSD-3-Clause
|
||||
|
||||
```
|
||||
Copyright (c) 2021, @sentry/vue Contributors
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019, Sentry
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
\* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
\* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
\* Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
Apache-2.0
|
||||
|
||||
|
||||
```
|
||||
Copyright Microsoft Corporation
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
### [ajv (8.6.2)](https://www.npmjs.com/package/ajv)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
The MIT License (MIT)
|
||||
|
||||
|
@ -178,16 +39,15 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
### [axios (0.21.1)](https://www.npmjs.com/package/axios)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 2014-present Matt Zabriskie
|
||||
|
||||
|
@ -211,15 +71,15 @@ THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
### [body-parser (1.19.0)](https://www.npmjs.com/package/body-parser)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
(The MIT License)
|
||||
|
||||
|
@ -246,17 +106,15 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
### [connect (3.7.0)](https://www.npmjs.com/package/connect)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
(The MIT License)
|
||||
|
||||
|
@ -286,16 +144,15 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
### [crypto-js (4.1.1)](https://www.npmjs.com/package/crypto-js)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
\# License
|
||||
|
||||
|
@ -324,13 +181,12 @@ THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
BSD-2-Clause
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 2021, crypto-js Contributors<<beginOptional>>
|
||||
Copyright (c) 2022, crypto-js Contributors<<beginOptional>>
|
||||
All rights reserved.<<endOptional>>
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
|
@ -390,6 +246,7 @@ THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
---
|
||||
|
@ -402,7 +259,7 @@ Apache-2.0
|
|||
|
||||
|
||||
```
|
||||
Copyright 2016 Red Hat, Inc
|
||||
Copyright 2016 Red Hat, Inc. and/or its affiliates
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
|
@ -417,13 +274,12 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
MIT
|
||||
**Multi-license:**MIT, **Multi-license:**Apache-2.0 *OR* MIT
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 2017 Brett Epps
|
||||
Copyright (c) 2017 Brett Epps <https://github.com/eppsilon>
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
|
@ -444,7 +300,6 @@ SOFTWARE.
|
|||
```
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### [register-service-worker (1.7.2)](https://www.npmjs.com/package/register-service-worker)
|
||||
|
@ -479,6 +334,8 @@ THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
@ -489,6 +346,55 @@ THE SOFTWARE.
|
|||
Apache-2.0 *OR* MIT
|
||||
|
||||
|
||||
```
|
||||
Copyright 2018 AJ ONeal
|
||||
|
||||
This is open source software; you can redistribute it and/or modify it under the
|
||||
terms of either:
|
||||
|
||||
a) the "MIT License"
|
||||
b) the "Apache-2.0 License"
|
||||
|
||||
MIT License
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
Apache-2.0 License Summary
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
Copyright 2018 AJ ONeal
|
||||
|
@ -572,6 +478,150 @@ OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
---
|
||||
|
||||
### [@sentry/tracing (6.11.0)](https://www.npmjs.com/package/@sentry/tracing)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
MIT
|
||||
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Sentry (https://sentry.io/) and individual contributors.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
Apache-2.0
|
||||
|
||||
|
||||
```
|
||||
Copyright Microsoft Corporation. All rights reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
### [@sentry/vue (6.11.0)](https://www.npmjs.com/package/@sentry/vue)
|
||||
|
||||
|
||||
#### Declared Licenses
|
||||
BSD-3-Clause *OR* MIT
|
||||
|
||||
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019, Sentry
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
\* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
\* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
\* Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
**Multi-license:**Apache-2.0, **Multi-license:**MIT
|
||||
|
||||
|
||||
```
|
||||
Copyright Microsoft Corporation. All rights reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 2019 Sentry
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
@ -611,6 +661,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
|
@ -656,126 +707,7 @@ For more information, please see http://creativecommons.org/publicdomain/zero/1.
|
|||
```
|
||||
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
**Multi-license:**Apache-2.0, **Multi-license:**MIT, **Multi-license:**GPL-2.0-or-later, **Multi-license:**GPL-3.0-only, **Multi-license:**W3C, **Multi-license:**GPL-3.0-or-later *OR* W3C, **Multi-license:**GPL-3.0-or-later, **Multi-license:**BSD-3-Clause, **Multi-license:**PHP-3.01
|
||||
|
||||
|
||||
```
|
||||
Copyright 2021, simple-icons Contributors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 2021, simple-icons Contributors
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
Copyright (C) 2021, simple-icons Contributors
|
||||
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 or any later version.
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
Copyright (C) 2021, simple-icons Contributors
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/
|
||||
```
|
||||
|
||||
```
|
||||
Copyright (C) [$date-of-software] World Wide Web Consortium, (Massachusetts Institute of Technology, European Research Consortium for Informatics and Mathematics, Keio University). All Rights Reserved.
|
||||
This work is distributed under the W3C® Software License in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
```
|
||||
|
||||
```
|
||||
Copyright (C) 2021, simple-icons Contributors
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 or any later version.
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/
|
||||
```
|
||||
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 2021, simple-icons Contributors . All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
```
|
||||
|
||||
|
||||
|
||||
```
|
||||
Copyright (c) 1999 - 2012 The PHP Group. All rights reserved.
|
||||
Redistribution and use in source and binary forms, with or without modification, is permitted provided that the following conditions are met:
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
3. The name "PHP" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact group@php.net.
|
||||
4. Products derived from this software may not be called "PHP", nor may "PHP" appear in their name, without prior written permission from group@php.net. You may indicate that your software works in conjunction with PHP by saying "Foo for PHP" instead of calling it "PHP Foo" or "phpfoo"
|
||||
5. The PHP Group may publish revised and/or new versions of the license from time to time. Each version will be given a distinguishing version number. Once covered code has been published under a particular version of the license, you may always continue to use it under the terms of that version. You may also choose to use such covered code under the terms of any subsequent version of the license published by the PHP Group. No one other than the PHP Group has the right to modify the terms applicable to covered code created under this License.
|
||||
6. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes PHP software, freely available from <http://www.php.net/software/>".
|
||||
THIS SOFTWARE IS PROVIDED BY THE PHP DEVELOPMENT TEAM ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PHP DEVELOPMENT TEAM OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
This software consists of voluntary contributions made by many individuals on behalf of the PHP Group.
|
||||
The PHP Group can be contacted via Email at group@php.net.
|
||||
For more information on the PHP Group and the PHP project, please see <http://www.php.net>.
|
||||
PHP includes the Zend Engine, freely available at <http://www.zend.com>.
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
@ -811,6 +743,25 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
Apache-2.0
|
||||
|
||||
|
||||
```
|
||||
Copyright 2011-2021 Jos de Jong, http://jsoneditoronline.org
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
@ -846,7 +797,7 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
|
@ -882,13 +833,12 @@ THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
**Multi-license:**Apache-2.0, **Multi-license:**GPL-2.0-or-later
|
||||
**Multi-license:**Apache-2.0 *OR* GPL-2.0-or-later *OR* MPL-1.1, **Multi-license:**Apache-2.0
|
||||
|
||||
|
||||
```
|
||||
Copyright 2021, vue Contributors
|
||||
Copyright 2022, vue Contributors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
|
@ -904,14 +854,6 @@ See the License for the specific language governing permissions and limitations
|
|||
```
|
||||
|
||||
|
||||
```
|
||||
Copyright (C) 2021, vue Contributors
|
||||
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 or any later version.
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
### [vue-i18n (8.25.0)](https://www.npmjs.com/package/vue-i18n)
|
||||
|
@ -945,6 +887,9 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
@ -980,6 +925,7 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
|
@ -1015,6 +961,8 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
@ -1050,6 +998,8 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
@ -1084,8 +1034,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|||
SOFTWARE.
|
||||
|
||||
```
|
||||
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
|
@ -1121,6 +1070,8 @@ SOFTWARE.
|
|||
|
||||
```
|
||||
|
||||
#### Other Licenses
|
||||
|
||||
---
|
||||
|
||||
### [vue-toasted (1.1.28)](https://www.npmjs.com/package/vue-toasted)
|
||||
|
@ -1153,4 +1104,14 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
#### Other Licenses
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
[FOSSA]: # (Do not touch the comments below)
|
||||
|
||||
[FOSSA]: # (==depsig=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855==)
|
||||
|
||||
|
||||
|
|
|
@ -12,4 +12,6 @@ If you'd like to help support Dashy's future development, see **[Contributing](h
|
|||
|
||||
To get in contact with the author, email me at **`alicia at omg dot lol`** **[[PGP]](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7)**.
|
||||
|
||||
-Thank you
|
||||
-Thank you
|
||||
|
||||
> <sub>Prior to raising a ticket, please check the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme), [troubleshooting guide](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md) and [previous issues](https://github.com/Lissy93/dashy/issues?q=is%3Aissue).</sub><br><sup>If you're new here, consider also staring the repo before submitting your ticket.</sup>
|
||||
|
|
|
@ -1,13 +0,0 @@
|
|||
# When a PR is merged, any associated issues will have a Done label applied
|
||||
# The label will depend on the issue type, see: ./github/close-label.yml
|
||||
name: 💡 Apply Done Label
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, merged, closed]
|
||||
jobs:
|
||||
triage:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: logerfo/close-label@0.0.4
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -1,15 +0,0 @@
|
|||
# Automatically assigns the author as a reviewer to opened PRs and issues
|
||||
name: 💡 Auto-Assign Author to PR
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened]
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
assign-author:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Assign author
|
||||
uses: technote-space/assign-author@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -8,15 +8,33 @@ on:
|
|||
jobs:
|
||||
tag-pre-release:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
outputs:
|
||||
tag: ${{ steps.autotag.outputs.tagname }}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: butlerlogic/action-autotag@stable
|
||||
id: autotag
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
strategy: package
|
||||
commit_message_template: "🔖 {{number}} {{message}} (by {{author}})\nSHA: {{sha}}\n."
|
||||
github-release:
|
||||
runs-on: ubuntu-latest
|
||||
needs: tag-pre-release
|
||||
if: ${{ needs.tag-pre-release.outputs.tag }}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: ncipollo/release-action@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
tag: ${{ needs.tag-pre-release.outputs.tag }}
|
||||
bodyFile: ".github/LATEST_CHANGELOG.md"
|
||||
mark-issue-fixed:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.event_name == 'issues' }}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Label Fixed Issues
|
||||
|
|
|
@ -1,14 +0,0 @@
|
|||
# Updates multiple issues with a certain tag, with a comment containing a given message
|
||||
name: 🎯 Broadcast Message across Issues
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
message: { required: false }
|
||||
labels: { required: false }
|
||||
jobs:
|
||||
broadcast:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: jenschelkopf/broadcast-action@master
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -1,25 +0,0 @@
|
|||
# This action builds and deploys the master branch
|
||||
name: 🏗️ Build App to Branch
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v2.3.1
|
||||
- name: Install and Build 🔧
|
||||
run: |
|
||||
npm install
|
||||
npm run build
|
||||
- name: Deploy 🚀
|
||||
uses: JamesIves/github-pages-deploy-action@4.1.4
|
||||
if: ${{ github.repository_owner === 'lissy93' }}
|
||||
with:
|
||||
branch: dev-demo
|
||||
folder: dist
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Builds and published Dashy's documentation website
|
||||
name: 📝 Build Docs Site
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: [ WEBSITE/docs-site-source ]
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.ref == 'refs/heads/WEBSITE/docs-site-source'
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- uses: redkubes/docusaurus-deploy-action@v1
|
||||
with:
|
||||
source-folder: ./
|
||||
git-user: ${{ github.actor }}
|
||||
git-password: ${{ secrets.GITHUB_TOKEN }}
|
||||
deployment-branch: gh-pages
|
|
@ -1,13 +0,0 @@
|
|||
# Caches artifacts, including NPM dependencies, to speed up build times
|
||||
name: 🏗️ Caching Artifacts
|
||||
on: push
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/cache@v2
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
|
@ -1,22 +0,0 @@
|
|||
# Attempts to auto-detect weather an issue is a duplicate, and adds a comment
|
||||
name: 🎯 Issue Duplicate Check
|
||||
on:
|
||||
issues:
|
||||
types: [opened, edited]
|
||||
jobs:
|
||||
check-duplicate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: wow-actions/potential-duplicates@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
filter: ''
|
||||
exclude: '[BUG] [QUESTION] [FEEDBACK] [SHOWCASE]'
|
||||
label: '🕸️ Potential Duplicate'
|
||||
state: all
|
||||
threshold: 0.75
|
||||
reactions: 'eyes'
|
||||
comment: >
|
||||
Potential duplicates: {{#issues}}
|
||||
- [#{{ number }}] {{ title }} ({{ accuracy }}%)
|
||||
{{/issues}}
|
|
@ -13,21 +13,21 @@ jobs:
|
|||
uses: actions/stale@v4
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 30
|
||||
days-before-stale: 360
|
||||
days-before-close: 5
|
||||
operations-per-run: 30
|
||||
remove-stale-when-updated: true
|
||||
enable-statistics: true
|
||||
stale-issue-message: >
|
||||
This issue has gone 6 weeks without an update. To keep the ticket open, please indicate that it is still relevant in a comment below.
|
||||
This issue has gone 3 months without an update. To keep the ticket open, please indicate that it is still relevant in a comment below.
|
||||
Otherwise it will be closed in 5 working days.
|
||||
stale-pr-message: >
|
||||
This PR is stale because it has been open 6 weeks with no activity. Either remove the stale label or comment below with a short update,
|
||||
otherwise this PR will be closed in 5 days.
|
||||
close-issue-message: >
|
||||
This issue was automatically closed because it has been stalled for over 6 weeks with no activity.
|
||||
This issue was automatically closed because it has been stalled for over 1 year with no activity.
|
||||
close-pr-message: >
|
||||
This pull request was automatically closed because it has been stalled for over 6 weeks with no activity.
|
||||
This pull request was automatically closed because it has been stalled for over 1 year with no activity.
|
||||
stale-issue-label: '⚰️ Stale'
|
||||
close-issue-label: '🕸️ Inactive'
|
||||
stale-pr-label: '⚰️ Stale'
|
||||
|
@ -76,4 +76,4 @@ jobs:
|
|||
close-issue-label: '🕸️ Inactive'
|
||||
close-pr-label: '🕸️ Inactive'
|
||||
exempt-issue-labels: '📌 Keep Open'
|
||||
exempt-pr-labels: '📌 Keep Open'
|
||||
exempt-pr-labels: '📌 Keep Open'
|
||||
|
|
|
@ -1,20 +0,0 @@
|
|||
# Lints code merged into master branch
|
||||
name: 🌈 Lint Code Base
|
||||
on:
|
||||
pull_request:
|
||||
branches: [master]
|
||||
jobs:
|
||||
build:
|
||||
name: Lint Code Base
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Lint Code Base
|
||||
uses: github/super-linter@v4
|
||||
env:
|
||||
VALIDATE_ALL_CODEBASE: false
|
||||
DEFAULT_BRANCH: master
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@ -1,30 +0,0 @@
|
|||
# Finds typos in the English language within the app, submits a PR with fixes
|
||||
name: 🌈 Spelling Auto-Fix
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
if: startsWith(github.head_ref, 'AUTO/') == false
|
||||
uses: actions/checkout@v2
|
||||
- name: Spell Check
|
||||
if: startsWith(github.head_ref, 'AUTO/') == false
|
||||
uses: sobolevn/misspell-fixer-action@master
|
||||
- name: Create PR
|
||||
uses: peter-evans/create-pull-request@v3.10.1
|
||||
if: startsWith(github.head_ref, 'AUTO/') == false
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
base: master
|
||||
commit-message: ':pencil2: Auto-fix typos in text'
|
||||
title: '[AUTO] Fix spelling and language'
|
||||
branch: 'AUTO/spelling-corrections'
|
||||
committer: 'Liss-Bot <alicia-gh-bot@mail.as93.net>'
|
||||
assignees: Lissy93
|
||||
reviewers: Lissy93
|
|
@ -15,4 +15,3 @@ jobs:
|
|||
collapsibleThreshold: '25'
|
||||
failOnDowngrade: 'false'
|
||||
path: 'yarn.lock'
|
||||
updateComment: 'true'
|
||||
|
|
|
@ -0,0 +1,103 @@
|
|||
# Scans, builds and releases a multi-architecture docker image
|
||||
name: 🐳 Build + Publish Multi-Platform Image
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: ['master']
|
||||
tags: [v*]
|
||||
paths:
|
||||
- '**.js'
|
||||
- 'src/**'
|
||||
- 'public/**'
|
||||
- 'services/**'
|
||||
- '.github/workflows/docker-build-publish.yml'
|
||||
- 'Dockerfile'
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
permissions:
|
||||
packages: write
|
||||
|
||||
env:
|
||||
DH_IMAGE: ${{ secrets.DOCKER_REPO }}
|
||||
GH_IMAGE: ${{ github.repository_owner }}/${{ github.event.repository.name }}
|
||||
|
||||
jobs:
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
permissions: { contents: read, packages: write }
|
||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||
|
||||
steps:
|
||||
- name: 🛎️ Checkout Repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: 🔖 Get App Version
|
||||
uses: tyankatsu0105/read-package-version-actions@v1
|
||||
id: package-version
|
||||
|
||||
- name: 🗂️ Make Docker Meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v3
|
||||
with:
|
||||
images: |
|
||||
${{ env.DH_IMAGE }}
|
||||
ghcr.io/${{ env.GH_IMAGE }}
|
||||
tags: |
|
||||
type=ref,event=tag,prefix=release-,suffix={{tag}}
|
||||
type=semver,pattern={{raw}},value=${{ steps.package-version.outputs.version }}
|
||||
labels: |
|
||||
maintainer=Lissy93
|
||||
org.opencontainers.image.title=Dashy
|
||||
org.opencontainers.image.description=A self-hosted startpage for your server
|
||||
org.opencontainers.image.documentation=https://dashy.to/docs
|
||||
org.opencontainers.image.authors=Alicia Sykes
|
||||
org.opencontainers.image.licenses=MIT
|
||||
|
||||
- name: 🔧 Set up QEMU
|
||||
uses: docker/setup-qemu-action@v1
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
||||
|
||||
- name: 🔧 Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v1
|
||||
id: buildx
|
||||
with:
|
||||
driver-opts: image=moby/buildkit:v0.10.6
|
||||
|
||||
- name: 👀 Inspect builder
|
||||
run: |
|
||||
echo "Name: ${{ steps.buildx.outputs.name }}"
|
||||
echo "Endpoint: ${{ steps.buildx.outputs.endpoint }}"
|
||||
echo "Status: ${{ steps.buildx.outputs.status }}"
|
||||
echo "Flags: ${{ steps.buildx.outputs.flags }}"
|
||||
echo "Platforms: ${{ steps.buildx.outputs.platforms }}"
|
||||
|
||||
- name: 🔑 Login to DockerHub
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: 🔑 Login to GitHub Container Registry
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.repository_owner }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: 🚦 Check Registry Status
|
||||
uses: crazy-max/ghaction-docker-status@v1
|
||||
|
||||
- name: ⚒️ Build and push
|
||||
uses: docker/build-push-action@v2
|
||||
with:
|
||||
context: .
|
||||
file: ./Dockerfile
|
||||
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
push: true
|
|
@ -1,63 +0,0 @@
|
|||
# Builds a Docker image from with latest tag when master branch is updated
|
||||
# The publishes it to GitHub container registry as a package
|
||||
name: 🏗️ Build + Publish Docker Image to GHCR
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: ['master']
|
||||
tags: [v*]
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: dashy
|
||||
jobs:
|
||||
build-and-push-image:
|
||||
runs-on: ubuntu-latest
|
||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
# Fetch the code
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Prepare
|
||||
id: prep
|
||||
run: echo ::set-output name=version::${GITHUB_REF##*/}
|
||||
|
||||
# Use QEMU for multi-architecture builds
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v1
|
||||
with:
|
||||
platforms: all
|
||||
|
||||
# # Use Moby BuildKit
|
||||
# - name: Set up Docker Buildx
|
||||
# id: buildx
|
||||
# uses: docker/setup-buildx-action@v1
|
||||
# with:
|
||||
# install: true
|
||||
# version: latest
|
||||
# driver-opts: image=moby/buildkit:master
|
||||
|
||||
# Login into GH container registry
|
||||
- name: Log in to registry
|
||||
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
|
||||
|
||||
# Build the image from default Dockerfile
|
||||
- name: Build image
|
||||
run: docker build . --file docker/Dockerfile-multi-arch --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"
|
||||
|
||||
# Push build image
|
||||
- name: Push image
|
||||
run: |
|
||||
IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
|
||||
IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
|
||||
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
|
||||
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
|
||||
[ "$VERSION" == "master" ] && VERSION=latest
|
||||
echo IMAGE_ID=$IMAGE_ID
|
||||
echo VERSION=$VERSION
|
||||
docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
|
||||
docker push $IMAGE_ID:$VERSION
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
# Test and build the Docker container after a release
|
||||
# Then push it to GH container registry if all checks pass
|
||||
name: Build & Publish Docker Image
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
jobs:
|
||||
build-and-push-image:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
# Get the code
|
||||
- name: Checkout repository 🛎️
|
||||
uses: actions/checkout@v2
|
||||
# Log into ghcr.io
|
||||
- name: Log in to the Container registry 🔑
|
||||
uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
# Get release version, for Docker tag
|
||||
- name: Extract metadata (tags, labels) for Docker 🗂️
|
||||
id: meta
|
||||
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
# Build the container, and push if successful
|
||||
- name: Build and push Docker image ⚒️
|
||||
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
|
@ -1,33 +0,0 @@
|
|||
# Checks for any broken links in the docs, and raises an issue if found
|
||||
name: 🌈 Broken Link Checker
|
||||
on:
|
||||
repository_dispatch:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 1 * *' # Run monthly
|
||||
jobs:
|
||||
link-checker:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Load Excludes
|
||||
run: |
|
||||
LYCHEE_EXCLUDE=$(sed -e :a -e 'N;s/\n/ /;ta' .github/.lycheeexclude)
|
||||
echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV
|
||||
|
||||
- name: Check for Broken Links
|
||||
uses: lycheeverse/lychee-action@v1.0.8
|
||||
with:
|
||||
args: --verbose -a 200,302,304,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail --no-progress **/*.md
|
||||
env:
|
||||
GITHUB_TOKEN: ${{secrets.BOT_GITHUB_TOKEN}}
|
||||
LYCHEE_OUT: .github/broken-link-report.md
|
||||
|
||||
- name: Raise an Issue with Results
|
||||
uses: peter-evans/create-issue-from-file@v3
|
||||
with:
|
||||
token: ${{secrets.BOT_GITHUB_TOKEN}}
|
||||
title: '[DOCS] Broken Links found in Documentation'
|
||||
content-filepath: .github/broken-link-report.md
|
||||
labels: '📕 Docs, 👩💻 Good First Issue, 💤 Low Priority, 🤖 Auto'
|
|
@ -1,43 +0,0 @@
|
|||
name: 📕 Check Docs Domain Expiry
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
jobs:
|
||||
check-domain:
|
||||
runs-on: ubuntu-latest
|
||||
name: Check domain
|
||||
strategy:
|
||||
matrix:
|
||||
domain:
|
||||
- https://dashy.to
|
||||
steps:
|
||||
- name: Check domain SSL and registry expire date
|
||||
id: check-domain
|
||||
uses: codex-team/action-check-domain@v1
|
||||
with:
|
||||
url: ${{ matrix.domain }}
|
||||
- name: Raise issue if domain expiring soon
|
||||
if: ${{ steps.check-domain.outputs.paid-till-days-left && steps.check-domain.outputs.paid-till-days-left < 30 }}
|
||||
uses: rishabhgupta/git-action-issue@v2
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
assignees: Lissy93
|
||||
title: '[WEBSITE] Domain Expiring Soon'
|
||||
body: >
|
||||
**Priority Notice**
|
||||
Domain, ${{ matrix.domain }} will expire in ${{ steps.check-domain.outputs.paid-till-days-left }} days.
|
||||
@Lissy93 - Please take action immediately to prevent any downtime
|
||||
|
||||
- name: Raise issue if SSL Cert expiring soon
|
||||
if: ${{ steps.check-domain.outputs.ssl-expire-days-left && steps.check-domain.outputs.ssl-expire-days-left < 14 }}
|
||||
uses: rishabhgupta/git-action-issue@v2
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
assignees: Lissy93
|
||||
title: '[WEBSITE] SSL Cert Expiring Soon'
|
||||
body: >
|
||||
**Priority Notice**
|
||||
The SSL Certificate for ${{ matrix.domain }} will expire in ${{ steps.check-domain.outputs.ssl-expire-days-left }} days, on ${{ steps.check-domain.outputs.ssl-expire-date }}.
|
||||
@Lissy93 - Please take action immediately to prevent any downtime
|
||||
|
|
@ -42,8 +42,8 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
name: Inserts contributors into credits.md
|
||||
steps:
|
||||
- name: Contribute List - Credits Page
|
||||
uses: akhilmhdh/contributors-readme-action@v2.2
|
||||
- name: Contributer List - Credits Page
|
||||
uses: akhilmhdh/contributors-readme-action@v2.3.6
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
|
@ -51,6 +51,7 @@ jobs:
|
|||
readme_path: docs/credits.md
|
||||
columns_per_row: 6
|
||||
commit_message: ':purple_heart: Updates contributors list'
|
||||
collaborators: all
|
||||
committer_username: liss-bot
|
||||
committer_email: liss-bot@d0h.co
|
||||
- name: Sponsors List - Readme
|
||||
|
@ -65,18 +66,3 @@ jobs:
|
|||
committer_username: liss-bot
|
||||
committer_email: liss-bot@d0h.co
|
||||
|
||||
make-author-list:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: wow-actions/update-authors@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
sort: commits
|
||||
bots: true
|
||||
path: .github/AUTHORS.txt
|
||||
commit: ':blue_heart: Makes author list'
|
||||
template: '{{name}} <{{email}}> - {{commits}} commits'
|
||||
|
|
|
@ -1,37 +0,0 @@
|
|||
# Will add a comment and close any new issues opened by
|
||||
# users who have not yet committed to, or starred the repo
|
||||
name: 🎯 Issue Spam Control
|
||||
on:
|
||||
issues:
|
||||
types: [opened, reopened]
|
||||
jobs:
|
||||
check-user:
|
||||
if: >
|
||||
${{
|
||||
! contains( github.event.issue.labels.*.name, '📌 Keep Open') &&
|
||||
! contains( github.event.issue.labels.*.name, '🌈 Feedback') &&
|
||||
! contains( github.event.issue.labels.*.name, '💯 Showcase') &&
|
||||
github.event.comment.author_association != 'CONTRIBUTOR'
|
||||
}}
|
||||
runs-on: ubuntu-latest
|
||||
name: Close issue opened by non-stargazer
|
||||
steps:
|
||||
- name: close
|
||||
uses: uhyo/please-star-first@v1
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
message: |
|
||||
Welcome to Dashy 👋
|
||||
It's great to have you here, but unfortunately your ticket has been closed to prevent spam. Before reopening this issue, please ensure the following criteria are met.
|
||||
|
||||
Issues are sometimes closed when users:
|
||||
- Have only recently joined GitHub
|
||||
- Have not yet stared this repository
|
||||
- Have not previously interacted with the repo
|
||||
|
||||
Before you reopen this issue, please also ensure that:
|
||||
- You have checked that a similar issue does not already exist
|
||||
- You have checked the documentation for an existing solution
|
||||
- You have completed the relevant sections in the Issue template
|
||||
|
||||
Once you have verified the above standards are met, you may reopen this issue. Sorry for any inconvenience caused, I'm just a bot, and sometimes make mistakes 🤖
|
|
@ -1,18 +0,0 @@
|
|||
# Will translate any issues opened in foraign language, and add the English translation as a comment
|
||||
name: 🎯 Issue Translator
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
issues:
|
||||
types: [opened]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: tomsun28/issues-translate-action@v2.5
|
||||
with:
|
||||
BOT_GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
BOT_LOGIN_NAME: liss-bot
|
||||
IS_MODIFY_TITLE: true
|
||||
CUSTOM_BOT_NOTE: It looks like this issue isn't in English - not a problem, here's the translation! 🇬🇧
|
|
@ -1,16 +0,0 @@
|
|||
# Adds a label to any issues raised by a sponsor of Lissy93/Dashy
|
||||
# In order to allow their request can be prioritized
|
||||
name: 🎯 Label sponsors
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
build:
|
||||
name: is-sponsor-label
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: JasonEtco/is-sponsor-label-action@v1
|
||||
with:
|
||||
label: Priority Request - Sponsor 💖
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@ -1,18 +0,0 @@
|
|||
# Applies the 'Top Issue' label to tickets with most user reactions
|
||||
name: 🎯 Label Top Issues
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * *' # Run at 01:00 each day
|
||||
jobs:
|
||||
labelTopIssues:
|
||||
name: Label Top Issues
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Label Issues
|
||||
uses: adamzolyak/top-issues-action@master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
TOP_NUMBER_OF_ISSUES: 10
|
||||
TOP_LABEL_NAME: "👍 Top 10 Issue!"
|
||||
TOP_LABEL_COLOR: FBCA04
|
|
@ -19,13 +19,7 @@ jobs:
|
|||
|
||||
add-awaiting-author:
|
||||
runs-on: ubuntu-latest
|
||||
if: >
|
||||
${{
|
||||
!github.event.issue.pull_request
|
||||
&& github.event.comment.author_association != 'COLLABORATOR'
|
||||
&& github.event.comment.author_association != 'OWNER'
|
||||
&& github.event.issue.state === 'open'
|
||||
}}
|
||||
if: ${{!github.event.issue.pull_request && github.event.comment.author_association != 'COLLABORATOR' && github.event.comment.author_association != 'OWNER' && github.event.issue.state == 'open' }}
|
||||
steps:
|
||||
- name: Add Awaiting Author labels when Updated
|
||||
uses: actions-cool/issues-helper@v2
|
||||
|
|
|
@ -1,20 +0,0 @@
|
|||
# Detects offensive language in comments and takes reaction
|
||||
name: 🎯 Mind your language
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
jobs:
|
||||
echo_issue_comment:
|
||||
runs-on: ubuntu-latest
|
||||
name: profanity check
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Profanity check step
|
||||
uses: tailaiw/mind-your-language-action@v1.0.3
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -0,0 +1,16 @@
|
|||
# Pushes the contents of the repo to the Codeberg mirror
|
||||
name: 🪞 Mirror to Codeberg
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '30 3 * * 0' # At 03:30 on Sunday
|
||||
jobs:
|
||||
codeberg:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with: { fetch-depth: 0 }
|
||||
- uses: pixta-dev/repository-mirroring-action@v1
|
||||
with:
|
||||
target_repo_url: git@codeberg.org:alicia/dashy.git
|
||||
ssh_private_key: ${{ secrets.CODEBERG_SSH }}
|
|
@ -1,13 +0,0 @@
|
|||
# Adds comments to PR, based on which files are modified
|
||||
name: 💡 PR Commenter
|
||||
on: [ pull_request_target ]
|
||||
jobs:
|
||||
pr-comment:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: exercism/pr-commenter-action@v1.3.0
|
||||
with:
|
||||
github-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
config-file: .github/pr-auto-comments.yml
|
||||
template-variables: |
|
||||
{ "prAuthor": "${{ github.event.pull_request.user.login }}" }
|
|
@ -1,12 +0,0 @@
|
|||
# Labels pull requests based on their branch name
|
||||
name: 💡 PR Branch Labeler
|
||||
on: pull_request
|
||||
jobs:
|
||||
label-pr:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Label PR
|
||||
if: github.event.action == 'opened'
|
||||
uses: ffittschen/pr-branch-labeler@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -1,13 +0,0 @@
|
|||
# Finds any TO-DO notes within the code, and opens up an issue for it to be fixed
|
||||
name: 🌈 Open issue for Todos
|
||||
on: ["push"]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@master"
|
||||
- name: "TODO to Issue"
|
||||
uses: "alstr/todo-to-issue-action@v4.2"
|
||||
id: "todo"
|
||||
with:
|
||||
TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -10,10 +10,8 @@ jobs:
|
|||
- uses: apexskier/github-release-commenter@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
label-template: 🛩️ Released {release_tag}, 🔨 Fixed
|
||||
label-template: 🛩️ Released {release_tag}
|
||||
comment-template: |
|
||||
**The fix for this issue has now been released in {release_name} ✨**
|
||||
**This has now been released in {release_name} ✨**
|
||||
|
||||
If you haven't done so already, please [update your instance](https://github.com/Lissy93/dashy/blob/master/docs/management.md#updating) to `{release_tag}` or later. See {release_link} for full info.
|
||||
|
||||
Feel free to reach out if you need any more support. If you are enjoying Dashy, consider [supporting the project](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md#contributing).
|
||||
|
|
|
@ -1,92 +0,0 @@
|
|||
# Generates series of diagrams and visualizations
|
||||
name: 📊 Generate Repo Stats
|
||||
on:
|
||||
workflow_dispatch: # Manual dispatch
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
|
||||
jobs:
|
||||
# File structure chart
|
||||
file-structure:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@master
|
||||
- name: Generate File Structure Diagram
|
||||
uses: githubocto/repo-visualizer@0.7.1
|
||||
with:
|
||||
root_path: 'src/'
|
||||
output_file: docs/assets/repo-visualization.svg
|
||||
excluded_paths: dist,node_modules
|
||||
commit_message: ':yellow_heart: Updates repo diagram'
|
||||
branch: master
|
||||
|
||||
# Hercules git branching stats
|
||||
git-stats:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@master
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Hercules
|
||||
uses: src-d/hercules@master
|
||||
- uses: actions/upload-artifact@master
|
||||
with:
|
||||
name: hercules_charts
|
||||
path: hercules_charts.tar
|
||||
|
||||
# Lowlighter metrics community metrics
|
||||
community-stats:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@master
|
||||
- name: Generate Repo Metrics
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.LISSY93_PAT }}
|
||||
committer_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
committer_branch: master
|
||||
committer_message: ':purple_heart: Adds repo metrics'
|
||||
filename: docs/assets/repo-metrics.*
|
||||
template: classic
|
||||
user: Lissy93
|
||||
repo: dashy
|
||||
delay: 5
|
||||
|
||||
- name: Generate License Metrics
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.LISSY93_PAT }}
|
||||
committer_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
committer_branch: master
|
||||
committer_message: ':purple_heart: Adds license metrics'
|
||||
filename: docs/assets/license-metrics.*
|
||||
template: repository
|
||||
user: Lissy93
|
||||
repo: dashy
|
||||
delay: 5
|
||||
plugin_licenses: yes
|
||||
plugin_licenses_setup: yarn build
|
||||
plugin_licenses_ratio: yes
|
||||
plugin_licenses_legal: yes
|
||||
|
||||
- name: Generate Contributor Metrics
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.LISSY93_PAT }}
|
||||
committer_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
committer_branch: master
|
||||
committer_message: ':purple_heart: Adds contributor metrics'
|
||||
filename: docs/assets/controbutor-metrics.*
|
||||
user: Lissy93
|
||||
repo: dashy
|
||||
delay: 5
|
||||
plugin_contributors: yes
|
||||
plugin_contributors_base: ""
|
||||
plugin_contributors_head: master
|
||||
plugin_contributors_ignored: bot
|
||||
plugin_contributors_contributions: yes
|
||||
plugin_contributors_sections: contributors
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
name: 📊 Save Repo Analytics
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
jobs:
|
||||
gen-stats:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Repo Analytics
|
||||
uses: jgehrcke/github-repo-stats@HEAD
|
||||
with:
|
||||
repository: lissy93/dashy
|
||||
databranch: DATA/repo-stats
|
||||
ghtoken: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -1,19 +0,0 @@
|
|||
# Uses Snyk to check for potential vulnerabilities, then sends results to GH security tab
|
||||
name: 💡 Vulnerability Scanning
|
||||
on: push
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- name: Run Snyk to check for vulnerabilities
|
||||
uses: snyk/actions/node@master
|
||||
continue-on-error: true
|
||||
env:
|
||||
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
|
||||
with:
|
||||
args: --sarif-file-output=snyk.sarif
|
||||
- name: Upload result to GitHub Code Scanning
|
||||
uses: github/codeql-action/upload-sarif@v1
|
||||
with:
|
||||
sarif_file: snyk.sarif
|
|
@ -1,17 +0,0 @@
|
|||
# Expands any raw pasted link in comments. Useful so people know what they're clicking
|
||||
name: 🎯 Unfurl Links
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
jobs:
|
||||
run:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: wow-actions/unfurl-links@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
raw: true
|
|
@ -0,0 +1,58 @@
|
|||
name: 📝 Update Documentation
|
||||
|
||||
# This will run whenever the /docs directory in master branch is updated,
|
||||
# or if the workflow is manually dispatched, plus a sync check on Sun at 03:30 UTC
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '30 3 * * 0'
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
paths:
|
||||
- 'docs/**'
|
||||
|
||||
|
||||
# Jobs to be run:
|
||||
# 1. Checkout master branch
|
||||
# 2. Checkout website source code branch
|
||||
# 3. Install Python
|
||||
# 4. Copy /docs from master to website branch
|
||||
# 5. Run the script which processes documentation
|
||||
# 6. Commit and push updated docs to the website source code branch
|
||||
jobs:
|
||||
update-docs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout master branch 🛎️
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
path: 'master-docs'
|
||||
|
||||
- name: Checkout WEBSITE/docs-site-source branch 🛎️
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: 'WEBSITE/docs-site-source'
|
||||
path: 'website-docs'
|
||||
|
||||
- name: Install Python 🐍
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Run script to update documentation 🪄
|
||||
working-directory: website-docs
|
||||
run: |
|
||||
cp -r ../master-docs/docs ./
|
||||
python ./do-markdown-magic.py
|
||||
|
||||
- name: Commit changes 🚀
|
||||
run: |
|
||||
cd website-docs
|
||||
git config --local user.email "liss-bot@d0h.co"
|
||||
git config --local user.name "Liss-Bot"
|
||||
git add docs
|
||||
git commit -m "Update documentation" || echo "No changes to commit"
|
||||
git push
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
|
@ -0,0 +1,29 @@
|
|||
# Config for running Dashy in GitPod's cloud dev environment
|
||||
# Docs: https://www.gitpod.io/docs/references/gitpod-yml
|
||||
|
||||
# Commands to start on workspace startup
|
||||
tasks:
|
||||
- init: yarn install
|
||||
command: yarn dev
|
||||
# Ports to expose on workspace startup
|
||||
ports:
|
||||
- port: 8080 # Default dev server
|
||||
visibility: private
|
||||
onOpen: open-preview
|
||||
- port: 4000 # Default prod server
|
||||
visibility: public
|
||||
onOpen: open-preview
|
||||
prebuilds:
|
||||
# Adds 'Open in GitPod' to PRs
|
||||
addBadge: true
|
||||
addComment: false
|
||||
vscode:
|
||||
# Adds Vue.js and formatting extensions
|
||||
extensions:
|
||||
- octref.vetur
|
||||
- dbaeumer.vscode-eslint
|
||||
- streetsidesoftware.code-spell-checker
|
||||
- PKief.material-icon-theme
|
||||
- wix.vscode-import-cost
|
||||
- oderwat.indent-rainbow
|
||||
- eamodio.gitlens
|
|
@ -0,0 +1 @@
|
|||
nodeLinker: node-modules
|
58
Dockerfile
|
@ -1,31 +1,51 @@
|
|||
FROM node:lts-alpine3.14
|
||||
FROM node:18.19.1-alpine AS BUILD_IMAGE
|
||||
|
||||
# Set the platform to build image for
|
||||
ARG TARGETPLATFORM
|
||||
ENV TARGETPLATFORM=${TARGETPLATFORM:-linux/amd64}
|
||||
|
||||
# Install additional tools needed if on arm64 / armv7
|
||||
RUN \
|
||||
case "${TARGETPLATFORM}" in \
|
||||
'linux/arm64') apk add --no-cache python3 make g++ ;; \
|
||||
'linux/arm/v7') apk add --no-cache python3 make g++ ;; \
|
||||
esac
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR /app
|
||||
|
||||
# Install app dependencies
|
||||
COPY package.json yarn.lock ./
|
||||
RUN yarn install --ignore-engines --immutable --no-cache --network-timeout 300000 --network-concurrency 1
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . ./
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build --mode production
|
||||
|
||||
# Production stage
|
||||
FROM node:20.11.1-alpine3.19
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
ENV PORT=8080 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Copy over both 'package.json' and 'package-lock.json' (if available)
|
||||
COPY package*.json ./
|
||||
COPY yarn.lock ./
|
||||
# Update tzdata for setting timezone
|
||||
RUN apk add --no-cache tzdata
|
||||
|
||||
# Install project dependencies
|
||||
RUN yarn
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . .
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
# Copy built application from build phase
|
||||
COPY --from=BUILD_IMAGE /app ./
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
CMD [ "yarn", "build-and-start"]
|
||||
CMD [ "yarn", "build-and-start" ]
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
||||
# Expose the port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check that everythings still great
|
||||
HEALTHCHECK --interval=5m --timeout=5s --start-period=30s CMD yarn health-check
|
||||
|
|
2
LICENSE
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2021 Alicia Sykes <https://aliciasykes.com>
|
||||
Copyright (c) 2021-2024 Alicia Sykes <https://aliciasykes.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
5
Procfile
|
@ -1,4 +1 @@
|
|||
# Heroku config - Specifies the commands to execute when the app starts
|
||||
# See docs for more info: https://devcenter.heroku.com/articles/procfile
|
||||
|
||||
web: node server.js
|
||||
web: npm run build-and-start
|
||||
|
|
538
README.md
|
@ -5,30 +5,23 @@
|
|||
<br/>
|
||||
<img width="120" src="https://i.ibb.co/yhbt6CY/dashy.png" />
|
||||
<br/>
|
||||
<b><a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md">User Showcase</a></b> | <b><a href="https://demo.dashy.to">Live Demo</a></b> | <b><a href="https://github.com/Lissy93/dashy/blob/master/docs/quick-start.md">Getting Started</a></b> | <b><a href="https://dashy.to/docs">Documentation</a></b> | <b><a href="https://github.com/Lissy93/dashy">GitHub</a></b>
|
||||
<br/><br/>
|
||||
<a href="https://github.com/awesome-selfhosted/awesome-selfhosted#personal-dashboards">
|
||||
<img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome Self-Hosted">
|
||||
</a>
|
||||
<a href="https://github.com/Lissy93/dashy/blob/master/LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-MIT-0aa8d2?logo=opensourceinitiative&logoColor=fff" alt="License MIT">
|
||||
</a>
|
||||
<a href="https://github.com/Lissy93/dashy/blob/master/.github/CHANGELOG.md">
|
||||
<img src="https://img.shields.io/github/package-json/v/lissy93/dashy?logo=azurepipelines&color=0aa8d2" alt="Current Version">
|
||||
</a>
|
||||
<a href="https://hub.docker.com/r/lissy93/dashy">
|
||||
<img src="https://img.shields.io/docker/pulls/lissy93/dashy?logo=docker&color=0aa8d2&logoColor=fff" alt="Docker Pulls">
|
||||
</a>
|
||||
<a href="http://as93.link/dashy-build-status">
|
||||
<img src="https://badgen.net/github/status/lissy93/dashy?icon=github" alt="GitHub Status">
|
||||
</a>
|
||||
<a href="https://snyk.io/test/github/lissy93/dashy">
|
||||
<img src="https://snyk.io/test/github/lissy93/dashy/badge.svg" alt="Known Vulnerabilities">
|
||||
</a>
|
||||
<b><a href="./docs/showcase.md">User Showcase</a></b> | <b><a href="https://demo.dashy.to">Live Demo</a></b> | <b><a href="./docs/quick-start.md">Getting Started</a></b> | <b><a href="https://dashy.to/docs">Documentation</a></b> | <b><a href="https://github.com/Lissy93/dashy">GitHub</a></b>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<sup>Dashy is kindly sponsored by <a href="https://umbrel.com?ref=dashy">Umbrel</a> - the personal home cloud and OS for self-hosting</sup><br>
|
||||
<a href="https://umbrel.com?ref=dashy">
|
||||
<img width="400" src="https://github.com/Lissy93/dashy/blob/WEBSITE/docs-site-source/static/umbrel-banner.jpg?raw=true" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
> [!NOTE]
|
||||
> Version [3.0.0](https://github.com/Lissy93/dashy/releases/tag/3.0.0) has been released, and requires some changes to your setup, see [#1529](https://github.com/Lissy93/dashy/discussions/1529) for details.
|
||||
|
||||
|
||||
<details>
|
||||
<summary><b>Contents</b></summary>
|
||||
<summary><b>Table of Contents</b></summary>
|
||||
<p>
|
||||
|
||||
- **Getting Started**
|
||||
|
@ -40,18 +33,18 @@
|
|||
- [🎨 Theming](#theming-)
|
||||
- [🧸 Icons](#icons-)
|
||||
- [🚦 Status Indicators](#status-indicators-)
|
||||
- [💂 Authentication](#authentication-)
|
||||
- [🖱️ Opening Methods](#opening-methods-%EF%B8%8F)
|
||||
- [📊 Widgets](#widgets-)
|
||||
- [🔐 Authentication](#authentication-)
|
||||
- [👓 Alternate Views](#alternate-views-)
|
||||
- [🖱️ Opening Methods](#opening-methods-)
|
||||
- [🔎 Searching and Shortcuts](#searching-and-shortcuts-)
|
||||
- [⚙️ Config Editor](#config-editor-%EF%B8%8F)
|
||||
- [⚙️ Config Editor](#config-editor-)
|
||||
- [☁ Cloud Backup & Sync](#cloud-backup--sync-)
|
||||
- [🌎 Language Switching](#language-switching-)
|
||||
- [🌳 Dashboard Info](#setting-dashboard-info-)
|
||||
- [📃 Multi-Page Support](#multi-page-support-)
|
||||
- **Community**
|
||||
- [📊 System Requirements](#system-requirements-)
|
||||
- [🙋♀️ Getting Help](#getting-help-%EF%B8%8F)
|
||||
- [🐛 Raising Issues](#raising-issues-)
|
||||
- [🙋♀️ Support](#support-)
|
||||
- [💖 Supporting Dashy](#supporting-dashy-)
|
||||
- [🏆 Credits](#credits-)
|
||||
- [🧱 Developing](#developing-)
|
||||
|
@ -65,34 +58,37 @@
|
|||
</details>
|
||||
|
||||
## Features 🌈
|
||||
|
||||
- 🔎 Instant search by name, domain or tags + customizable hotkeys & keyboard shortcuts
|
||||
- 🎨 Multiple built-in color themes, with UI color editor and support for custom CSS
|
||||
- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching favicon, images, emojis, etc.
|
||||
- 🚦 Status monitoring for each of your apps / links for basic availability and uptime checking
|
||||
- 💂 Optional authentication with multi-user access, configurable privileges and SSO support
|
||||
- 📃 Support for multiple pages
|
||||
- 🚦 Real-time status monitoring for each of your apps/links
|
||||
- 📊 Use widgets to display info and dynamic content from self-hosted services
|
||||
- 🔎 Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts
|
||||
- 🎨 Many built-in color themes, with UI color editor and support for custom CSS
|
||||
- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.
|
||||
- 💂 Optional authentication with multi-user access, configurable privileges, and SSO support
|
||||
- 🌎 Multi-language support, with 10+ human-translated languages, and more on the way
|
||||
- ☁ Optional, encrypted, free off-site cloud backup and restore feature available
|
||||
- 💼 A workspace view, for easily switching between multiple apps at simultaneously
|
||||
- 🛩️ A minimal view, for use as a fast-loading browser startpage
|
||||
- 🖱️ Choose app launch method, either new tab, same tab, a pop-up modal or in the workspace view
|
||||
- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior etc.
|
||||
- 🖼️ Option for full-screen background image, custom nav-bar links, html footer, title, etc.
|
||||
- 💼 A workspace view, for easily switching between multiple apps simultaneously
|
||||
- 🛩️ A minimal view, for use as a fast-loading browser Startpage
|
||||
- 🖱️ Choose app launch methods: new tab, same tab, clipboard, pop-up modal, or open in workspace view
|
||||
- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior, etc.
|
||||
- 🖼️ Options for a full-screen background image, custom nav-bar links, HTML footer, title, etc.
|
||||
- 🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
|
||||
- ⚙️ Easy single-file YAML-based configuration, and option to configure app through the UI
|
||||
- ✨ Under active development with improvements and new features added regularly
|
||||
- 🤏 Small bundle size, fully responsive UI and PWA for basic offline access
|
||||
- 🆓 100% free and open source
|
||||
- 🤏 Small bundle size, fully responsive UI, and PWA for basic offline access
|
||||
- 🆓 100% free and open-source
|
||||
- 🔐 Strong focus on privacy
|
||||
- 🌈 And loads more...
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
## Demo ⚡
|
||||
|
||||
**Live Instances**: [Demo 1](https://demo.dashy.to) (Live Demo) ┆ [Demo 2](https://live.dashy.to) (Dashy Links) ┆ [Demo 3](https://dev.dashy.to) (Dev Preview)
|
||||
|
||||
**Screenshots**: Checkout the [Showcase](./docs/showcase.md), to see example dashboards from the community
|
||||
|
||||
**Spin up your own demo**: [![One-Click Deploy with PWD](https://img.shields.io/badge/Play--with--Docker-Deploy-2496ed?style=flat-square&logo=docker)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:80 lissy93/dashy`](./docs/quick-start.md)
|
||||
**Spin up your own demo**: [![One-Click Deploy with PWD](https://img.shields.io/badge/Play--with--Docker-Deploy-2496ed?style=flat-square&logo=docker)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:8080 lissy93/dashy`](./docs/quick-start.md)
|
||||
|
||||
|
||||
<p align="center">
|
||||
|
@ -104,7 +100,7 @@
|
|||
|
||||
---
|
||||
|
||||
## Getting Started 🛫
|
||||
## Getting Started 🚀
|
||||
|
||||
> For full setup instructions, see: [**Deployment**](./docs/deployment.md)
|
||||
|
||||
|
@ -113,46 +109,48 @@
|
|||
You will need [Docker](https://docs.docker.com/get-docker/) installed on your system
|
||||
|
||||
```
|
||||
docker run -p 8080:80 lissy93/dashy
|
||||
docker run -p 8080:8080 lissy93/dashy
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```docker
|
||||
docker run -d \
|
||||
-p 4000:80 \
|
||||
-v /root/my-local-conf.yml:/app/public/conf.yml \
|
||||
-p 4000:8080 \
|
||||
-v /root/my-local-conf.yml:/app/user-data/conf.yml \
|
||||
--name my-dashboard \
|
||||
--restart=always \
|
||||
lissy93/dashy:latest
|
||||
```
|
||||
[![Dashy on Docker Hub](https://dockeri.co/image/lissy93/dashy)](https://hub.docker.com/r/lissy93/dashy)
|
||||
|
||||
See also examples [with Docker Compose](./docs/deployment.md#using-docker-compose). Dashy is also available via GHCR, and tags for other architectures (`arm32-7`, `arm64-v8`, etc) and set versions are supported
|
||||
See also: [examples with Docker Compose](./docs/deployment.md#using-docker-compose). Dashy is also available via GHCR, and tags for other architectures (`arm32v7`, `arm64v8`, etc.) and set versions are supported
|
||||
|
||||
> Once you've got Dashy running, see [App Management Docs](./docs/management.md), for info on using health checks, updating, backups, web-server configs, logs, performance, security and more.
|
||||
> Once you've got Dashy running, see [App Management Docs](./docs/management.md) for info on using health checks, updating, backups, web-server configs, logs, performance, security, and more.
|
||||
|
||||
### Deploying from Source 🚀
|
||||
### Deploying from Source 🔨
|
||||
|
||||
You will need [git](https://git-scm.com/downloads), the latest or LTS version of [Node.js](https://nodejs.org/) and (optionally) [Yarn](https://yarnpkg.com/) installed on your system.
|
||||
You will need [git](https://git-scm.com/downloads), the latest or LTS version of [Node.js](https://nodejs.org/) and _(optionally)_ [Yarn](https://yarnpkg.com/) installed on your system.
|
||||
|
||||
- Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
|
||||
- Configuration: Fill in you're settings in `./public/conf.yml`
|
||||
- Clone the Repo: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
|
||||
- Configuration: Fill in your settings in `./user-data/conf.yml`
|
||||
- Install dependencies: `yarn`
|
||||
- Build: `yarn build`
|
||||
- Run: `yarn start`
|
||||
|
||||
> See docs [Full list of Dashy's commands](./docs/management.md#basic-commands)
|
||||
> See docs: [Full list of Dashy's commands](./docs/management.md#basic-commands)
|
||||
|
||||
### Deploy to the Cloud ☁️
|
||||
|
||||
Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:
|
||||
Dashy supports **1-Click deployments** on several popular cloud platforms. To spin up a new instance, just click a link below:
|
||||
- [<img src="https://i.ibb.co/ZxtzrP3/netlify.png" width="18"/> Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
|
||||
- [<img src="https://i.ibb.co/d2P1WZ7/heroku.png" width="18"/> Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
|
||||
- [<img src="https://i.ibb.co/Ld2FZzb/vercel.png" width="18"/> Deploy to Vercel](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
|
||||
- [<img src="https://i.ibb.co/xCHtzgh/render.png" width="18"/> Deploy to Render](https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render)
|
||||
- [<img src="https://railway.app/brand/logo-light.png" width="18"/> Deploy to Railway](https://railway.app/template/MtdjAQ?referralCode=app)
|
||||
- [<img src="https://i.ibb.co/J7MGymY/googlecloud.png" width="18"/> Deploy to GCP](https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git)
|
||||
- [<img src="https://i.ibb.co/HVWVYF7/docker.png" width="18"/> Deploy to PWD](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
- [<img src="https://i.ibb.co/7NxnM2P/easypanel.png" width="18"/> Deploy to Easypanel](https://easypanel.io/docs/templates/dashy)
|
||||
|
||||
> For more 1-click cloud deployments, see [Cloud Deployment](./docs/deployment.md#deploy-to-cloud-service)
|
||||
|
||||
|
@ -164,7 +162,7 @@ Dashy supports 1-Click deployments on several popular cloud platforms. To spin u
|
|||
|
||||
> For full configuration documentation, see: [**Configuring**](./docs/configuring.md)
|
||||
|
||||
Dashy is configured through a YAML file, located at `./public/conf.yml`. You can find a complete list of available options in th [Configuring Docs](/docs/configuring.md). The config can also be edited and saved directly through the UI.
|
||||
Dashy is configured through a YAML file, located at `./user-data/conf.yml`. In addition, you can find a complete list of available options in the [Configuring Docs](./docs/configuring.md). The config can also be edited and saved directly through the UI.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
|
@ -174,7 +172,7 @@ Dashy is configured through a YAML file, located at `./public/conf.yml`. You can
|
|||
|
||||
> For full theming documentation, see: [**Theming**](./docs/theming.md)
|
||||
|
||||
Dashy comes pre-bundled with several built-in themes, which you can preview, applied and edited through the UI. With the theme configurator, and support for custom CSS, everything is in place for you to easily develop your own unique looking dashboard.
|
||||
Dashy comes pre-bundled with several built-in themes, which you can preview, apply and edit through the UI. With the theme configurator and support for custom CSS, everything is in place to quickly develop your own unique-looking dashboard.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://i.ibb.co/BVSHV1v/dashy-themes-slideshow.gif">
|
||||
|
@ -199,12 +197,12 @@ Dashy comes pre-bundled with several built-in themes, which you can preview, app
|
|||
Both sections and items can have an icon associated with them, defined under the `icon` attribute. With several different icon packs supported, you'll be able to find the perfect thumbnail for any app or service.
|
||||
|
||||
The following icon types are supported:
|
||||
- **Favicon** - Automatically fetch an apps icon from it's favicon or logo image
|
||||
- **Favicon** - Automatically fetch an apps icon from its Favicon or logo image
|
||||
- **Icon Packs** - Use any icon from [font-awesome], [simple-icons] or [material icons]
|
||||
- **Emoji** - Any valid emoji can be used as an icon
|
||||
- **Generative** - Unique, auto-generated images for easily identifying services
|
||||
- **URL** - Pass the URL of any valid image in to have it fetched and rendered
|
||||
- **Local** - Store custom images locally, and reference by filename
|
||||
- **Local** - Store custom images locally and reference by filename
|
||||
- **Homelab Icons** - Using [dashboard-icons] for logos of commonly self-hosted services
|
||||
|
||||
|
||||
|
@ -227,9 +225,9 @@ The following icon types are supported:
|
|||
|
||||
> For full monitoring documentation, see: [**Status Indicators**](./docs/status-indicators.md)
|
||||
|
||||
Dashy has an optional feature that can check if each app/ service is up and responding, then display a small status indicator icon. Hovering over it will show additional stats like response time and status code.
|
||||
Dashy has an optional feature to check if each app/ service is up and responding, then display a small status indicator icon. Hovering over it will show additional stats like response time and status code.
|
||||
|
||||
Status indicators can be globally enabled by setting `appConfig.statusCheck: true`, or enabled/ disabled on a per-item basis. Status is checked on page load, but you can enable continuous polling by specifying a time interval between checks, in seconds under `appConfig.statusCheckInterval`. You can also use a different endpoint for status checking, with `statusCheckUrl`, and if needed pass in custom headers under `statusCheckHeaders`.
|
||||
Status indicators can be globally enabled by setting `appConfig.statusCheck: true` or enabled/ disabled on a per-item basis. Status is checked on page load, but you can allow continuous polling by specifying a time interval between checks, in seconds under `appConfig.statusCheckInterval`. You can also use a different endpoint for status checking, with `statusCheckUrl`, and if needed, pass in custom headers under `statusCheckHeaders`.
|
||||
|
||||
<p align="center">
|
||||
<img alt="Status Checks demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/status-check-demo.gif" width="600" />
|
||||
|
@ -239,13 +237,29 @@ Status indicators can be globally enabled by setting `appConfig.statusCheck: tru
|
|||
|
||||
---
|
||||
|
||||
## Authentication 💂
|
||||
## Widgets 📊
|
||||
|
||||
> For full widget documentation, see: [**Widgets**](./docs/widgets.md)
|
||||
|
||||
You can display dynamic content from services in the form of widgets. There are several pre-built widgets availible for showing useful info, and integrations with commonly self-hosted services, but you can also easily create your own for almost any app.
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img width="600" src="https://i.ibb.co/GFjXVHy/dashy-widgets.png" />
|
||||
</p>
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Authentication 🔐
|
||||
|
||||
> For full authentication documentation, see: [**Authentication**](./docs/authentication.md)
|
||||
|
||||
Dashy has full support for secure single-sign-on using [Keycloak](https://www.keycloak.org/) for secure, easy authentication, see [setup docs](/docs/authentication.md#keycloak) for a full usage guide.
|
||||
|
||||
There is also a basic auth feature, which doesn't require any additional setup. To enable this, just add an `auth` attribute under `appConfig`, containing an array of `users`, each with a username, SHA-256 hashed password and optional user type. Basic auth also has support for several access control features, including read-only guest access and granular controls.
|
||||
There is also a basic auth feature, which doesn't require additional setup. To enable this, add an `auth` attribute under `appConfig`, containing an array of `users`, each with a username, SHA-256 hashed password and optional user type. Basic auth also supports several access control features, including read-only guest access and granular controls.
|
||||
|
||||
|
||||
```yaml
|
||||
|
@ -266,10 +280,10 @@ Other access control systems are also supported, see the [Alternative Auth Metho
|
|||
## Alternate Views 👓
|
||||
|
||||
As well as the default homepage, there is also:
|
||||
- A minimal view, useful for use as a browser start page
|
||||
- A minimal view, valid for use as a browser start page
|
||||
- A workspace view, useful for visiting many apps simultaneously
|
||||
|
||||
You can change the view from the UI, using the switch icon in the top-right corner, or select a default view in the config, under `appConfig.startingView` attribute.
|
||||
You can change the view from the UI, using the switch icon in the top-right corner, or select a default view in the config under `appConfig.startingView` attribute.
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Workspace View</b><br>
|
||||
|
@ -289,12 +303,15 @@ You can change the view from the UI, using the switch icon in the top-right corn
|
|||
|
||||
> For full documentation on views and opening methods, see: [**Alternate Views**](./docs/alternate-views.md)
|
||||
|
||||
There are several different ways apps can be launched. You can specify the default opening method for any given item under the `target` attribute, or set a site-wide default under `appConfig.defaultOpeningMethod`. Right-click on an item to item for all options. The following options are supported:
|
||||
There are several different ways you can launch apps. You can specify the default opening method for any given item under the `target` attribute or set a site-wide default under `appConfig.defaultOpeningMethod`. Right-click on an item to item for all options. The following options are supported:
|
||||
- `sametab` - The app will be launched in the current tab
|
||||
- `newtab` - The app will be launched in a new tab (or use Ctrl + Click)
|
||||
- `modal` - Launch app in a resizable/ movable popup modal on the current page (or use Alt + Click)
|
||||
- `workspace` - Changes to Workspace view, and launches app
|
||||
- `top` - Opens in the top-most browsing context, useful if your accessing Dashy through an iframe
|
||||
- `workspace` - Changes to Workspace view and launches app
|
||||
- `clipboard` - Copy the app's URL to your system clipboard
|
||||
- `top` - Opens in the top-most browsing context, useful if you're accessing Dashy through an iframe
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
|
@ -302,13 +319,13 @@ There are several different ways apps can be launched. You can specify the defau
|
|||
|
||||
> For full documentation on searching, see: [**Searching & Shortcuts**](./docs/searching.md)
|
||||
|
||||
Quickly finding and launching applications is the primary aim of Dashy. To that end instant search and customizable keyboard shortcuts are built-in.
|
||||
Quickly finding and launching applications is the primary aim of Dashy. To that end, instant search and customizable keyboard shortcuts are built-in.
|
||||
|
||||
To start filtering, just start typing. No need to select the search bar or use any special key. Then use either the tab key or arrow keys to select and move between results, and hit enter to launch the currently selected application.
|
||||
To start filtering, start typing—no need to select the search bar or use any special key. Then use either the tab key or arrow keys to select and move between results, and hit enter to launch the currently selected application.
|
||||
|
||||
For apps that you use regularly, you can set a custom keybinding. Use the `hotkey` parameter on a certain item to specify a numeric key, between `0 - 9`. You can then launch that app, by just pressing that key.
|
||||
For apps that you use regularly, you can set a custom keybinding. Use the `hotkey` parameter on a certain item to specify a numeric key between `0 - 9`. You can then launch that app by just pressing that key.
|
||||
|
||||
You can also add custom tags to a given item, to make finding them based on keywords easier. For example, in the following example, searching for 'Movies' will show 'Plex'
|
||||
You can also add custom tags to a given item to make finding them based on keywords easier. For example, in the following example, searching for 'Movies' will show 'Plex'
|
||||
|
||||
```yaml
|
||||
items:
|
||||
|
@ -320,7 +337,7 @@ You can also add custom tags to a given item, to make finding them based on keyw
|
|||
tags: [ movies, videos, music ]
|
||||
```
|
||||
|
||||
To search the web directly through Dashy, just press enter after typing your query. Options for web search are set under `appConfig.webSearch`. There is built in support for [10+ search engines](./docs/searching.md#setting-search-engine), or [use your own custom provider](./docs/searching.md#using-custom-search-engine) or self-hosted instance. With the web search, you can also define your own bangs, to redirect results to any given app, website or search engine, when the query is preceded with a certain character sequence (usually beginning in `/`, `!` or `:`).
|
||||
To search the web directly through Dashy, just press enter after typing your query. Options for web search are set under `appConfig.webSearch`. There is built-in support for [10+ search engines](./docs/searching.md#setting-search-engine), or [use your own custom provider](./docs/searching.md#using-custom-search-engine) or self-hosted instance. With the web search, you can also define your bangs to redirect results to any given app, website, or search engine, when the query is preceded with a certain character sequence (usually beginning in `/`, `!` or `:`).
|
||||
|
||||
```yaml
|
||||
webSearch:
|
||||
|
@ -335,7 +352,7 @@ webSearch:
|
|||
':git': github
|
||||
```
|
||||
|
||||
Hit `Esc` at anytime to close any open apps, clear the search field, or hide any modals.
|
||||
Hit `Esc` at any time to close any open apps, clear the search field, or hide any modals.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
|
@ -344,11 +361,11 @@ Hit `Esc` at anytime to close any open apps, clear the search field, or hide any
|
|||
## Config Editor ⚙️
|
||||
> For full config documentation, see: [**Configuring**](./docs/configuring.md)
|
||||
|
||||
As well as passing in a YAML config file, you can also configure the app directly through the UI, and preview changes live.
|
||||
As well as passing in a YAML config file, you can also configure the app directly through the UI and preview changes live.
|
||||
|
||||
To edit any section or item, right-click on it, and select "Edit", or enter the Edit Mode (using the Pen icon in the top-right), then click any part of the page to edit. Changes will be visible immediately, but will not be saved until you click "Save to Disk" or "Save Locally".
|
||||
To edit any section or item, right-click on it, and select "Edit", or enter the Edit Mode (using the Pen icon in the top-right), then click any part of the page to edit. Changes will be visible immediately but will not be saved until clicking "Save to Disk" or "Save Locally".
|
||||
|
||||
Under the config menu, you can export, view, backup, or reset app config, as well as edit the raw config file in a text editor, with built-in schema validation. It's recommended to keep a backup of your config.
|
||||
Under the config menu, you can export, view, backup, or reset app config and edit the raw config file in a text editor with built-in schema validation. It's recommended to keep a backup of your config.
|
||||
|
||||
<p align="center">
|
||||
<img alt="Interactive Editor demo" src="https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif" width="600" />
|
||||
|
@ -367,9 +384,9 @@ Under the config menu, you can export, view, backup, or reset app config, as wel
|
|||
|
||||
> For full backup documentation, see: [**Cloud Backup & Sync**](./docs/backup-restore.md)
|
||||
|
||||
Dashy has an **optional** built-in feature for securely backing up your config to a hosted cloud service, and then restoring it on another instance. This is useful not only for backing up your configuration off-site, but it also enables Dashy to be used without having write a YAML config file.
|
||||
Dashy has an **optional** built-in feature for securely backing up your config to a hosted cloud service and then restoring it on another instance. This is useful not only for backing up your configuration off-site but also enables Dashy to be used without having to write a YAML config file.
|
||||
|
||||
All data is fully E2E encrypted before being sent to the backend (done in [`CloudBackup.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js) using [crypto.js](https://github.com/brix/crypto-js)'s AES method). The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works), and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store.
|
||||
All data is fully E2E encrypted before being sent to the backend (done in [`CloudBackup.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js) using [crypto.js](https://github.com/brix/crypto-js) 's AES method). The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
|
@ -378,35 +395,79 @@ All data is fully E2E encrypted before being sent to the backend (done in [`Clou
|
|||
## Language Switching 🌎
|
||||
> For full internationalization documentation, see: [**Multi-Language Support**](./docs/multi-language-support.md)
|
||||
|
||||
Dashy supports multiple languages and locales. When available, your language should be automatically detected and applied on load. But you can also select a language through the UI (under Config --> Switch Language), or set `appConfig.language` to your language (specified as a 2-digit [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)).
|
||||
Dashy supports multiple languages and locales. When available, your language should be automatically detected and applied on load. But you can also select a language through the UI (under config --> Switch Language) or set `appConfig.language` to your language (specified as a 2-digit [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)), as seen below, e.g. `language: de`.
|
||||
|
||||
#### Supported Languages
|
||||
- 🇬🇧 **English**: `en` - _Default_
|
||||
- 🇦🇪 **Arabic**: `ar` - _Auto-generated_
|
||||
- 🇧🇩 **Bengali**: `bn` - Contributed by **[@soaibsafi](https://github.com/soaibsafi)**
|
||||
- 🇧🇬 **Bulgarian**: `bg` - Contributed by **[@asenov](https://github.com/asenov)**
|
||||
- 🇨🇳 **Chinese**: `cn` - Contributed by **[@FormatToday](https://github.com/FormatToday)**
|
||||
- 🇨🇿 **Czech**: `cs` - Contributed by **[@Tuzi555](https://github.com/Tuzi555)**
|
||||
- 🇩🇰 **Danish**: `da` - Contributed by **[@lordpansar](https://github.com/lordpansar)**
|
||||
- 🇳🇱 **Dutch**: `nl` - Contributed by **[@evroon](https://github.com/evroon)**
|
||||
- 🇲🇫 **French**: `fr` - Contributed by **[@EVOTk](https://github.com/EVOTk)**
|
||||
- 🇫🇷 **French**: `fr` - Contributed by **[@EVOTk](https://github.com/EVOTk)**
|
||||
- 🇩🇪 **German**: `de` - Contributed by **[@Niklashere](https://github.com/Niklashere)**
|
||||
- 🇬🇷 **Greek**: `el` - Contributed by **[@aviolaris](https://github.com/aviolaris)**
|
||||
- 🇮🇳 **Hindi**: `hi` - _Auto-generated_
|
||||
- 🇮🇹 **Italian**: `it` - Contributed by **[@alexdelprete](https://github.com/alexdelprete)**
|
||||
- 🇯🇵 **Japanese**: `ja` - _Auto-generated_
|
||||
- 🇰🇷 **Korean**: `ko` - Contributed by **[@boggy-cs](https://github.com/boggy-cs)**
|
||||
- 🇳🇴 **Norwegian Bokmål**: `nb` - Contributed by **[@rubjo](https://github.com/rubjo)**
|
||||
- 🇵🇱 **Polish**: `pl` - Contributed by **[@skaarj1989](https://github.com/skaarj1989)**
|
||||
- 🇪🇸 **Spanish**: `es` - Contributed by **[@lu4t](https://github.com/lu4t)**
|
||||
- 🇵🇹 **Portuguese**: `pt` - Contributed by **[@LeoColman](https://github.com/LeoColman)**
|
||||
- 🛰️ **Galician**: `gl` - Contributed by **[@pvillaverde](https://github.com/pvillaverde)**
|
||||
- 🇷🇺 **Russian**: `ru` - _Auto-generated_
|
||||
- 🇸🇰 **Slovak**: `sk` - Contributed by **[@Smexhy](https://github.com/Smexhy)**
|
||||
- 🇸🇮 **Slovenian**: `sl` - Contributed by **[@UrekD](https://github.com/UrekD)**
|
||||
- 🇮🇹 **Italian**: `it` - Machine Translated *(awaiting human review)*
|
||||
- 🇵🇹 **Portuguese**: `pt` - Machine Translated *(awaiting human review)*
|
||||
- 🇷🇺 **Russian**: `ru` - Contributed by Anon
|
||||
- 🇦🇪 **Arabic**: `ar` - Contributed by Anon
|
||||
- 🇮🇳 **Hindi**: `hi` - Contributed by Anon
|
||||
- 🇯🇵 **Japanese**: `ja` - Contributed by Anon
|
||||
- 🇪🇸 **Spanish**: `es` - Contributed by **[@lu4t](https://github.com/lu4t)**
|
||||
- 🇸🇪 **Swedish**: `sv` - Contributed by **[@BOZG](https://github.com/BOZG)**
|
||||
- 🇹🇼 **Traditional Chinese**: `zh-TW` - Contributed by **[@stanly0726](https://github.com/stanly0726)**
|
||||
- 🇹🇷 **Turkish**: `tr` - Contributed by **[@imsakg](https://github.com/imsakg)**
|
||||
- 🏴☠️ **Pirate**: `pirate` - Contributed by **[@Lissy93](https://github.com/lissy93)**
|
||||
|
||||
#### Add your Language
|
||||
I would love Dashy to be available to everyone, without language being a barrier to entry. If you've got a few minutes to spare, consider adding translations for your language. It's a quick task and all text is in [a single JSON file](https://github.com/Lissy93/dashy/tree/master/src/assets/locales). Since any missing text will fallback to English, you don't need to translate it all.
|
||||
I would love Dashy to be available to everyone without language being a barrier to entry. If you've got a few minutes to spare, consider adding translations for your language. It's a quick task, and all text is in [a single JSON file](https://github.com/Lissy93/dashy/tree/master/src/assets/locales). Since any missing text will fall back to English, you don't need to translate it all.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Multi-Page Support 📃
|
||||
|
||||
> For full multi-page documentation, see: [**Pages & Sections**](./docs/pages-and-sections.md)
|
||||
|
||||
Within your dashboard, you can have as many sub-pages as you require. To load additional pages, specify a name, and path to a config file under `pages`. The config file can be either local (stored in `/public`), or remote (located anywhere accessible).
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Networking Services
|
||||
path: 'networking.yml'
|
||||
- name: Work Stuff
|
||||
path: 'work.yml'
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Getting Started
|
||||
path: 'https://snippet.host/tvcw/raw'
|
||||
- name: Homelab
|
||||
path: 'https://snippet.host/tetp/raw'
|
||||
- name: Browser Startpage
|
||||
path: 'https://snippet.host/zcom/raw'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## System Requirements 📊
|
||||
|
||||
The hardware requirements vary depending on where and how you are running Dashy. Generally speaking, on a bare metal system or Docker container, 1GB of memory should be more than enough, and depending on whether you are using your own assets, then 1GB of disk space should be sufficient.
|
||||
If running on bare metal, Dashy requires [Node](https://nodejs.org/en/) V 16.0.0 or later, LTS (16.13.2) is recommended.
|
||||
|
||||
If running in Docker container, the recommended base image is Alpine (3.15)
|
||||
|
||||
The hardware requirements vary depending on where and how you are running Dashy. Generally speaking, on a bare-metal system or Docker container, 1GB of memory should be more than enough, and depending on whether you are using your own assets, then 1GB of disk space should be sufficient.
|
||||
|
||||
If you are using one of the 1-click cloud deployment methods, serving the app through a CDN or using a static hosting provider, then there are no specific requirements, as the built app is just a series of static JS files, and so is very light-weight.
|
||||
|
||||
|
@ -415,7 +476,9 @@ Dashy also wells run on low-powered ARM-based single board computers, such as a
|
|||
**Browser Support**
|
||||
![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![IE](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)
|
||||
--- | --- | --- | --- | --- |
|
||||
Latest ✔ | Latest ✔ | 10+ ✔ | Latest ✔ | 6.1+ ✔ |
|
||||
Latest ✔ | Latest ✔ | 10+ ✔ | Latest ✔ | 6.1+ ❌ |
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
|
@ -433,17 +496,17 @@ It's best to check the [docs](./docs), [previous issues](https://github.com/Liss
|
|||
|
||||
## Supporting Dashy 💖
|
||||
|
||||
> For full details, and other ways you can help out, see: [**Contributing**](./docs/contributing.md)
|
||||
> For full details and other ways you can help out, see: [**Contributing**](./docs/contributing.md)
|
||||
|
||||
If you're using Dashy, and would like to help support it's development, then that would be awesome! Contributions of any type, however small are always very much appreciated, and you will be appropriately credited for your effort.
|
||||
If you're using Dashy and would like to help support its development, then that would be awesome! Contributions of any type, any size, are always very much appreciated, and we will appropriately credit you for your effort.
|
||||
|
||||
Several areas that we need a bit of help with at the moment are:
|
||||
- Translating - Help make Dashy available to non-native English speakers by [adding youre language](./docs/multi-language-support.md#adding-a-new-language)
|
||||
- Donate a small amount, by [Sponsoring @Lissy93 on GitHub](https://github.com/sponsors/Lissy93) and receive some extra perks!
|
||||
- Complete a [short survey](https://survey.typeform.com/to/gl0L68ou), to have your say about future features
|
||||
- Share your dashboard in the [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-), to provide inspiration for others
|
||||
- Spread the word, by sharing Dashy or a screenshot of your dashboard, to help new users discover it
|
||||
- Submit a PR, to add a new feature, fix a bug, update the docs, add a theme or something else
|
||||
- Translating - Help make Dashy available to non-native English speakers by [adding your language](./docs/multi-language-support.md#adding-a-new-language)
|
||||
- Donate a small amount by [Sponsoring @Lissy93 on GitHub](https://github.com/sponsors/Lissy93) and receive some extra perks!
|
||||
- Complete a [short survey](https://survey.typeform.com/to/gl0L68ou) to have your say about future features
|
||||
- Share your dashboard in the [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-), to inspire others
|
||||
- Spread the word by sharing Dashy or a screenshot of your dashboard to help new users discover it
|
||||
- Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget or something else
|
||||
- Star Dashy on GitHub/ DockerHub or leave an upvote / review on [these platforms](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md#star-upvote-or-leave-a-review)
|
||||
|
||||
[![Sponsor Lissy93 on GitHub](./docs/assets/sponsor-button.svg)](https://github.com/sponsors/Lissy93)
|
||||
|
@ -452,9 +515,9 @@ Several areas that we need a bit of help with at the moment are:
|
|||
|
||||
## Credits 🏆
|
||||
|
||||
> For a full list of credits, and attributions to packages used within Dashy, see: [**Credits**](./docs/credits.md)
|
||||
> For a complete list of credits, and attributions to packages used within Dashy, see: [**Credits**](./docs/credits.md)
|
||||
|
||||
Thank you so much to everyone who has helped with Dashy so far, every contribution is very much appreciated.
|
||||
Thank you so much to everyone who has helped with Dashy so far; every contribution is very much appreciated.
|
||||
|
||||
#### Sponsors
|
||||
|
||||
|
@ -462,25 +525,183 @@ Huge thanks to the sponsors helping to support Dashy's development!
|
|||
<!-- readme: sponsors -start -->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/undefined">
|
||||
<img src="" width="80;" alt="undefined"/>
|
||||
<br />
|
||||
<sub><b>Undefined</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/koconder">
|
||||
<img src="https://avatars.githubusercontent.com/u/25068?u=582657b23622aaa3dfe68bd028a780f272f456fa&v=4" width="80;" alt="koconder"/>
|
||||
<br />
|
||||
<sub><b>Vincent Koc</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/Admonstrator">
|
||||
<img src="https://avatars.githubusercontent.com/u/69824?u=1e226d7a36cdd661c3e4cd486fea140d045b7d57&v=4" width="80;" alt="Admonstrator"/>
|
||||
<br />
|
||||
<sub><b>Aaron Viehl</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/tbjers">
|
||||
<img src="https://avatars.githubusercontent.com/u/1117052?v=4" width="80;" alt="tbjers"/>
|
||||
<br />
|
||||
<sub><b>Torgny Bjers</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/emlazzarin">
|
||||
<img src="https://avatars.githubusercontent.com/u/1141361?u=714e3487a3f2e0df721b01a0133945f075d3ff68&v=4" width="80;" alt="emlazzarin"/>
|
||||
<br />
|
||||
<sub><b>Eddy Lazzarin</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/AnandChowdhary">
|
||||
<img src="https://avatars.githubusercontent.com/u/2841780?u=747e554b3a7f12eb20b7910e1c87d817844f714f&v=4" width="80;" alt="AnandChowdhary"/>
|
||||
<br />
|
||||
<sub><b>Anand Chowdhary</b></sub>
|
||||
</a>
|
||||
</td></tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/shrippen">
|
||||
<img src="https://avatars.githubusercontent.com/u/2873570?v=4" width="80;" alt="shrippen"/>
|
||||
<br />
|
||||
<sub><b>Shrippen</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/bile0026">
|
||||
<img src="https://avatars.githubusercontent.com/u/5022496?u=aec96ad173c0ea9baaba93807efa8a848af6595c&v=4" width="80;" alt="bile0026"/>
|
||||
<br />
|
||||
<sub><b>Zach Biles</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/UlisesGascon">
|
||||
<img src="https://avatars.githubusercontent.com/u/5110813?u=3c41facd8aa26154b9451de237c34b0f78d672a5&v=4" width="80;" alt="UlisesGascon"/>
|
||||
<br />
|
||||
<sub><b>Ulises Gascón</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/digitalarche">
|
||||
<img src="https://avatars.githubusercontent.com/u/6546135?u=564756d7f44ab2206819eb3148f6d822673f5066&v=4" width="80;" alt="digitalarche"/>
|
||||
<br />
|
||||
<sub><b>Digital Archeology</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/InDieTasten">
|
||||
<img src="https://avatars.githubusercontent.com/u/7047377?u=8d8f8017628b38bc46dcbf3620e194b01d3fb2d1&v=4" width="80;" alt="InDieTasten"/>
|
||||
<br />
|
||||
<sub><b>InDieTasten</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/araguaci">
|
||||
<img src="https://avatars.githubusercontent.com/u/7318668?v=4" width="80;" alt="araguaci"/>
|
||||
<br />
|
||||
<sub><b>Araguaci</b></sub>
|
||||
</a>
|
||||
</td></tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/bmcgonag">
|
||||
<img src="https://avatars.githubusercontent.com/u/7346620?u=2a0f9284f3e12ac1cc15288c254d1ec68a5081e8&v=4" width="80;" alt="bmcgonag"/>
|
||||
<br />
|
||||
<sub><b>Brian McGonagill</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/vlad-timofeev">
|
||||
<img src="https://avatars.githubusercontent.com/u/11474041?v=4" width="80;" alt="vlad-timofeev"/>
|
||||
<img src="https://avatars.githubusercontent.com/u/11474041?u=eee43705b54d2ec9f51fc4fcce5ad18dd17c87e4&v=4" width="80;" alt="vlad-timofeev"/>
|
||||
<br />
|
||||
<sub><b>Vlad Timofeev</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/DylanBeMe">
|
||||
<img src="https://avatars.githubusercontent.com/u/41838333?v=4" width="80;" alt="DylanBeMe"/>
|
||||
<a href="https://github.com/helixzz">
|
||||
<img src="https://avatars.githubusercontent.com/u/12218889?u=d06d0c103dfbdb99450623064f7da3c5a3675fb6&v=4" width="80;" alt="helixzz"/>
|
||||
<br />
|
||||
<sub><b>DylanH</b></sub>
|
||||
<sub><b>HeliXZz</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/matthewjdegarmo">
|
||||
<img src="https://avatars.githubusercontent.com/u/46715299?u=65f979e86de9dce8a5fe04df9775d32c6cefd73a&v=4" width="80;" alt="matthewjdegarmo"/>
|
||||
<a href="https://github.com/patvdv">
|
||||
<img src="https://avatars.githubusercontent.com/u/12430107?u=e8911c2fb91af4d30432f76da8c40927b2830bd7&v=4" width="80;" alt="patvdv"/>
|
||||
<br />
|
||||
<sub><b>Matthew J. DeGarmo</b></sub>
|
||||
<sub><b>Patrick Van Der Veken</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/plgonzalezrx8">
|
||||
<img src="https://avatars.githubusercontent.com/u/19900049?u=48a58d2da520a9d712184c6e6e99927ff3cbf179&v=4" width="80;" alt="plgonzalezrx8"/>
|
||||
<br />
|
||||
<sub><b>Pedro Gonzalez</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/mryesiller">
|
||||
<img src="https://avatars.githubusercontent.com/u/24632172?u=0d20f2d615158f87cd60a3398d3efb026c32f291&v=4" width="80;" alt="mryesiller"/>
|
||||
<br />
|
||||
<sub><b>Göksel Yeşiller</b></sub>
|
||||
</a>
|
||||
</td></tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/allesauseinerhand">
|
||||
<img src="https://avatars.githubusercontent.com/u/32039836?v=4" width="80;" alt="allesauseinerhand"/>
|
||||
<br />
|
||||
<sub><b>Allesauseinerhand</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/lamtrinhdev">
|
||||
<img src="https://avatars.githubusercontent.com/u/49742151?u=c5eaca5aa6841a80605cf4f7d0e861a9e6339ef3&v=4" width="80;" alt="lamtrinhdev"/>
|
||||
<br />
|
||||
<sub><b>LamTrinh.Dev</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/Bastii717">
|
||||
<img src="https://avatars.githubusercontent.com/u/53431819?u=604977bed6ad6875ada890d0d3765a4cacc2fa14&v=4" width="80;" alt="Bastii717"/>
|
||||
<br />
|
||||
<sub><b>Bastii717</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/M2TD">
|
||||
<img src="https://avatars.githubusercontent.com/u/85460457?v=4" width="80;" alt="M2TD"/>
|
||||
<br />
|
||||
<sub><b>M2TD</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/frankdez93">
|
||||
<img src="https://avatars.githubusercontent.com/u/87549420?v=4" width="80;" alt="frankdez93"/>
|
||||
<br />
|
||||
<sub><b>Frankdez93</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/NixyJuppie">
|
||||
<img src="https://avatars.githubusercontent.com/u/138570196?u=b102c222487905728b858704962d32759df29ebe&v=4" width="80;" alt="NixyJuppie"/>
|
||||
<br />
|
||||
<sub><b>Nixy</b></sub>
|
||||
</a>
|
||||
</td></tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/nrvo">
|
||||
<img src="https://avatars.githubusercontent.com/u/151435968?u=e1dcb307fd0efdc45cddbe9490a7b956e4da6835&v=4" width="80;" alt="nrvo"/>
|
||||
<br />
|
||||
<sub><b>Nrvo</b></sub>
|
||||
</a>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
@ -489,6 +710,9 @@ Huge thanks to the sponsors helping to support Dashy's development!
|
|||
#### Contributors
|
||||
[![Auto-generated contributors](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg)](./docs/credits.md)
|
||||
|
||||
#### Stats
|
||||
[![Stats](https://repobeats.axiom.co/api/embed/48546e3c768d38c450ba136e32c0992bcf58ad73.svg "Repobeats analytics image")](https://github.com/Lissy93/dashy/blob/master/docs/credits.md)
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
@ -507,10 +731,11 @@ To set up the development environment:
|
|||
1. Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
|
||||
2. Install dependencies: `yarn`
|
||||
3. Start dev server: `yarn dev`
|
||||
4. Open the browser: `http://localhost:8080`
|
||||
|
||||
Hot reload is enabled, so changes will be automatically detected, compiled and refreshed.
|
||||
When you're ready, you can build the production app with `yarn build`, and then run it with `yarn start`
|
||||
|
||||
If you're new to web development, I've put together a short [list of resources](https://github.com/Lissy93/dashy/blob/master/docs/developing.md#resources-for-beginners), to help beginners get started
|
||||
If you're new to web development, I've put together a short [list of resources](https://github.com/Lissy93/dashy/blob/master/docs/developing.md#resources-for-beginners) to help beginners get started
|
||||
|
||||
**Repo Status**:
|
||||
[![Open PRs](https://flat.badgen.net/github/open-prs/lissy93/dashy?icon=github)](https://github.com/Lissy93/dashy/pulls)
|
||||
|
@ -523,22 +748,6 @@ If you're new to web development, I've put together a short [list of resources](
|
|||
|
||||
---
|
||||
|
||||
## Release Schedule 🗞️
|
||||
|
||||
> For full release, automation and CI documentation, see: [**Releases & Workflows**](./docs/release-workflow.md)
|
||||
|
||||
Dashy is under active development, with features, improvements and changes pushed almost daily.
|
||||
|
||||
We're using [Semantic Versioning](https://semver.org/), to indicate major, minor and patch versions. You can find the current version number in the readme, and check your apps version under the config menu. The version number is pulled from the [package.json](https://github.com/Lissy93/dashy/blob/master/package.json#L3) file.
|
||||
|
||||
Typically there is a new major release every 2 - 4 weeks, usually on Sunday, and you can view these under the [Releases Page](https://github.com/Lissy93/dashy/releases) and [on DockerHub](https://hub.docker.com/r/lissy93/dashy/tags). New minor versions are pushed several times a week, and are [tagged here](https://github.com/Lissy93/dashy/tags).
|
||||
|
||||
For a full breakdown of each change, you can view the [Changelog](https://github.com/Lissy93/dashy/blob/master/.github/CHANGELOG.md). Each new feature or significant change needs to be submitted through [a pull request](https://github.com/Lissy93/dashy/pulls?q=is%3Apr), which makes it easy to review and track these changes, and roll back if needed.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Documentation 📘
|
||||
> For full docs, see: **[Documentation Contents](./docs/readme.md)**
|
||||
#### Running Dashy
|
||||
|
@ -548,6 +757,17 @@ For a full breakdown of each change, you can view the [Changelog](https://github
|
|||
- 💻 [Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc
|
||||
- 🚒 [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them
|
||||
|
||||
#### Feature Docs
|
||||
- 🛡️ [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard
|
||||
- 🌈 [Alternate Views](/docs/alternate-views.md) - Outline of available pages / views and item opening methods
|
||||
- 💾 [Backup & Restore](/docs/backup-restore.md) - Guide to backing up config with Dashy's cloud sync feature
|
||||
- 🧸 [Icons](/docs/icons.md) - Outline of all available icon types for sections and items, with examples
|
||||
- 🌐 [Multi-Language Support](/docs/multi-language-support.md) - Switching languages, and adding a new locales
|
||||
- 🚦 [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
|
||||
- 🔍 [Searching & Shortcuts](/docs/searching.md) - Searching, launching methods + keyboard shortcuts
|
||||
- 🎨 [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes + styles
|
||||
- 📊 [Widgets](/docs/widgets.md) - List of all dynamic content widgets, with usage guides and examples
|
||||
|
||||
#### Development and Contributing
|
||||
- 🧱 [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow
|
||||
- 🛎️ [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors
|
||||
|
@ -556,16 +776,6 @@ For a full breakdown of each change, you can view the [Changelog](https://github
|
|||
- 🏆 [Credits](/docs/credits.md) - Shout out to the amazing people who have contributed so far
|
||||
- 🗞️ [Release Workflow](/docs/release-workflow.md) - Info about releases, CI and automated tasks
|
||||
|
||||
#### Feature Docs
|
||||
- 🛡️ [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard
|
||||
- 🧿 [Alternate Views](/docs/alternate-views.md) - Outline of available pages / views and item opening methods
|
||||
- 💾 [Backup & Restore](/docs/backup-restore.md) - Guide to Dashy's cloud sync feature
|
||||
- 🧸 [Icons](/docs/icons.md) - Outline of all available icon types for sections and items
|
||||
- 🌐 [Language Switching](/docs/multi-language-support.md) - How to change language, add a language, or update text
|
||||
- 🚦 [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
|
||||
- 🔍 [Searching & Shortcuts](/docs/searching.md) - Finding and launching your apps, and using keyboard shortcuts
|
||||
- 🎨 [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes and styles
|
||||
|
||||
#### Misc
|
||||
- 🔐 [Privacy & Security](/docs/privacy.md) - List of requests, potential issues, and security resources
|
||||
- 📄 [License](/LICENSE) - Copy of the MIT License
|
||||
|
@ -579,20 +789,17 @@ For a full breakdown of each change, you can view the [Changelog](https://github
|
|||
|
||||
## Roadmap 🛣️
|
||||
|
||||
> For past and future app updates, see: [**Changelog**](/.github/CHANGELOG.md)
|
||||
For upcoming features that will be released in the near future, see the [**Current Roadmap**](https://github.com/Lissy93/dashy/discussions/405)
|
||||
|
||||
The following features and tasks are planned for the near future.
|
||||
- Widget support- cards showing live stats and interactive content from your self-hosted services
|
||||
- ✅ UI editor and visual configurator
|
||||
- Replacement of Node backend with Go
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
For past updates, see the [**Changelog**](/.github/CHANGELOG.md)
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Alternatives 🙌
|
||||
|
||||
There are a few self-hosted web apps, that serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out!
|
||||
A few self-hosted web apps serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out!
|
||||
- [Flame](https://github.com/pawelmalak/flame) by @pawelmalak (`MIT`)
|
||||
- [HomeDash2](https://lamarios.github.io/Homedash2)
|
||||
- [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`)
|
||||
|
@ -606,13 +813,13 @@ There are a few self-hosted web apps, that serve a similar purpose to Dashy. If
|
|||
---
|
||||
## License 📜
|
||||
|
||||
Dashy is License under [MIT X11](https://en.wikipedia.org/wiki/MIT_License)
|
||||
Dashy is Licensed under [MIT X11](https://en.wikipedia.org/wiki/MIT_License)
|
||||
|
||||
```
|
||||
Copyright © 2021 Alicia Sykes <https://aliciasykes.com>
|
||||
Copyright © 2021-2024 Alicia Sykes <https://aliciasykes.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
software and associated documentation files (the “Software”), to deal in the Software
|
||||
software and associated documentation files (the "Software"), to deal in the Software
|
||||
without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
||||
persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
@ -620,15 +827,15 @@ persons to whom the Software is furnished to do so, subject to the following con
|
|||
The above copyright notice and this permission notice shall be included in all copies or
|
||||
substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWAREOR THE USE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE
|
||||
OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
Except as contained in this notice, Dashy shall not be used in advertising or otherwise
|
||||
to promote the sale, use or other dealings in this Software without prior written
|
||||
to promote the sale, use, or other dealings in this Software without prior written
|
||||
authorization from the repo owner.
|
||||
```
|
||||
|
||||
|
@ -644,16 +851,25 @@ For more info, see TLDR Legal's [Explanation of MIT](https://tldrlegal.com/licen
|
|||
|
||||
---
|
||||
|
||||
|
||||
<p align="center">
|
||||
<br>
|
||||
<a href="https://dashboard.trackgit.com/token/ks0bx7bb14lsvbwoc3ik">
|
||||
<img src="https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/ks0bx7bb14lsvbwoc3ik?style=flat-square" />
|
||||
</a>
|
||||
<br><br>
|
||||
<a href="https://github.com/Lissy93/dashy">
|
||||
<img src="https://github.githubassets.com/images/icons/emoji/octocat.png" />
|
||||
</a>
|
||||
<br><br>
|
||||
<i>Thank you for Visiting</i>
|
||||
<!-- License + Copyright -->
|
||||
<p align="center">
|
||||
<i>© <a href="https://aliciasykes.com">Alicia Sykes</a> 2024</i><br>
|
||||
<i>Licensed under <a href="https://gist.github.com/Lissy93/143d2ee01ccc5c052a17">MIT</a></i><br>
|
||||
<a href="https://github.com/lissy93"><img src="https://i.ibb.co/4KtpYxb/octocat-clean-mini.png" /></a><br>
|
||||
<sup>Thanks for visiting :)</sup>
|
||||
</p>
|
||||
|
||||
<!-- Dinosaurs are Awesome -->
|
||||
<!--
|
||||
. - ~ ~ ~ - .
|
||||
.. _ .-~ ~-.
|
||||
//| \ `..~ `.
|
||||
|| | } } / \ \
|
||||
(\ \\ \~^..' | } \
|
||||
\`.-~ o / } | / \
|
||||
(__ | / | / `.
|
||||
`- - ~ ~ -._| /_ - ~ ~ ^| /- _ `.
|
||||
| / | / ~-. ~- _
|
||||
|_____| |_____| ~ - . _ _~_-_
|
||||
-->
|
||||
|
||||
|
|
3
app.json
|
@ -1,5 +1,6 @@
|
|||
{
|
||||
"name": "Dashy",
|
||||
"website": "https://dashy.to/",
|
||||
"description": "A Dashboard for your Homelab 🚀",
|
||||
"repository": "https://github.com/lissy93/dashy",
|
||||
"logo": "https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/logo.png",
|
||||
|
@ -13,4 +14,4 @@
|
|||
"lissy93"
|
||||
],
|
||||
"stack": "heroku-20"
|
||||
}
|
||||
}
|
||||
|
|
|
@ -12,21 +12,17 @@ services:
|
|||
# To build from source, replace 'image: lissy93/dashy' with 'build: .'
|
||||
# build: .
|
||||
|
||||
# Or, to use a Dockerfile for your archtecture, uncomment the following
|
||||
# context: .
|
||||
# dockerfile: ./docker/Dockerfile-arm32v7
|
||||
|
||||
# You can also use an image with a different tag, or pull from a different registry, e.g:
|
||||
# image: ghcr.io/lissy93/dashy or image: lissy93/dashy:arm64v8
|
||||
# image: ghcr.io/lissy93/dashy or image: lissy93/dashy:3.0.0
|
||||
|
||||
# Pass in your config file below, by specifying the path on your host machine
|
||||
# volumes:
|
||||
# - /path/to/my-config.yml:/app/public/conf.yml
|
||||
# - /path/to/item-icons:/app/public/item-icons
|
||||
# - /path/to/my-config.yml:/app/user-data/conf.yml
|
||||
# - /path/to/item-icons:/app/user-data/item-icons/
|
||||
|
||||
# Set port that web service will be served on. Keep container port as 80
|
||||
# Set port that web service will be served on. Keep container port as 8080
|
||||
ports:
|
||||
- 4000:80
|
||||
- 4000:8080
|
||||
|
||||
# Set any environmental variables
|
||||
environment:
|
||||
|
|
|
@ -1,50 +0,0 @@
|
|||
FROM node:14.17.5-alpine AS BUILD_IMAGE
|
||||
|
||||
ARG TARGETPLATFORM
|
||||
ENV TARGETPLATFORM=${TARGETPLATFORM:-linux/amd64}
|
||||
|
||||
# Install additional tools needed on arm64 and armv7
|
||||
RUN \
|
||||
case "${TARGETPLATFORM}" in \
|
||||
'linux/arm64') apk add --no-cache python make g++ ;; \
|
||||
'linux/arm/v7') apk add --no-cache python make g++ ;; \
|
||||
esac
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR /app
|
||||
|
||||
COPY package.json yarn.lock ./
|
||||
RUN yarn install --frozen-lockfile --network-timeout 1000000
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . ./
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Build the final image
|
||||
FROM node:14.17.5-alpine
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Install tini and tzdata
|
||||
RUN apk add --no-cache tzdata tini
|
||||
|
||||
# copy from build image
|
||||
COPY --from=BUILD_IMAGE /app ./
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
ENTRYPOINT [ "/sbin/tini", "--" ]
|
||||
CMD [ "yarn", "build-and-start" ]
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
|
@ -0,0 +1,31 @@
|
|||
FROM node:lts-alpine3.14
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Copy over both 'package.json' and 'package-lock.json' (if available)
|
||||
COPY package*.json ./
|
||||
COPY yarn.lock ./
|
||||
|
||||
# Install project dependencies
|
||||
RUN yarn
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . .
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
CMD [ "yarn", "build-and-start"]
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
|
@ -0,0 +1,136 @@
|
|||
<h1 align="center">Dashy</h1>
|
||||
<p align="center">
|
||||
<i>Dashy helps you organize your self-hosted services by making them accessible from a single place</i>
|
||||
<br/>
|
||||
<img width="120" src="https://i.ibb.co/yhbt6CY/dashy.png" />
|
||||
<br/>
|
||||
<b><a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md">User Showcase</a></b> | <b><a href="https://demo.dashy.to">Live Demo</a></b> | <b><a href="https://github.com/Lissy93/dashy/blob/master/docs/quick-start.md">Getting Started</a></b> | <b><a href="https://dashy.to/docs">Documentation</a></b> | <b><a href="https://github.com/Lissy93/dashy">GitHub</a></b>
|
||||
<br/><br/>
|
||||
<a href="https://github.com/awesome-selfhosted/awesome-selfhosted#personal-dashboards">
|
||||
<img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome Self-Hosted">
|
||||
</a>
|
||||
<a href="https://github.com/Lissy93/dashy/blob/master/LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-MIT-0aa8d2?logo=opensourceinitiative&logoColor=fff" alt="License MIT">
|
||||
</a>
|
||||
<a href="https://github.com/Lissy93/dashy/blob/master/.github/CHANGELOG.md">
|
||||
<img src="https://img.shields.io/github/package-json/v/lissy93/dashy?logo=azurepipelines&color=0aa8d2" alt="Current Version">
|
||||
</a>
|
||||
<a href="https://hub.docker.com/r/lissy93/dashy">
|
||||
<img src="https://img.shields.io/docker/pulls/lissy93/dashy?logo=docker&color=0aa8d2&logoColor=fff" alt="Docker Pulls">
|
||||
</a>
|
||||
<a href="http://as93.link/dashy-build-status">
|
||||
<img src="https://badgen.net/github/status/lissy93/dashy?icon=github" alt="GitHub Status">
|
||||
</a>
|
||||
<a href="https://snyk.io/test/github/lissy93/dashy">
|
||||
<img src="https://snyk.io/test/github/lissy93/dashy/badge.svg" alt="Known Vulnerabilities">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## Features 🌈
|
||||
|
||||
- 🔎 Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts
|
||||
- 🎨 Multiple built-in color themes, with UI color editor and support for custom CSS
|
||||
- 🧸 Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.
|
||||
- 🚦 Status monitoring for each of your apps/links for basic availability and uptime checking
|
||||
- 📊 Widgets for displaying info and dynamic content from your self-hosted services
|
||||
- 💂 Optional authentication with multi-user access, configurable privileges, and SSO support
|
||||
- 🌎 Multi-language support, with 10+ human-translated languages, and more on the way
|
||||
- ☁ Optional, encrypted, free off-site cloud backup and restore feature available
|
||||
- 💼 A workspace view, for easily switching between multiple apps simultaneously
|
||||
- 🛩️ A minimal view, for use as a fast-loading browser Startpage
|
||||
- 🖱️ Choose app launch method, either new tab, same tab, a pop-up modal, or in the workspace view
|
||||
- 📏 Customizable layout, sizes, text, component visibility, sort order, behavior, etc.
|
||||
- 🖼️ Options for a full-screen background image, custom nav-bar links, HTML footer, title, etc.
|
||||
- 🚀 Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
|
||||
- ⚙️ Easy configuration, either through the UI, or using a YAML file
|
||||
- ✨ Under active development with improvements and new features added regularly
|
||||
- 🤏 Small bundle size, fully responsive UI, and PWA for basic offline access
|
||||
- 🆓 100% free and open-source
|
||||
- 🔐 Strong focus on privacy
|
||||
- 🌈 And loads more...
|
||||
|
||||
## Demo ⚡
|
||||
|
||||
**Live Instances**: [Demo 1](https://demo.dashy.to) (Live Demo) ┆ [Demo 2](https://live.dashy.to) (Dashy Links) ┆ [Demo 3](https://dev.dashy.to) (Dev Preview)
|
||||
|
||||
**Screenshots**: Checkout the [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md), to see example dashboards from the community
|
||||
|
||||
**Spin up your own demo**: [![One-Click Deploy with PWD](https://img.shields.io/badge/Play--with--Docker-Deploy-2496ed?style=flat-square&logo=docker)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:8080 lissy93/dashy`](./docs/quick-start.md)
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img width="800" src="https://i.ibb.co/L8YbNNc/dashy-demo2.gif" alt="Demo" />
|
||||
</p>
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Getting Started 🛫
|
||||
|
||||
To deploy Dashy with Docker, just run `docker run -p 8080:8080 lissy93/dashy`, then open `http://localhost:8080`
|
||||
|
||||
For full list of options and a Docker compose file, see the [Deployment Docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md).
|
||||
|
||||
Dashy can also be run on bare metal using Node.js, or deployed to a cloud service, using the 1-Click deploy script.
|
||||
|
||||
---
|
||||
|
||||
## Documentation 📝
|
||||
|
||||
#### Running Dashy
|
||||
- **[Quick Start](https://github.com/Lissy93/dashy/blob/master/docs/quick-start.md)** - TDLR guide on getting Dashy up and running
|
||||
- **[Deployment](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md)** - Full guide on deploying Dashy either locally or online
|
||||
- **[Configuring](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md)** - Complete list of all available options in the config file
|
||||
- **[App Management](https://github.com/Lissy93/dashy/blob/master/docs/management.md)** - Managing your app, updating, security, web server configuration, etc
|
||||
- **[Troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md)** - Common errors and problems, and how to fix them
|
||||
|
||||
#### Feature Docs
|
||||
- **[Authentication](https://github.com/Lissy93/dashy/blob/master/docs/authentication.md)** - Guide to setting up authentication to protect your dashboard
|
||||
- **[Alternate Views](https://github.com/Lissy93/dashy/blob/master/docs/alternate-views.md)** - Outline of available pages / views and item opening methods
|
||||
- **[Backup & Restore](https://github.com/Lissy93/dashy/blob/master/docs/backup-restore.md)** - Guide to backing up config with Dashy's cloud sync feature
|
||||
- **[Icons](https://github.com/Lissy93/dashy/blob/master/docs/icons.md)** - Outline of all available icon types for sections and items, with examples
|
||||
- **[Language Switching](https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md)** - Details on how to switch language, or add a new locale
|
||||
- **[Status Indicators](https://github.com/Lissy93/dashy/blob/master/docs/status-indicators.md)** - Using Dashy to monitor uptime and status of your apps
|
||||
- **[Searching & Shortcuts](https://github.com/Lissy93/dashy/blob/master/docs/searching.md)** - Searching, launching methods + keyboard shortcuts
|
||||
- **[Theming](https://github.com/Lissy93/dashy/blob/master/docs/theming.md)** - Complete guide to applying, writing and modifying themes + styles
|
||||
- **[Widgets](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md)** - List of all dynamic content widgets, with usage guides and examples
|
||||
|
||||
#### Development and Contributing
|
||||
- **[Developing](https://github.com/Lissy93/dashy/blob/master/docs/developing.md)** - Running Dashy development server locally, and general workflow
|
||||
- **[Development Guides](https://github.com/Lissy93/dashy/blob/master/docs/development-guides.md)** - Common development tasks, to help new contributors
|
||||
- **[Contributing](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md)** - How you can help keep Dashy alive
|
||||
- **[Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md)** - See how others are using Dashy, and share your dashboard
|
||||
- **[Credits](https://github.com/Lissy93/dashy/blob/master/docs/credits.md)** - List of people and projects that have made Dashy possible
|
||||
- **[Release Workflow](https://github.com/Lissy93/dashy/blob/master/docs/release-workflow.md)** - Info about releases, CI and automated tasks
|
||||
|
||||
---
|
||||
|
||||
## License 📜
|
||||
|
||||
Dashy is Licensed under [MIT X11](https://en.wikipedia.org/wiki/MIT_License)
|
||||
|
||||
```
|
||||
Copyright © 2024 Alicia Sykes <https://aliciasykes.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
software and associated documentation files (the "Software"), to deal in the Software
|
||||
without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
||||
persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or
|
||||
substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE
|
||||
OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
Except as contained in this notice, Dashy shall not be used in advertising or otherwise
|
||||
to promote the sale, use, or other dealings in this Software without prior written
|
||||
authorization from the repo owner.
|
||||
```
|
|
@ -1,10 +1,18 @@
|
|||
# Alternate Views & Opening Methods
|
||||
|
||||
## Views
|
||||
As well as the default start view, Dashy has several other start pages, for different tasks. You can switch views with the view-switcher button in the top-right, or set a default starting view using the `appConfig.startingView` attribute (can be `default`, `minimal` or `workspace`).
|
||||
|
||||
Dashy has three different views:
|
||||
|
||||
- Default View - This is the main homepage with sections in a grid layout
|
||||
- Workspace View - Items displayed on the side, and are launched within Dashy
|
||||
- Minimal View - A clean + simple tabbed view
|
||||
|
||||
You can switch between views using the dropdown in the top-right corner. Set your chosen Starting View with `appConfig.startingView`. Click the page title at any time to go back to your selected starting view.
|
||||
|
||||
### Default
|
||||
This is the main page that you will land on when you first launch the application. Here all of your sections and items will be visible, you can modify settings and search + launch your applications.
|
||||
|
||||
This is the main page that you will land on when you first launch the application. Here all of your sections (with items + widgets) are visible in a grid layout.
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Default View</b><br>
|
||||
|
@ -12,11 +20,12 @@ This is the main page that you will land on when you first launch the applicatio
|
|||
</p>
|
||||
|
||||
### Workspace
|
||||
The workspace view displays your links in a sidebar on the left-hand side, and apps are launched within Dashy. This enables you to use all of your self-hosted apps from one place, and makes multi-tasking easy.
|
||||
|
||||
In the workspace view, you can opt to keep previously opened websites/ apps open in the background, by setting `appConfig.enableMultiTasking: true`. This comes at the cost of performance, but does mean that your session with each app is preserved, enabling you to quickly switch between your apps.
|
||||
The workspace view displays your links in a sidebar on the left-hand side, and apps are launched inside an iframe without having to leave Dashy. This enables you to use all of your self-hosted apps from one place, and makes multi-tasking easy.
|
||||
|
||||
You can also specify a default app to be opened when you land on the workspace, by setting `appConfig.workspaceLandingUrl: https://app-to-open/`. If this app exists within your sections.items, then the corresponding section will also be expanded.
|
||||
You can specify a default app to be opened when you land on the workspace, by setting `appConfig.workspaceLandingUrl: https://app-to-open/`. If this app exists within your sections.items, then the corresponding section will also be expanded.
|
||||
|
||||
You can also opt to keep previously opened websites/ apps open in the background, by setting `appConfig.enableMultiTasking: true`. This comes at the cost of performance, but does mean that your session with each app is preserved, enabling you to quickly switch between them.
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Workspace View</b><br>
|
||||
|
@ -24,7 +33,8 @@ You can also specify a default app to be opened when you land on the workspace,
|
|||
</p>
|
||||
|
||||
### Minimal View
|
||||
The minimal view aims to be super fast and simple, and can be used as a browser startpage. Items are grouped into a tab view, and the last opened tab will be remembered. Similar to the main view, you can search and launch items just by typing, and right-clicking will show more options.
|
||||
|
||||
The minimal view aims to be super fast and simple, and can be used as a browser startpage. Items are grouped into a tab view, and the last opened tab will be remembered. Similar to the main view, you can search and launch items just by typing, and right-clicking will show more options (like open in modal, workspace or new tab).
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Minimal View</b><br>
|
||||
|
@ -33,20 +43,22 @@ The minimal view aims to be super fast and simple, and can be used as a browser
|
|||
|
||||
## Opening Methods
|
||||
|
||||
Dashy supports several different ways to launch your apps. The default opening method for each app can be specified using the `target` attribute, with a value of one of the following:
|
||||
Dashy supports several different ways to launch your apps. The primary opening method for each app can be specified using the `target` attribute, with a value of one of the following:
|
||||
|
||||
- `sametab` - The app will be launched in the current tab
|
||||
- `newtab` - The app will be launched in a new tab
|
||||
- `top` - Opens in the top-most browsing context, useful if your accessing Dashy through an iframe
|
||||
- `top` - Opens in the top-most browsing context, useful if you're accessing Dashy through an iframe
|
||||
- `modal` - Launch app in a resizable/ movable popup modal on the current page
|
||||
- `workspace` - Changes to Workspace view, and launches app
|
||||
|
||||
You can also set the default opening method, which will be applied to all items that don't have a specified target, using `appConfig.defaultOpeningMethod`, to one of the above values.
|
||||
You can also set a default opening method, which will be applied to all items that don't have a specified target, using `appConfig.defaultOpeningMethod`, to one of the above values.
|
||||
|
||||
Even if the target is not set (or is set to `sametab`), you can still launch any given app in an alternative method: Alt + Click will open the modal, and Ctrl + Click will open in a new tab. You can also right-click on any item to see all options (as seen in the screenshot below). This custom context menu can be disabled by setting `appConfig.disableContextMenu: true`.
|
||||
Even if the target is not set (or is set to `sametab`), you can still launch any given app in an alternative method. Either right-click to see all options, or use one of the keyboard shortcuts: Alt + Click will open the modal, and Ctrl + Click will open in a new tab.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/vmZdSRt/dashy-context-menu-2.png" />
|
||||
</p>
|
||||
|
||||
If you don't like the custom context menu, it can be disabled by setting `appConfig.disableContextMenu: true`.
|
||||
|
||||
If you get a 'Refused to Connect' error in the modal or workspace views, then the target app has it's X-Frame-Options HTTP set to block requests from embedded content. You can easily fix this by setting this header to ALLOW, for instructions on how to do so, see the [Troubleshooting Docs](/docs/troubleshooting.md#refused-to-connect-in-modal-or-workspace-view).
|
||||
|
|
Before Width: | Height: | Size: 3.2 MiB After Width: | Height: | Size: 30 MiB |
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 94 KiB |
|
@ -1,278 +1,407 @@
|
|||
# Authentication
|
||||
|
||||
- [Basic Auth](#built-in-auth)
|
||||
- [Setting Up Authentication](#setting-up-authentication)
|
||||
- [Hash Password](#hash-password)
|
||||
- [Logging In and Out](#logging-in-and-out)
|
||||
- [Guest Access](#enabling-guest-access)
|
||||
- [Per-User Access](#granular-access)
|
||||
- [Security Considerations](#security)
|
||||
- [Keycloak Auth](#keycloak)
|
||||
- [Deploying Keycloak](#1-deploy-keycloak)
|
||||
- [Setting up Keycloak](#2-setup-keycloak-users)
|
||||
- [Configuring Dashy for Keycloak](#3-enable-keycloak-in-dashy-config-file)
|
||||
- [Alternative Authentication Methods](#alternative-authentication-methods)
|
||||
- [VPN](#vpn)
|
||||
- [IP-Based Access](#ip-based-access)
|
||||
- [Web Server Authentication](#web-server-authentication)
|
||||
- [OAuth Services](#oauth-services)
|
||||
- [Auth on Cloud Hosting Services](#static-site-hosting-providers)
|
||||
|
||||
## Built-In Auth
|
||||
Dashy has a basic login page included, and frontend authentication. You can enable this by adding users to the `auth` section under `appConfig` in your `conf.yml`. If this section is not specified, then no authentication will be required to access the app, and it the homepage will resolve to your dashboard.
|
||||
|
||||
### Setting Up Authentication
|
||||
The `auth` property takes an array of users. Each user needs to include a username, hash and optional user type (`admin` or `normal`). The hash property is a [SHA-256 Hash](https://en.wikipedia.org/wiki/SHA-2) of your desired password.
|
||||
|
||||
For example:
|
||||
```yaml
|
||||
appConfig:
|
||||
auth:
|
||||
users:
|
||||
- user: alicia
|
||||
hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
|
||||
type: admin
|
||||
- user: bob
|
||||
hash: 5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8
|
||||
```
|
||||
|
||||
### Hash Password
|
||||
Dashy uses [SHA-256 Hash](https://en.wikipedia.org/wiki/Sha-256), a 64-character string, which you can generate using an online tool, such as [this one](https://passwordsgenerator.net/sha256-hash-generator/) or [CyberChef](https://gchq.github.io/CyberChef/) (which can be self-hosted/ ran locally).
|
||||
|
||||
A hash is a one-way cryptographic function, meaning that it is easy to generate a hash for a given password, but very hard to determine the original password for a given hash. This means, that so long as your password is long, strong and unique, it is safe to store it's hash in the clear. Having said that, you should never reuse passwords, hashes can be cracked by iterating over known password lists, generating a hash of each.
|
||||
|
||||
### Logging In and Out
|
||||
Once authentication is enabled, so long as there is no valid token in cookie storage, the application will redirect the user to the login page. When the user enters credentials in the login page, they will be checked, and if valid, then a token will be generated, and they can be redirected to the home page. If credentials are invalid, then an error message will be shown, and they will remain on the login page. Once in the application, to log out the user can click the logout button (in the top-right), which will clear cookie storage, causing them to be redirected back to the login page.
|
||||
|
||||
### Enabling Guest Access
|
||||
With authentication setup, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting `appConfig.enableGuestAccess: true`.
|
||||
|
||||
### Granular Access
|
||||
You can use the following properties to make certain sections only visible to some users, or hide sections from guests.
|
||||
- `hideForUsers` - Section will be visible to all users, except for those specified in this list
|
||||
- `showForUsers` - Section will be hidden from all users, except for those specified in this list
|
||||
- `hideForGuests` - Section will be visible for logged in users, but not for guests
|
||||
|
||||
For Example:
|
||||
|
||||
```yaml
|
||||
- name: Code Analysis & Monitoring
|
||||
icon: fas fa-code
|
||||
displayData:
|
||||
cols: 2
|
||||
hideForUsers: [alicia, bob]
|
||||
items:
|
||||
...
|
||||
```
|
||||
|
||||
```yaml
|
||||
- name: Deployment Pipelines
|
||||
icon: fas fa-rocket
|
||||
displayData:
|
||||
hideForGuests: true
|
||||
items:
|
||||
...
|
||||
```
|
||||
|
||||
### Security
|
||||
Since all authentication is happening entirely on the client-side, it is vulnerable to manipulation by an adversary. An attacker could look at the source code, find the function used generate the auth token, then decode the minified JavaScript to find the hash, and manually generate a token using it, then just insert that value as a cookie using the console, and become a logged in user. Therefore, if you need secure authentication for your app, it is strongly recommended to implement this using your web server, or use a VPN to control access to Dashy. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage.
|
||||
|
||||
Addressing this is on the todo list, and there are several potential solutions:
|
||||
1. Encrypt all site data against the users password, so that an attacker can not physically access any data without the correct decryption key
|
||||
2. Use a backend service to handle authentication and configuration, with no user data returned from the server until the correct credentials are provided. However, this would require either Dashy to be run using it's Node.js server, or the use of an external service
|
||||
3. ~~Implement authentication using a self-hosted identity management solution, such as [Keycloak for Vue](https://www.keycloak.org/securing-apps/vue)~~ **This is now implemented, and released in PR #174 of V 1.6.5!**
|
||||
|
||||
**[⬆️ Back to Top](#authentication)**
|
||||
|
||||
---
|
||||
|
||||
## Keycloak
|
||||
|
||||
Dashy also supports using a [Keycloack](https://www.keycloak.org/) authentication server. The setup for this is a bit more involved, but it gives you greater security overall, useful for if your instance is exposed to the internet.
|
||||
|
||||
[Keycloak](https://www.keycloak.org/about.html) is a Java-based [open source](https://github.com/keycloak/keycloak), high-performance, secure authentication system, supported by [RedHad](https://www.redhat.com/en). It is easy to setup ([with Docker](https://quay.io/repository/keycloak/keycloak)), and enables you to secure multiple self-hosted applications with single-sign on using standard protocols (OpenID Connect, OAuth 2.0, SAML 2.0 and social login). It's also very customizable, you can write or use custom [themes](https://wjw465150.gitbooks.io/keycloak-documentation/content/server_development/topics/themes.html), [plugins](https://www.keycloak.org/extensions.html), [password policies](https://wjw465150.gitbooks.io/keycloak-documentation/content/server_admin/topics/authentication/password-policies.html) and more.
|
||||
The following guide will walk you through setting up Keycloak with Dashy. If you already have a Keycloak instance configured, then skip to Step 3.
|
||||
|
||||
### 1. Deploy Keycloak
|
||||
|
||||
First thing to do is to spin up a new instance of Keycloak. You will need [Docker installed](https://docs.docker.com/engine/install/), and can then choose a tag, and pull the container from [quay.io/keycloak/keycloak](https://quay.io/repository/keycloak/keycloak)
|
||||
|
||||
Use the following run command, replacing the attributes (default credentials, port and name), or incorporate this into your docker-compose file.
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 8081:8080 \
|
||||
--name auth-server \
|
||||
-e KEYCLOAK_USER=admin \
|
||||
-e KEYCLOAK_PASSWORD=admin \
|
||||
quay.io/keycloak/keycloak:15.0.2
|
||||
```
|
||||
|
||||
If you need to pull from DockerHub, a non-official image is available [here](https://registry.hub.docker.com/r/jboss/keycloak). Or if you would prefer not to use Docker, you can also directly install Keycloak from source, following [this guide](https://www.keycloak.org/docs/latest/getting_started/index.html).
|
||||
|
||||
You should now be able to access the Keycloak web interface, using the port specified above (e.g. `http://127.0.0.1:8081`), login with the default credentials, and when prompted create a new password.
|
||||
|
||||
### 2. Setup Keycloak Users
|
||||
|
||||
Before we can use Keycloak, we must first set it up with some users. Keycloak uses Realms (similar to tenants) to create isolated groups of users. You must create a Realm before you will be able to add your first user.
|
||||
1. Head over to the admin console
|
||||
2. In the top-left corner there is a dropdown called 'Master', hover over it and then click 'Add Realm'
|
||||
3. Give your realm a name, and hit 'Create'
|
||||
|
||||
You can now create your first user.
|
||||
1. In the left-hand menu, click 'Users', then 'Add User'
|
||||
2. Fill in the form, including username and hit 'Save'
|
||||
3. Under the 'Credentials' tab, give the new user an initial password. They will be prompted to change this after first login
|
||||
|
||||
The last thing we need to do in the Keycloak admin console is to create a new client
|
||||
1. Within your new realm, navigate to 'Clients' on the left-hand side, then click 'Create' in the top-right
|
||||
2. Choose a 'Client ID', set 'Client Protocol' to 'openid-connect', and for 'Valid Redirect URIs' put a URL pattern to where you're hosting Dashy (if you're just testing locally, then * is fine), and do the same for the 'Web Origins' field
|
||||
3. Make note of your client-id, and click 'Save'
|
||||
|
||||
### 3. Enable Keycloak in Dashy Config File
|
||||
Now that your Keycloak instance is up and running, all that's left to do is to configure Dashy to use it. Under `appConfig`, set `auth.enableKeycloak: true`, then fill in the details in `auth.keycloak`, including: `serverUrl` - the URL where your Keycloak instance is hosted, `realm` - the name you gave your Realm, and `clientId` - the Client ID you chose.
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
...
|
||||
auth:
|
||||
enableKeycloak: true
|
||||
keycloak:
|
||||
serverUrl: 'http://localhost:8081'
|
||||
realm: 'alicia-homelab'
|
||||
clientId: 'dashy'
|
||||
```
|
||||
Your app is now secured :) When you load Dashy, it will redirect to your Keycloak login page, and any user without valid credentials will be prevented from accessing your dashboard.
|
||||
|
||||
From within the Keycloak console, you can then configure things like user permissions, time outs, password policies, access, etc. You can also backup your full Keycloak config, and it is recommended to do this, along with your Dashy config. You can spin up both Dashy and Keycloak simultaneously and restore both applications configs using a `docker-compose.yml` file, and this is recommended.
|
||||
|
||||
---
|
||||
|
||||
## Alternative Authentication Methods
|
||||
|
||||
If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, then you can either use Keycloak, or one of the following options:
|
||||
- [Authentication Server](#authentication-server) - Put Dashy behind a self-hosted auth server
|
||||
- [VPN](#vpn) - Use a VPN to tunnel into the network where Dashy is running
|
||||
- [IP-Based Access](#ip-based-access) - Disallow access from all IP addresses, except your own
|
||||
- [Web Server Authentication](#web-server-authentication) - Enable user control within your web server or proxy
|
||||
- [OAuth Services](#oauth-services) - Implement a user management system using a cloud provider
|
||||
- [Password Protection (for cloud providers)](#static-site-hosting-providers) - Enable password-protection on your site
|
||||
|
||||
### Authentication Server
|
||||
##### Authelia
|
||||
[Authelia](https://www.authelia.com/) is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains.
|
||||
|
||||
- `git clone https://github.com/authelia/authelia.git`
|
||||
- `cd authelia/examples/compose/lite`
|
||||
- Modify the `users_database.yml` the default username and password is authelia
|
||||
- Modify the `configuration.yml` and `docker-compose.yml` with your respective domains and secrets
|
||||
- `docker-compose up -d`
|
||||
|
||||
For more information, see the [Authelia docs](https://www.authelia.com/docs/)
|
||||
|
||||
### VPN
|
||||
A catch-all solution to accessing services running from your home network remotely is to use a VPN. It means you do not need to worry about implementing complex authentication rules, or trusting the login implementation of individual applications. However it can be inconvenient to use on a day-to-day basis, and some public and corporate WiFi block VPN connections. Two popular VPN protocols are [OpenVPN](https://openvpn.net/) and [WireGuard](https://www.wireguard.com/)
|
||||
|
||||
### IP-Based Access
|
||||
If you have a static IP or use a VPN to access your running services, then you can use conditional access to block access to Dashy from everyone except users of your pre-defined IP address. This feature is offered by most cloud providers, and supported by most web servers.
|
||||
|
||||
##### Apache
|
||||
In Apache, this is configured in your `.htaccess` file in Dashy's root folder, and should look something like:
|
||||
```
|
||||
Order Deny,Allow
|
||||
Deny from all
|
||||
Allow from [your-ip]
|
||||
```
|
||||
|
||||
##### NGINX
|
||||
In NGINX you can specify [control access](https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/) rules for a given site in your `nginx.conf` or hosts file. For example:
|
||||
```
|
||||
server {
|
||||
listen 80;
|
||||
server_name www.dashy.example.com;
|
||||
location / {
|
||||
root /path/to/dashy/;
|
||||
passenger_enabled on;
|
||||
allow [your-ip];
|
||||
deny all;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### Caddy
|
||||
In Caddy, [Request Matchers](https://caddyserver.com/docs/caddyfile/matchers) can be used to filter requests
|
||||
```
|
||||
dashy.site {
|
||||
@public_networks not remote_ip [your-ip]
|
||||
respond @public_networks "Access denied" 403
|
||||
}
|
||||
```
|
||||
|
||||
### Web Server Authentication
|
||||
Most web servers make password protecting certain apps very easy. Note that you should also set up HTTPS and have a valid certificate in order for this to be secure.
|
||||
|
||||
##### Apache
|
||||
First crate a `.htaccess` file in Dashy's route directory. Specify the auth type and path to where you want to store the password file (usually the same folder). For example:
|
||||
```
|
||||
AuthType Basic
|
||||
AuthName "Please Sign into Dashy"
|
||||
AuthUserFile /path/dashy/.htpasswd
|
||||
require valid-user
|
||||
```
|
||||
|
||||
Then create a `.htpasswd` file in the same directory. List users and their hashed passwords here, with one user on each line, and a colon between username and password (e.g. `[username]:[hashed-password]`). You will need to generate an MD5 hash of your desired password, this can be done with an [online tool](https://www.web2generators.com/apache-tools/htpasswd-generator). Your file will look something like:
|
||||
```
|
||||
alicia:$apr1$jv0spemw$RzOX5/GgY69JMkgV6u16l0
|
||||
```
|
||||
|
||||
##### NGINX
|
||||
NGINX has an [authentication module](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html) which can be used to add passwords to given sites, and is fairly simple to set up. Similar to above, you will need to create a `.htpasswd` file. Then just enable auth and specify the path to that file, for example:
|
||||
```
|
||||
location / {
|
||||
auth_basic "closed site";
|
||||
auth_basic_user_file conf/htpasswd;
|
||||
}
|
||||
```
|
||||
##### Caddy
|
||||
Caddy has a [basic-auth](https://caddyserver.com/docs/caddyfile/directives/basicauth) directive, where you specify a username and hash. The password hash needs to be base-64 encoded, the [`caddy hash-password`](https://caddyserver.com/docs/command-line#caddy-hash-password) command can help with this. For example:
|
||||
```
|
||||
basicauth /secret/* {
|
||||
alicia JDJhJDEwJEVCNmdaNEg2Ti5iejRMYkF3MFZhZ3VtV3E1SzBWZEZ5Q3VWc0tzOEJwZE9TaFlZdEVkZDhX
|
||||
}
|
||||
```
|
||||
|
||||
For more info about implementing a single sign on for all your apps with Caddy, see [this tutorial](https://joshstrange.com/securing-your-self-hosted-apps-with-single-signon/)
|
||||
|
||||
##### Lighttpd
|
||||
You can use the [mod_auth](https://doc.lighttpd.net/lighttpd2/mod_auth.html) module to secure your site with Lighttpd. Like with Apache, you need to first create a password file listing your usersnames and hashed passwords, but in Lighttpd, it's usually called `.lighttpdpassword`.
|
||||
|
||||
Then in your `lighttpd.conf` file (usually in the `/etc/lighttpd/` directory), load in the mod_auth module, and configure it's directives. For example:
|
||||
```
|
||||
server.modules += ( "mod_auth" )
|
||||
auth.debug = 2
|
||||
auth.backend = "plain"
|
||||
auth.backend.plain.userfile = "/home/lighttpd/.lighttpdpassword"
|
||||
|
||||
$HTTP["host"] == "dashy.my-domain.net" {
|
||||
server.document-root = "/home/lighttpd/dashy.my-domain.net/http"
|
||||
server.errorlog = "/var/log/lighttpd/dashy.my-domain.net/error.log"
|
||||
accesslog.filename = "/var/log/lighttpd/dashy.my-domain.net/access.log"
|
||||
auth.require = (
|
||||
"/docs/" => (
|
||||
"method" => "basic",
|
||||
"realm" => "Password protected area",
|
||||
"require" => "user=alicia"
|
||||
)
|
||||
)
|
||||
}
|
||||
```
|
||||
Restart your web server for changes to take effect.
|
||||
|
||||
### OAuth Services
|
||||
There are also authentication services, such as [Ory.sh](https://www.ory.sh/), [Okta](https://developer.okta.com/), [Auth0](https://auth0.com/), [Firebase](https://firebase.google.com/docs/auth/). Implementing one of these solutions would involve some changes to the [`Auth.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/Auth.js) file, but should be fairly straight forward.
|
||||
|
||||
### Static Site Hosting Providers
|
||||
If you are hosting Dashy on a cloud platform, you will probably find that it has built-in support for password protected access to web apps. For more info, see the relevant docs for your provider, for example: [Netlify Password Protection](https://docs.netlify.com/visitor-access/password-protection/), [Cloudflare Access](https://www.cloudflare.com/teams/access/), [AWS Cognito](https://aws.amazon.com/cognito/), [Azure Authentication](https://docs.microsoft.com/en-us/azure/app-service/scenario-secure-app-authentication-app-service) and [Vercel Password Protection](https://vercel.com/docs/platform/projects#password-protection).
|
||||
|
||||
**[⬆️ Back to Top](#authentication)**
|
||||
# Authentication
|
||||
|
||||
- [Basic Auth](#built-in-auth)
|
||||
- [Setting Up Authentication](#setting-up-authentication)
|
||||
- [Hash Password](#hash-password)
|
||||
- [Logging In and Out](#logging-in-and-out)
|
||||
- [Guest Access](#enabling-guest-access)
|
||||
- [Per-User Access](#granular-access)
|
||||
- [Using Environment Variables for Passwords](#using-environment-variables-for-passwords)
|
||||
- [Adding HTTP Auth to Configuration](#adding-http-auth-to-configuration)
|
||||
- [Security Considerations](#security)
|
||||
- [HTTP Auth](#http-auth)
|
||||
- [Keycloak Auth](#keycloak)
|
||||
- [Deploying Keycloak](#1-deploy-keycloak)
|
||||
- [Setting up Keycloak](#2-setup-keycloak-users)
|
||||
- [Configuring Dashy for Keycloak](#3-enable-keycloak-in-dashy-config-file)
|
||||
- [Alternative Authentication Methods](#alternative-authentication-methods)
|
||||
- [VPN](#vpn)
|
||||
- [IP-Based Access](#ip-based-access)
|
||||
- [Web Server Authentication](#web-server-authentication)
|
||||
- [OAuth Services](#oauth-services)
|
||||
- [Auth on Cloud Hosting Services](#static-site-hosting-providers)
|
||||
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Dashy's built-in auth is not indented to protect a publicly hosted instance against unauthorized access. Instead you should use an auth provider compatible with your reverse proxy, or access Dashy via your VPN, or implement your own SSO logic.
|
||||
>
|
||||
> In cases where Dashy is only accessibly within your home network, and you just want to add a login page, then the built-in auth may be sufficient, but keep in mind that configuration can still be accessed.
|
||||
|
||||
## Built-In Auth
|
||||
|
||||
Dashy has a basic login page included, and frontend authentication. You can enable this by adding users to the `auth` section under `appConfig` in your `conf.yml`. If this section is not specified, then no authentication will be required to access the app, and the homepage will resolve to your dashboard.
|
||||
|
||||
> [!NOTE]
|
||||
> Since the auth is initiated in the main app entry point (for security), a rebuild is required to apply changes to the auth configuration.
|
||||
> You can trigger a rebuild through the UI, under Config --> Rebuild, or by running `yarn build` in the root directory.
|
||||
|
||||
|
||||
### Setting Up Authentication
|
||||
|
||||
The `auth` property takes an array of users. Each user needs to include a username, hash and optional user type (`admin` or `normal`). The hash property is a [SHA-256 Hash](https://en.wikipedia.org/wiki/SHA-2) of your desired password.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
auth:
|
||||
users:
|
||||
- user: alicia
|
||||
hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
|
||||
type: admin
|
||||
- user: bob
|
||||
hash: 5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8
|
||||
```
|
||||
|
||||
### Hash Password
|
||||
|
||||
Dashy uses [SHA-256 Hash](https://en.wikipedia.org/wiki/Sha-256), a 64-character string, which you can generate using an online tool, such as [this one](https://passwordsgenerator.net/sha256-hash-generator/) or [CyberChef](https://gchq.github.io/CyberChef/) (which can be self-hosted/ ran locally).
|
||||
|
||||
A hash is a one-way cryptographic function, meaning that it is easy to generate a hash for a given password, but very hard to determine the original password for a given hash. This means, that so long as your password is long, strong and unique, it is safe to store its hash in the clear. Having said that, you should never reuse passwords, hashes can be cracked by iterating over known password lists, generating a hash of each.
|
||||
|
||||
### Logging In and Out
|
||||
|
||||
Once authentication is enabled, so long as there is no valid token in cookie storage, the application will redirect the user to the login page. When the user enters credentials in the login page, they will be checked, and if valid, then a token will be generated, and they can be redirected to the home page. If credentials are invalid, then an error message will be shown, and they will remain on the login page. Once in the application, to log out: the user can click the logout button (in the top-right), which will clear cookie storage, causing them to be redirected back to the login page.
|
||||
|
||||
### Enabling Guest Access
|
||||
|
||||
With authentication set up, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting `appConfig.auth.enableGuestAccess: true`.
|
||||
|
||||
### Granular Access
|
||||
|
||||
You can use the following properties to make certain pages, sections or items only visible to some users, or hide pages, sections and items from guests.
|
||||
|
||||
- `hideForUsers` - Page, Section or Item will be visible to all users, except for those specified in this list
|
||||
- `showForUsers` - Page, Section or Item will be hidden from all users, except for those specified in this list
|
||||
- `hideForGuests` - Page, Section or Item will be visible for logged in users, but not for guests
|
||||
|
||||
For Example:
|
||||
```yaml
|
||||
pages:
|
||||
- name: Home Lab
|
||||
path: home-lab.yml
|
||||
displayData:
|
||||
showForUsers: [admin]
|
||||
- name: Intranet
|
||||
path: intranet.yml
|
||||
displayData:
|
||||
hideForGuests: true
|
||||
hideForUsers: [alicia, bob]
|
||||
```
|
||||
|
||||
```yaml
|
||||
- name: Code Analysis & Monitoring
|
||||
icon: fas fa-code
|
||||
displayData:
|
||||
cols: 2
|
||||
hideForUsers: [alicia, bob]
|
||||
items:
|
||||
...
|
||||
```
|
||||
|
||||
```yaml
|
||||
- name: Deployment Pipelines
|
||||
icon: fas fa-rocket
|
||||
displayData:
|
||||
hideForGuests: true
|
||||
items:
|
||||
- title: Hide Me
|
||||
displayData:
|
||||
hideForUsers: [alicia, bob]
|
||||
```
|
||||
|
||||
### Permissions
|
||||
|
||||
Any user who is not an admin (with `type: admin`) will not be able to write changes to disk.
|
||||
|
||||
You can also prevent any user from writing changes to disk, using `preventWriteToDisk`. Or prevent any changes from being saved locally in browser storage, using `preventLocalSave`. Both properties can be found under [`appConfig`](./docs/configuring.md#appconfig-optional).
|
||||
|
||||
To disable all UI config features, including View Config, set `disableConfiguration`. Alternatively you can disable UI config features for all non admin users by setting `disableConfigurationForNonAdmin` to true.
|
||||
|
||||
### Using Environment Variables for Passwords
|
||||
|
||||
If you don't want to hash your password, you can instead leave out the `hash` attribute, and replace it with `password` which should have the value of an environmental variable name you wish to use.
|
||||
|
||||
Note that env var must begin with `VUE_APP_`, and you must set this variable before building the app.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
auth:
|
||||
users:
|
||||
- user: bob
|
||||
password: VUE_APP_BOB
|
||||
```
|
||||
|
||||
Just be sure to set `VUE_APP_BOB='my super secret password'` before build-time.
|
||||
|
||||
### Adding HTTP Auth to Configuration
|
||||
|
||||
If you'd also like to prevent direct visit access to your configuration file, you can set the `ENABLE_HTTP_AUTH` environmental variable.
|
||||
|
||||
### Security
|
||||
|
||||
With basic auth, all logic is happening on the client-side, which could mean a skilled user could manipulate the code to view parts of your configuration, including the hash. If the SHA-256 hash is of a common password, it may be possible to determine it, using a lookup table, in order to find the original password. Which can be used to manually generate the auth token, that can then be inserted into session storage, to become a valid logged in user. Therefore, you should always use a long, strong and unique password, and if you instance contains security-critical info and/ or is exposed directly to the internet, and alternative authentication method may be better. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage.
|
||||
|
||||
**[⬆️ Back to Top](#authentication)**
|
||||
|
||||
---
|
||||
|
||||
## HTTP Auth
|
||||
|
||||
If you'd like to protect all your config files from direct access, you can set the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environmental variables. You'll then be prompted to enter these credentials when visiting Dashy.
|
||||
|
||||
Then, if you'd like your frontend to automatically log you in, without prompting you for credentials, then also specify `VUE_APP_BASIC_AUTH_USERNAME` and `VUE_APP_BASIC_AUTH_PASSWORD`. This is useful for when you're hosting Dashy on a private server, and you want to prevent unauthorized access to your config files, while still allowing the frontend to access them. Note that a rebuild is required for these changes to take effect.
|
||||
|
||||
**[⬆️ Back to Top](#authentication)**
|
||||
|
||||
---
|
||||
|
||||
## Keycloak
|
||||
|
||||
Dashy also supports using a [Keycloak](https://www.keycloak.org/) authentication server. The setup for this is a bit more involved, but it gives you greater security overall, useful for if your instance is exposed to the internet.
|
||||
|
||||
[Keycloak](https://www.keycloak.org/about.html) is a Java-based [open source](https://github.com/keycloak/keycloak), high-performance, secure authentication system, supported by [RedHat](https://www.redhat.com/en). It is easy to setup ([with Docker](https://quay.io/repository/keycloak/keycloak)), and enables you to secure multiple self-hosted applications with single-sign-on using standard protocols (OpenID Connect, OAuth 2.0, SAML 2.0 and social login). It's also very customizable, you can write or use custom [themes](https://wjw465150.gitbooks.io/keycloak-documentation/content/server_development/topics/themes.html), [plugins](https://www.keycloak.org/extensions.html), [password policies](https://wjw465150.gitbooks.io/keycloak-documentation/content/server_admin/topics/authentication/password-policies.html) and more.
|
||||
The following guide will walk you through setting up Keycloak with Dashy. If you already have a Keycloak instance configured, then skip to Step 3.
|
||||
|
||||
### 1. Deploy Keycloak
|
||||
|
||||
First thing to do is to spin up a new instance of Keycloak. You will need [Docker installed](https://docs.docker.com/engine/install/), and can then choose a tag, and pull the container from [quay.io/keycloak/keycloak](https://quay.io/repository/keycloak/keycloak)
|
||||
|
||||
Use the following run command, replacing the attributes (default credentials, port and name), or incorporate this into your docker-compose file.
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 8081:8080 \
|
||||
--name auth-server \
|
||||
-e KEYCLOAK_USER=admin \
|
||||
-e KEYCLOAK_PASSWORD=admin \
|
||||
quay.io/keycloak/keycloak:15.0.2
|
||||
```
|
||||
|
||||
If you need to pull from DockerHub, a non-official image is available [here](https://registry.hub.docker.com/r/jboss/keycloak). Or if you would prefer not to use Docker, you can also directly install Keycloak from source, following [this guide](https://www.keycloak.org/docs/latest/getting_started/index.html).
|
||||
|
||||
You should now be able to access the Keycloak web interface, using the port specified above (e.g. `http://127.0.0.1:8081`), login with the default credentials, and when prompted create a new password.
|
||||
|
||||
### 2. Setup Keycloak Users
|
||||
|
||||
Before we can use Keycloak, we must first set it up with some users. Keycloak uses Realms (similar to tenants) to create isolated groups of users. You must create a Realm before you will be able to add your first user.
|
||||
|
||||
1. Head over to the admin console
|
||||
2. In the top-left corner there is a dropdown called 'Master', hover over it and then click 'Add Realm'
|
||||
3. Give your realm a name, and hit 'Create'
|
||||
|
||||
You can now create your first user.
|
||||
|
||||
1. In the left-hand menu, click 'Users', then 'Add User'
|
||||
2. Fill in the form, including username and hit 'Save'
|
||||
3. Under the 'Credentials' tab, give the new user an initial password. They will be prompted to change this after first login
|
||||
|
||||
The last thing we need to do in the Keycloak admin console is to create a new client
|
||||
|
||||
1. Within your new realm, navigate to 'Clients' on the left-hand side, then click 'Create' in the top-right
|
||||
2. Choose a 'Client ID', set 'Client Protocol' to 'openid-connect', and for 'Valid Redirect URIs' put a URL pattern to where you're hosting Dashy (if you're just testing locally, then * is fine), and do the same for the 'Web Origins' field
|
||||
3. Make note of your client-id, and click 'Save'
|
||||
|
||||
### 3. Enable Keycloak in Dashy Config File
|
||||
|
||||
Now that your Keycloak instance is up and running, all that's left to do is to configure Dashy to use it. Under `appConfig`, set `auth.enableKeycloak: true`, then fill in the details in `auth.keycloak`, including: `serverUrl` - the URL where your Keycloak instance is hosted, `realm` - the name you gave your Realm, and `clientId` - the Client ID you chose.
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
...
|
||||
auth:
|
||||
enableKeycloak: true
|
||||
keycloak:
|
||||
serverUrl: 'http://localhost:8081'
|
||||
realm: 'alicia-homelab'
|
||||
clientId: 'dashy'
|
||||
```
|
||||
|
||||
Note that if you are using Keycloak V 17 or older, you will also need to set `legacySupport: true` (also under `appConfig.auth.keycloak`). This is because the API endpoint was updated in later versions.
|
||||
|
||||
If you use Keycloak with an external Identity Provier, you can set the `idpHint: 'alias-of-kc-idp'` option to allow the IdP Hint to be passed to Keycloak. This will cause Keycloak to skip its login page and redirect the user directly to the specified IdP's login page. Set to the value of the 'Alias' field of the desired IdP as defined in Keycloak under 'Identity Providers'.
|
||||
|
||||
### 4. Add groups and roles (Optional)
|
||||
|
||||
Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy.
|
||||
Keycloak server administration and configuration is a deep topic; please refer to the [server admin guide](https://www.keycloak.org/docs/latest/server_admin/index.html#assigning-permissions-and-access-using-roles-and-groups) to see details about creating and assigning roles and groups.
|
||||
Once you have groups or roles assigned to users you can configure access under each section or item `displayData.showForKeycloakUser` and `displayData.hideForKeycloakUser`.
|
||||
Both show and hide configurations accept a list of `groups` and `roles` that limit access. If a users data matches one or more items in these lists they will be allowed or excluded as defined.
|
||||
|
||||
```yaml
|
||||
sections:
|
||||
- name: DeveloperResources
|
||||
displayData:
|
||||
showForKeycloakUsers:
|
||||
roles: ['canViewDevResources']
|
||||
hideForKeycloakUsers:
|
||||
groups: ['ProductTeam']
|
||||
items:
|
||||
- title: Not Visible for developers
|
||||
displayData:
|
||||
hideForKeycloakUsers:
|
||||
groups: ['DevelopmentTeam']
|
||||
```
|
||||
|
||||
Depending on how you're hosting Dashy and Keycloak, you may also need to set some HTTP headers, to prevent a CORS error. This would typically be the `Access-Control-Allow-Origin [URL-of Dashy]` on your Keycloak instance. See the [Setting Headers](https://github.com/Lissy93/dashy/blob/master/docs/management.md#setting-headers) guide in the management docs for more info.
|
||||
|
||||
Your app is now secured :) When you load Dashy, it will redirect to your Keycloak login page, and any user without valid credentials will be prevented from accessing your dashboard.
|
||||
|
||||
From within the Keycloak console, you can then configure things like time-outs, password policies, etc. You can also backup your full Keycloak config, and it is recommended to do this, along with your Dashy config. You can spin up both Dashy and Keycloak simultaneously and restore both applications configs using a `docker-compose.yml` file, and this is recommended.
|
||||
|
||||
---
|
||||
|
||||
## Alternative Authentication Methods
|
||||
|
||||
If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, then you can either use Keycloak, or one of the following options:
|
||||
|
||||
- [Authentication Server](#authentication-server) - Put Dashy behind a self-hosted auth server
|
||||
- [VPN](#vpn) - Use a VPN to tunnel into the network where Dashy is running
|
||||
- [IP-Based Access](#ip-based-access) - Disallow access from all IP addresses, except your own
|
||||
- [Web Server Authentication](#web-server-authentication) - Enable user control within your web server or proxy
|
||||
- [OAuth Services](#oauth-services) - Implement a user management system using a cloud provider
|
||||
- [Password Protection (for cloud providers)](#static-site-hosting-providers) - Enable password-protection on your site
|
||||
|
||||
### Authentication Server
|
||||
|
||||
#### Authelia
|
||||
|
||||
[Authelia](https://www.authelia.com/) is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains.
|
||||
|
||||
- `git clone https://github.com/authelia/authelia.git`
|
||||
- `cd authelia/examples/compose/lite`
|
||||
- Modify the `users_database.yml` the default username and password is authelia
|
||||
- Modify the `configuration.yml` and `docker-compose.yml` with your respective domains and secrets
|
||||
- `docker-compose up -d`
|
||||
|
||||
For more information, see the [Authelia docs](https://www.authelia.com/docs/)
|
||||
|
||||
### VPN
|
||||
|
||||
A catch-all solution to accessing services running from your home network remotely is to use a VPN. It means you do not need to worry about implementing complex authentication rules, or trusting the login implementation of individual applications. However it can be inconvenient to use on a day-to-day basis, and some public and corporate WiFi block VPN connections. Two popular VPN protocols are [OpenVPN](https://openvpn.net/) and [WireGuard](https://www.wireguard.com/)
|
||||
|
||||
### IP-Based Access
|
||||
|
||||
If you have a static IP or use a VPN to access your running services, then you can use conditional access to block access to Dashy from everyone except users of your pre-defined IP address. This feature is offered by most cloud providers, and supported by most web servers.
|
||||
|
||||
#### Apache
|
||||
|
||||
In Apache, this is configured in your `.htaccess` file in Dashy's root folder, and should look something like:
|
||||
|
||||
```text
|
||||
Order Deny,Allow
|
||||
Deny from all
|
||||
Allow from [your-ip]
|
||||
```
|
||||
|
||||
#### NGINX
|
||||
|
||||
In NGINX you can specify [control access](https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/) rules for a given site in your `nginx.conf` or hosts file. For example:
|
||||
|
||||
```text
|
||||
server {
|
||||
listen 8080;
|
||||
server_name www.dashy.example.com;
|
||||
location / {
|
||||
root /path/to/dashy/;
|
||||
passenger_enabled on;
|
||||
allow [your-ip];
|
||||
deny all;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Caddy
|
||||
|
||||
In Caddy, [Request Matchers](https://caddyserver.com/docs/caddyfile/matchers) can be used to filter requests
|
||||
|
||||
```text
|
||||
dashy.site {
|
||||
@public_networks not remote_ip [your-ip]
|
||||
respond @public_networks "Access denied" 403
|
||||
}
|
||||
```
|
||||
|
||||
### Web Server Authentication
|
||||
|
||||
Most web servers make password protecting certain apps very easy. Note that you should also set up HTTPS and have a valid certificate in order for this to be secure.
|
||||
|
||||
#### Apache
|
||||
|
||||
First crate a `.htaccess` file in Dashy's route directory. Specify the auth type and path to where you want to store the password file (usually the same folder). For example:
|
||||
|
||||
```text
|
||||
AuthType Basic
|
||||
AuthName "Please Sign into Dashy"
|
||||
AuthUserFile /path/dashy/.htpasswd
|
||||
require valid-user
|
||||
```
|
||||
|
||||
Then create a `.htpasswd` file in the same directory. List users and their hashed passwords here, with one user on each line, and a colon between username and password (e.g. `[username]:[hashed-password]`). You will need to generate an MD5 hash of your desired password, this can be done with an [online tool](https://www.web2generators.com/apache-tools/htpasswd-generator). Your file will look something like:
|
||||
|
||||
```text
|
||||
alicia:$apr1$jv0spemw$RzOX5/GgY69JMkgV6u16l0
|
||||
```
|
||||
|
||||
#### NGINX
|
||||
|
||||
NGINX has an [authentication module](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html) which can be used to add passwords to given sites, and is fairly simple to set up. Similar to above, you will need to create a `.htpasswd` file. Then just enable auth and specify the path to that file, for example:
|
||||
|
||||
```text
|
||||
location / {
|
||||
auth_basic "closed site";
|
||||
auth_basic_user_file conf/htpasswd;
|
||||
}
|
||||
```
|
||||
|
||||
#### Caddy
|
||||
|
||||
Caddy has a [basic-auth](https://caddyserver.com/docs/caddyfile/directives/basicauth) directive, where you specify a username and hash. The password hash needs to be base-64 encoded, the [`caddy hash-password`](https://caddyserver.com/docs/command-line#caddy-hash-password) command can help with this. For example:
|
||||
|
||||
```text
|
||||
basicauth /secret/* {
|
||||
alicia JDJhJDEwJEVCNmdaNEg2Ti5iejRMYkF3MFZhZ3VtV3E1SzBWZEZ5Q3VWc0tzOEJwZE9TaFlZdEVkZDhX
|
||||
}
|
||||
```
|
||||
|
||||
For more info about implementing a single sign on for all your apps with Caddy, see [this tutorial](https://joshstrange.com/securing-your-self-hosted-apps-with-single-signon/)
|
||||
|
||||
#### Lighttpd
|
||||
|
||||
You can use the [mod_auth](https://doc.lighttpd.net/lighttpd2/mod_auth.html) module to secure your site with Lighttpd. Like with Apache, you need to first create a password file listing your usernames and hashed passwords, but in Lighttpd, it's usually called `.lighttpdpassword`.
|
||||
|
||||
Then in your `lighttpd.conf` file (usually in the `/etc/lighttpd/` directory), load in the mod_auth module, and configure it's directives. For example:
|
||||
|
||||
```text
|
||||
server.modules += ( "mod_auth" )
|
||||
auth.debug = 2
|
||||
auth.backend = "plain"
|
||||
auth.backend.plain.userfile = "/home/lighttpd/.lighttpdpassword"
|
||||
|
||||
$HTTP["host"] == "dashy.my-domain.net" {
|
||||
server.document-root = "/home/lighttpd/dashy.my-domain.net/http"
|
||||
server.errorlog = "/var/log/lighttpd/dashy.my-domain.net/error.log"
|
||||
accesslog.filename = "/var/log/lighttpd/dashy.my-domain.net/access.log"
|
||||
auth.require = (
|
||||
"/docs/" => (
|
||||
"method" => "basic",
|
||||
"realm" => "Password protected area",
|
||||
"require" => "user=alicia"
|
||||
)
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
Restart your web server for changes to take effect.
|
||||
|
||||
### OAuth Services
|
||||
|
||||
There are also authentication services, such as [Ory.sh](https://www.ory.sh/), [Okta](https://developer.okta.com/), [Auth0](https://auth0.com/), [Firebase](https://firebase.google.com/docs/auth/). Implementing one of these solutions would involve some changes to the [`Auth.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/Auth.js) file, but should be fairly straightforward.
|
||||
|
||||
### Static Site Hosting Providers
|
||||
|
||||
If you are hosting Dashy on a cloud platform, you will probably find that it has built-in support for password protected access to web apps. For more info, see the relevant docs for your provider, for example: [Netlify Password Protection](https://docs.netlify.com/visitor-access/password-protection/), [Cloudflare Access](https://www.cloudflare.com/teams/access/), [AWS Cognito](https://aws.amazon.com/cognito/), [Azure Authentication](https://docs.microsoft.com/en-us/azure/app-service/scenario-secure-app-authentication-app-service) and [Vercel Password Protection](https://vercel.com/docs/platform/projects#password-protection).
|
||||
|
||||
**[⬆️ Back to Top](#authentication)**
|
||||
|
|
|
@ -1,4 +1,6 @@
|
|||
### Cloud Backup and Restore
|
||||
# Cloud Backup and Restore
|
||||
|
||||
Beyond the cloud backup/restore service, there are several other self-hosted options you can use to backup Dashy, and any other Docker container data. These are outlined in the Management docs, at: [Docker Backup Options](/docs/management.md#backing-up).
|
||||
|
||||
Dashy has a built-in feature for securely backing up your config to a hosted cloud service, and then restoring it on another instance. This feature is totally optional, and if you do not enable it, then Dashy will not make any external network requests.
|
||||
|
||||
|
@ -8,18 +10,19 @@ This is useful not only for backing up your configuration off-site, but it also
|
|||
<img src="https://i.ibb.co/p4pxSqX/dashy-backup-restore.png" width="600" />
|
||||
</p>
|
||||
|
||||
### How it Works
|
||||
## How it Works
|
||||
|
||||
All data is encrypted before being sent to the backend. In Dashy, this is done in [`CloudBackup.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js), using [crypto.js](https://github.com/brix/crypto-js)'s AES method, using the users chosen password as the key. The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) (a platform for running serverless functions), and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store.
|
||||
|
||||
## Creating a Backup
|
||||
|
||||
### Creating a Backup
|
||||
Once you've got Dashy configured to your preference, open the Backup & Restore menu (click the Cloud icon in the top-right corner). Here you will be prompted to choose a password, which will be used to encrypt your data. If you forget this password, there will be no way to recover your config. After clicking 'Backup' your data will be encrypted, compressed and sent to the hosted cloud service. A backup ID will be returned (in the format of xxxx-xxxx-xxxx-xxxx), this is what you use, along with your password to restore the backup on another system, so take note of it. To update a backup, return to this menu, enter your password, and click 'Update Backup'.
|
||||
|
||||
### Restoring a Backup
|
||||
To restore a backup, navigate to the Backup & Restore menu, and under restore, enter your backup ID, and the password you chose. Your config file will be downloaded, decrypted and applied to local storage.
|
||||
## Restoring a Backup
|
||||
|
||||
### Privacy & Security
|
||||
To restore a backup, navigate to the Backup & Restore menu, and under restore, enter your backup ID, and the password you chose. Your config file will be downloaded, decrypted and applied to local storage.
|
||||
|
||||
## Privacy & Security
|
||||
|
||||
Data is only ever sent to the cloud when the user actively triggers a backup. All transmitted data is first encrypted using [AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard). Your selected password never leaves your device, and is hashed before being compared. It is only possible to restore a configuration if you have both the backup ID and decryption password.
|
||||
|
||||
|
@ -27,24 +30,23 @@ Because the data is encrypted on the client-side (before being sent to the cloud
|
|||
|
||||
Having said that, although the code uses robust security libraries and is open source- it was never intended to be a security product, and has not been audited, and therefore cannot be considered totally secure - please keep that in mind.
|
||||
|
||||
|
||||
### Fair Use Policy
|
||||
## Fair Use Policy
|
||||
|
||||
Maximum of 24mb of storage per user. Please do not repeatedly hit the endpoint, as if the quota is exceeded the service may become less available to other users. Abuse may result in your IP being temporarily banned by Cloudflare.
|
||||
|
||||
---
|
||||
|
||||
### Self-Hosting the Backup Server
|
||||
## Self-Hosting the Backup Server
|
||||
|
||||
### Quick Start
|
||||
|
||||
#### Quick Start
|
||||
- Install Wrangler CLI Tool: `npm i -g @cloudflare/wrangler`
|
||||
- Log into Cloudflare account: `wrangler login`
|
||||
- Create a new project: ` wrangler generate my-project`
|
||||
- Create a new project: `wrangler generate my-project`
|
||||
- Install dependencies: `cd my-project` && `npm i`
|
||||
|
||||
### Populate `wrangler.toml`
|
||||
|
||||
#### Populate `wrangler.toml`
|
||||
- Add your `account_id` (found on the right sidebar of the Workers or Overview Dashboard)
|
||||
- Add your `zone_id` (found in the Overview tab of your desired domain on Cloudflare)
|
||||
- Add your `route`, which should be a domain or host, supporting a wildcard
|
||||
|
@ -63,10 +65,11 @@ kv_namespaces = [
|
|||
]
|
||||
```
|
||||
|
||||
#### Complete `index.js`
|
||||
### Complete `index.js`
|
||||
|
||||
- Write code to handle your requests, and interact with any other data sources in this file
|
||||
- Generally, this is done within an event listener for 'fetch', and returns a promise
|
||||
- For Example:
|
||||
- For Example:
|
||||
|
||||
```javascript
|
||||
addEventListener('fetch', event => {
|
||||
|
@ -82,28 +85,28 @@ async function handleRequest(request) {
|
|||
|
||||
- For the code used for Dashy's cloud service, see [here](https://gist.github.com/Lissy93/d19b43d50f30e02fa25f349cf5cb5ed8#file-index-js)
|
||||
|
||||
### Commands
|
||||
|
||||
#### Commands
|
||||
- `wrangler dev` - To start the wrangler development server
|
||||
- `wrangler publish` - To publish to your cloudflare account (first run `wrangler login`)
|
||||
|
||||
### API
|
||||
## API
|
||||
|
||||
There are four endpoints, and to keep things simple, they all use the same base URL/ route.
|
||||
|
||||
- **`GET`** - Get config for a given user
|
||||
- `backupId` - The ID of the desired encrypted object
|
||||
- `subHash` - The latter half of the password hash, to verify ownership
|
||||
- `backupId` - The ID of the desired encrypted object
|
||||
- `subHash` - The latter half of the password hash, to verify ownership
|
||||
- **`POST`** - Save a new config object, and returns `backupId`
|
||||
- `userData` - The encrypted, compressed and stringified user config
|
||||
- `subHash` - The latter half of the password hash, to verify ownership
|
||||
- `userData` - The encrypted, compressed and stringified user config
|
||||
- `subHash` - The latter half of the password hash, to verify ownership
|
||||
- **`PUT`** - Update an existing config object
|
||||
- `backupId` - The ID of the object to update
|
||||
- `subHash` - Part of the hash, to verify ownership of said object
|
||||
- `userData` - The new data to store
|
||||
- `backupId` - The ID of the object to update
|
||||
- `subHash` - Part of the hash, to verify ownership of said object
|
||||
- `userData` - The new data to store
|
||||
- **`DELETE`** - Delete a specified config object
|
||||
- `backupId` - The ID of the object to be deleted
|
||||
- `subHash` - Part of the password hash, to verify ownership of the object
|
||||
- `backupId` - The ID of the object to be deleted
|
||||
- `subHash` - Part of the password hash, to verify ownership of the object
|
||||
|
||||
For more info, see the [API Docs](https://documenter.getpostman.com/view/2142819/TzXumzce).
|
||||
|
||||
|
|
|
@ -1,298 +1,400 @@
|
|||
# Configuring
|
||||
|
||||
All app configuration is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) which is in [YAML Format](https://yaml.org/) format. Changes can also be made [directly through the UI](#editing-config-through-the-ui) and previewed live, from here you can also export, backup, reset, validate and download your configuration file.
|
||||
|
||||
The following file provides a reference of all supported configuration options.
|
||||
|
||||
---
|
||||
|
||||
#### Contents
|
||||
|
||||
- [**`pageInfo`**](#pageinfo) - Header text, footer, title, navigation, etc
|
||||
- [`navLinks`](#pageinfonavlinks-optional) - Navigation bar items and links
|
||||
- [**`appConfig`**](#appconfig-optional) - Main application settings
|
||||
- [`webSearch`](#appconfigwebsearch-optional) - Configure web search engine options
|
||||
- [`hideComponents`](#appconfighidecomponents-optional) - Show/ hide page components
|
||||
- [`auth`](#appconfigauth-optional) - Built-in authentication setup
|
||||
- [`users`](#appconfigauthusers-optional) - Setup for simple auth
|
||||
- [`keycloak`](#appconfigauthkeycloak-optional) - Auth using Keycloak
|
||||
- [**`sections`**](#section) - List of sections
|
||||
- [`displayData`](#sectiondisplaydata-optional) - Section display settings
|
||||
- [`icon`](#sectionicon-and-sectionitemicon) - Icon for a section
|
||||
- [`items`](#sectionitem) - List of items
|
||||
- [`icon`](#sectionicon-and-sectionitemicon) - Icon for an item
|
||||
- [**Notes**](#notes)
|
||||
- [Editing Config through the UI](#editing-config-through-the-ui)
|
||||
- [About YAML](#about-yaml)
|
||||
- [Config Saving Methods](#config-saving-methods)
|
||||
- [Preventing Changes](#preventing-changes-being-written-to-disk)
|
||||
- [Example](#example)
|
||||
|
||||
---
|
||||
|
||||
Tips:
|
||||
- You may find it helpful to look at some sample config files to get you started, a collection of which can be found [here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
|
||||
- You can check that your config file fits the schema, by running `yarn validate-config`
|
||||
- After modifying your config, the app needs to be recompiled, by running `yarn build` - this happens automatically whilst the app is running if you're using Docker
|
||||
- It is recommended to make and keep a backup of your config file. You can download your current config through the UI either from the Config menu, or using the `/download` endpoint. Alternatively, you can use the [Cloud Backup](./docs/backup-restore.md) feature.
|
||||
- The config can also be modified directly through the UI, validated and written to the conf.yml file.
|
||||
- All fields are optional, unless otherwise stated.
|
||||
|
||||
---
|
||||
|
||||
### Top-Level Fields
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`pageInfo`** | `object` | Required | Basic meta data like title, description, nav bar links, footer text. See [`pageInfo`](#pageinfo)
|
||||
**`appConfig`** | `object` | _Optional_ | Settings related to how the app functions, including API keys and global styles. See [`appConfig`](#appconfig-optional)
|
||||
**`sections`** | `array` | Required | An array of sections, each containing an array of items, which will be displayed as links. See [`section`](#section)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `PageInfo`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`title`** | `string` | Required | Your dashboard title, displayed in the header and browser tab
|
||||
**`description`** | `string` | _Optional_ | Description of your dashboard, also displayed as a subtitle
|
||||
**`navLinks`** | `array` | _Optional_ | Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See [`navLinks`](#pageinfonavlinks-optional)
|
||||
**`footerText`** | `string` | _Optional_ | Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS
|
||||
**`logo`** | `string` | _Optional_ | The path to an image to display in the header (to the right of the title). This can be either local, where `/` is the root of `./public`, or any remote image, such as `https://i.ibb.co/yhbt6CY/dashy.png`. It's recommended to scale your image down, so that it doesn't impact load times
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `pageInfo.navLinks` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`title`** | `string` | Required | The text to display on the link button
|
||||
**`path`** | `string` | Required | The URL to navigate to when clicked. Can be relative (e.g. `/about`) or absolute (e.g. `https://example.com` or `http://192.168.1.1`)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `appConfig` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`language`** | `string` | _Optional_ | The 2 (or 4-digit) [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language, e.g. `en` or `en-GB`. This must be a language that the app has already been [translated](https://github.com/Lissy93/dashy/tree/master/src/assets/locales) into. If your language is unavailable, Dashy will fallback to English. By default Dashy will attempt to auto-detect your language, although this may not work on some privacy browsers.
|
||||
**`startingView`** | `enum` | _Optional_ | Which page to load by default, and on the base page or domain root. You can still switch to different views from within the UI. Can be either `default`, `minimal` or `workspace`. Defaults to `default`
|
||||
**`defaultOpeningMethod`** | `enum` | _Optional_ | The default opening method for items, if no `target` is specified for a given item. Can be either `newtab`, `sametab`, `top`, `parent`, `modal` or `workspace`. Defaults to `newtab`
|
||||
**`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping each of your services and display their status as a dot next to each item. This can be overridden by setting `statusCheck` under each item. Defaults to `false`
|
||||
**`statusCheckInterval`** | `boolean` | _Optional_ | The number of seconds between checks. If set to `0` then service will only be checked on initial page load, which is usually the desired functionality. If value is less than `10` you may experience a hit in performance. Defaults to `0`
|
||||
**`webSearch`** | `object` | _Optional_ | Configuration options for the web search feature, set your default search engine, opening method or disable web search. See [`webSearch`](#appconfigwebsearch-optional)
|
||||
**`backgroundImg`** | `string` | _Optional_ | Path to an optional full-screen app background image. This can be either remote (http) or local (/). Note that this will slow down initial load
|
||||
**`enableFontAwesome`** | `boolean` | _Optional_ | Where `true` is enabled, if left blank font-awesome will be enabled only if required by 1 or more icons
|
||||
**`fontAwesomeKey`** | `string` | _Optional_ | If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. `13014ae648`)
|
||||
**`faviconApi`** | `enum` | _Optional_ | Only applicable if you are using favicons for item icons. Specifies which service to use to resolve favicons. Set to `local` to do this locally, without using an API. Services running locally will use this option always. Available options are: `local`, `faviconkit`, `google`, `clearbit`, `webmasterapi` and `allesedv`. Defaults to `faviconkit`. See [Icons](/docs/icons.md#favicons) for more info
|
||||
**`auth`** | `object` | _Optional_ | All settings relating to user authentication. See [`auth`](#appconfigauth-optional)
|
||||
**`layout`** | `enum` | _Optional_ | Layout for homepage, either `horizontal`, `vertical` or `auto`. Defaults to `auto`. This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified and overridden from the UI.
|
||||
**`iconSize`** | `enum` | _Optional_ | The size of link items / icons. Can be either `small`, `medium,` or `large`. Defaults to `medium`. This can also be set directly from the UI.
|
||||
**`colCount`** | `number` | _Optional_ | The number of columns of sections displayed on the homepage, using the default view. Should be in integer between `1` and `8`. Note that by default this is applied responsively, based on current screen size, and specifying a value here will override this behavior, which may not be desirable.
|
||||
**`theme`** | `string` | _Optional_ | The default theme for first load (you can change this later from the UI)
|
||||
**`cssThemes`** | `string[]` | _Optional_ | An array of custom theme names which can be used in the theme switcher dropdown
|
||||
**`customColors`** | `object`| _Optional_ | Enables you to apply a custom color palette to any given theme. Use the theme name (lowercase) as the key, for an object including key-value-pairs, with the color variable name as keys, and 6-digit hex code as value. See [Theming](/docs/theming.md#modifying-theme-colors) for more info
|
||||
**`externalStyleSheet`** | `string` or `string[]` | _Optional_ | Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI
|
||||
**`customCss`** | `string` | _Optional_ | Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first.
|
||||
**`hideComponents`** | `object` | _Optional_ | A list of key page components (header, footer, search, settings, etc) that are present by default, but can be removed using this option. See [`appConfig.hideComponents`](#appconfighideComponents-optional)
|
||||
**`routingMode`** | `string` | _Optional_ | Can be either `hash` or `history`. Determines the URL format for sub-pages, hash mode will look like `/#/home` whereas with history mode available you have nice clean URLs, like `/home`. For more info, see the [Vue docs](https://router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations). If you're hosting Dashy with a custom BASE_URL, you will find that a bit of extra server config is necessary to get history mode working, so here you may want to instead use `hash` mode.Defaults to `history`.
|
||||
**`enableMultiTasking`** | `boolean` | _Optional_ | If set to true, will keep apps open in the background when in the workspace view. Useful for quickly switching between multiple sites, and preserving their state, but comes at the cost of performance.
|
||||
**`workspaceLandingUrl`** | `string` | _Optional_ | The URL or an app, service or website to launch when the workspace view is opened, before another service has been launched
|
||||
**`allowConfigEdit`** | `boolean` | _Optional_ | Should prevent / allow the user to write configuration changes to the conf.yml from the UI. When set to `false`, the user can only apply changes locally using the config editor within the app, whereas if set to `true` then changes can be written to disk directly through the UI. Defaults to `true`. Note that if authentication is enabled, the user must be of type `admin` in order to apply changes globally.
|
||||
**`enableErrorReporting`** | `boolean` | _Optional_ | Enable reporting of unexpected errors and crashes. This is off by default, and **no data will ever be captured unless you explicitly enable it**. Turning on error reporting helps previously unknown bugs get discovered and fixed. Dashy uses [Sentry](https://github.com/getsentry/sentry) for error reporting. Defaults to `false`.
|
||||
**`sentryDsn`** | `boolean` | _Optional_ | If you need to monitor errors in your instance, then you can use Sentry to collect and process bug reports. Sentry can be self-hosted, or used as SaaS, once your instance is setup, then all you need to do is pass in the DSN here, and enable error reporting. You can learn more on the [Sentry DSN Docs](https://docs.sentry.io/product/sentry-basics/dsn-explainer/). Note that this will only ever be used if `enableErrorReporting` is explicitly enabled.
|
||||
**`disableSmartSort`** | `boolean` | _Optional_ | For the most-used and last-used app sort functions to work, a basic open-count is stored in local storage. If you do not want this to happen, then disable smart sort here, but you wil no longer be able to use these sort options. Defaults to `false`.
|
||||
**`disableUpdateChecks`** | `boolean` | _Optional_ | If set to true, Dashy will not check for updates. Defaults to `false`.
|
||||
**`enableServiceWorker`** | `boolean` | _Optional_ | Service workers cache web applications to improve load times and offer basic offline functionality, and are enabled by default in Dashy. The service worker can sometimes cause older content to be cached, requiring the app to be hard-refreshed. If you do not want SW functionality, or are having issues with caching, set this property to `true` to disable all service workers.
|
||||
**`disableContextMenu`** | `boolean` | _Optional_ | If set to `true`, the custom right-click context menu will be disabled. Defaults to `false`.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `appConfig.auth` _(optional)_
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`users`** | `array` | _Optional_ | An array of objects containing usernames and hashed passwords. If this is not provided, then authentication will be off by default, and you will not need any credentials to access the app. See [`appConfig.auth.users`](#appconfigauthusers-optional). <br>**Note** this method of authentication is handled on the client side, so for security critical situations, it is recommended to use an [alternate authentication method](/docs/authentication.md#alternative-authentication-methods).
|
||||
**`enableKeycloak`** | `boolean` | _Optional_ | If set to `true`, then authentication using Keycloak will be anabled. Note that you need to have an instance running, and have also configured `auth.keycloak`. Defaults to `false`
|
||||
**`keycloak`** | `object` | _Optional_ | Config options to point Dashy to your Keycloak server. Requires `enableKeycloak: true`. See [`auth.keycloak`](#appconfigauthkeycloak-optional) for more info
|
||||
**`enableGuestAccess`** | `boolean` | _Optional_ | When set to `true`, an unauthenticated user will be able to access the dashboard, with read-only access, without having to login. Requires `auth.users` to be configured. Defaults to `false`.
|
||||
|
||||
For more info, see the **[Authentication Docs](/docs/authentication.md)**
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `appConfig.auth.users` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`user`** | `string` | Required | Username to log in with
|
||||
**`hash`** | `string` | Required | A SHA-256 hashed password
|
||||
**`type`** | `string` | _Optional_ | The user type, either admin or normal
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `appConfig.auth.keycloak` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`serverUrl`** | `string` | Required | The URL (or URL/ IP + Port) where your keycloak server is running
|
||||
**`realm`** | `string` | Required | The name of the realm (must already be created) that you want to use
|
||||
**`clientId`** | `string` | Required | The Client ID of the client you created for use with Dashy
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `appConfig.webSearch` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`disableWebSearch`** | `string` | _Optional_ | Web search is enabled by default, but can be disabled by setting this property to `true`
|
||||
**`searchEngine`** | `string` | _Optional_ | Set the key name for your search engine. Can also use a custom engine by setting this property to `custom`. Currently supported: `duckduckgo`, `google`, `whoogle`, `qwant`, `startpage`, `searx-bar` and `searx-info`. Defaults to `duckduckgo`
|
||||
**`customSearchEngine`** | `string` | _Optional_ | You can also use a custom search engine, or your own self-hosted instance. This requires `searchEngine: custom` to be set. Then add the URL of your service, with GET query string included here
|
||||
**`openingMethod`** | `string` | _Optional_ | Set your preferred opening method for search results: `newtab`, `sametab`, `workspace`. Defaults to `newtab`
|
||||
**`searchBangs`** | `object` | _Optional_ | A key-value-pair set of custom search _bangs_ for redirecting query to a specific app or search engine. The key of each should be the bang you will type (typically starting with `/`, `!` or `:`), and value is the destination, either as a search engine key (e.g. `reddit`) or a URL with search parameters (e.g. `https://en.wikipedia.org/w/?search=`)
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `appConfig.hideComponents` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`hideHeading`** | `boolean` | _Optional_ | If set to `true`, the page title & sub-title will not be visible. Defaults to `false`
|
||||
**`hideNav`** | `boolean` | _Optional_ | If set to `true`, the navigation menu will not be visible. Defaults to `false`
|
||||
**`hideSearch`** | `boolean` | _Optional_ | If set to `true`, the search bar will not be visible. Defaults to `false`
|
||||
**`hideSettings`** | `boolean` | _Optional_ | If set to `true`, the settings menu will not be visible. Defaults to `false`
|
||||
**`hideFooter`** | `boolean` | _Optional_ | If set to `true`, the footer will not be visible. Defaults to `false`
|
||||
**`hideSplashScreen`** | `boolean` | _Optional_ | If set to `true`, splash screen will not be visible while the app loads. Defaults to `true` (except on first load, when the loading screen is always shown)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `section`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`name`** | `string` | Required | The title for the section
|
||||
**`icon`** | `string` | _Optional_ | An single icon to be displayed next to the title. See [`section.icon`](#sectionicon-and-sectionitemicon)
|
||||
**`items`** | `array` | Required | An array of items to be displayed within the section. See [`item`](#sectionitem)
|
||||
**`displayData`** | `object` | _Optional_ | Meta-data to optionally overide display settings for a given section. See [`displayData`](#sectiondisplaydata-optional)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `section.item`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`title`** | `string` | Required | The text to display/ title of a given item. Max length `18`
|
||||
**`description`** | `string` | _Optional_ | Additional info about an item, which is shown in the tooltip on hover, or visible on large tiles
|
||||
**`url`** | `string` | Required | The URL / location of web address for when the item is clicked
|
||||
**`icon`** | `string` | _Optional_ | The icon for a given item. Can be a font-awesome icon, favicon, remote URL or local URL. See [`item.icon`](#sectionicon-and-sectionitemicon)
|
||||
**`target`** | `string` | _Optional_ | The opening method for when the item is clicked, either `newtab`, `sametab`, `top`, `parent`, `modal` or `workspace`. Where `newtab` will open the link in a new tab, `sametab` will open it in the current tab, and `modal` will open a pop-up modal and `workspace` will open in the Workspace view. Defaults to `newtab`
|
||||
**`hotkey`** | `number` | _Optional_ | Give frequently opened applications a numeric hotkey, between `0 - 9`. You can then just press that key to launch that application.
|
||||
**`tags`** | `string[]` | _Optional_ | A list of tags, which can be used for improved search
|
||||
**`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override `appConfig.statusCheck` so you can turn off or on checks for a given service. Defaults to `appConfig.statusCheck`, falls back to `false`
|
||||
**`statusCheckUrl`** | `string` | _Optional_ | If you've enabled `statusCheck`, and want to use a different URL to what is defined under the item, then specify it here
|
||||
**`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here
|
||||
**`statusCheckAllowInsecure`** | `boolean` | _Optional_ | By default, any request to insecure content will be blocked. Setting this option to `true` will disable the `rejectUnauthorized` option, enabling you to ping non-HTTPS services for the current item. Defaults to `false`
|
||||
**`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well
|
||||
**`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background
|
||||
**`provider`** | `string` | _Optional_ | The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `section.displayData` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`sortBy`** | `string` | _Optional_ | The sort order for items within the current section. By default items are displayed in the order in which they are listed in within the config. The following sort options are supported: `most-used` (most opened apps first), `last-used` (the most recently used apps), `alphabetical`, `reverse-alphabetical`, `random` and `default`
|
||||
**`collapsed`** | `boolean` | _Optional_ | If true, the section will be collapsed initially, and will need to be clicked to open. Useful for less regularly used, or very long sections. Defaults to `false`
|
||||
**`rows`** | `number` | _Optional_ | Height of the section, specified as the number of rows it should span vertically, e.g. `2`. Defaults to `1`. Max is `5`.
|
||||
**`cols`** | `number` | _Optional_ | Width of the section, specified as the number of columns the section should span horizontally, e.g. `2`. Defaults to `1`. Max is `5`.
|
||||
**`itemSize`** | `string` | _Optional_ | Specify the size for items within this group, either `small`, `medium` or `large`. Note that this will overide any settings specified through the UI
|
||||
**`color`** | `string` | _Optional_ | A custom accent color for the section, as a hex code or HTML color (e.g. `#fff`)
|
||||
**`customStyles`** | `string` | _Optional_ | Custom CSS properties that should be applied to that section, e.g. `border: 2px dashed #ff0000;`
|
||||
**`sectionLayout`** | `string` | _Optional_ | Specify which CSS layout will be used to responsivley place items. Can be either `auto` (which uses flex layout), or `grid`. If `grid` is selected, then `itemCountX` and `itemCountY` may also be set. Defaults to `auto`
|
||||
**`itemCountX`** | `number` | _Optional_ | The number of items to display per row / horizontally. If not set, it will be calculated automatically based on available space. Can only be set if `sectionLayout` is set to `grid`. Must be a whole number between `1` and `12`
|
||||
**`itemCountY`** | `number` | _Optional_ | The number of items to display per column / vertically. If not set, it will be calculated automatically based on available space. If `itemCountX` is set, then `itemCountY` can be calculated automatically. Can only be set if `sectionLayout` is set to `grid`. Must be a whole number between `1` and `12`
|
||||
**`hideForUsers`** | `string[]` | _Optional_ | Current section will be visible to all users, except for those specified in this list
|
||||
**`showForUsers`** | `string[]` | _Optional_ | Current section will be hidden from all users, except for those specified in this list
|
||||
**`hideForGuests`** | `boolean` | _Optional_ | Current section will be visible for logged in users, but not for guests (see `appConfig.enableGuestAccess`). Defaults to `false`
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
### `section.icon` and `section.item.icon`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`icon`** | `string` | _Optional_ | The icon for a given item or section. See [Icon Docs](/docs/icons.md) for all available supported icon types. To auto-fetch icon from a services URL, aet to `favicon`. To use font-awesome, specify the category, followed by the icon name, e.g. `fas fa-rocket`, `fab fa-monero` or `fal fa-duck`. Similarly, for branded icons, you can use [simple-icons](https://simpleicons.org/) by setting icon to `si-[icon-name]` or [material-design-icons](https://dev.materialdesignicons.com/icons) by setting icon to `mdi-[icon-name]`. If set to `generative`, then a unique icon is generated from the apps URL or IP. You can also use hosted any by specifying it's URL, e.g. `https://i.ibb.co/710B3Yc/space-invader-x256.png`. To use a local image, first store it in `./public/item-icons/` (or `-v /app/public/item-icons/` in Docker) , and reference it by name and extension - e.g. set `image.png` to use `./public/item-icon/image.png`, you can also use sub-folders if you have a lot of icons, to keep them organised.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
### Editing Config through the UI
|
||||
|
||||
Config can be modified directly through the UI, and then written to disk, or applied locally. This can be done wither with the raw config editor (introduced in V 0.6.5 / [#3](https://github.com/Lissy93/dashy/pull/3)), or the interactive editor (introduced in V 1.8.9 / [#298](https://github.com/Lissy93/dashy/pull/298)).
|
||||
|
||||
<p align="center">
|
||||
<a href="https://ibb.co/CzkyMNb">
|
||||
<b>Interactive Editor</b><br>
|
||||
<img alt="Interactive Editor demo" src="https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif" width="600" />
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://ibb.co/zRv542H">
|
||||
<b>Raw Editor</b><br>
|
||||
<img alt="Config Editor demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif" width="600" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
### About YAML
|
||||
If you're new to YAML, it's pretty straight-forward. The format is exactly the same as that of JSON, but instead of using curly braces, structure is denoted using whitespace. This [quick guide](https://linuxhandbook.com/yaml-basics/) should get you up to speed in a few minutes, for more advanced topics take a look at this [Wikipedia article](https://en.wikipedia.org/wiki/YAML).
|
||||
|
||||
### Config Saving Methods
|
||||
When updating the config through the JSON editor in the UI, you have two save options: **Local** or **Write to Disk**.
|
||||
- Changes saved locally will only be applied to the current user through the browser, and will not apply to other instances - you either need to use the cloud sync feature, or manually update the conf.yml file.
|
||||
- On the other-hand, if you choose to write changes to disk, then your main `conf.yml` file will be updated, and changes will be applied to all users, and visible across all devices. For this functionality to work, you must be running Dashy with using the Docker container, or the Node server. A backup of your current configuration will also be saved in the same directory.
|
||||
|
||||
### Preventing Changes being Written to Disk
|
||||
To disallow any changes from being written to disk via the UI config editor, set `appConfig.allowConfigEdit: false`. If you are using users, and have setup `auth` within Dashy, then only users with `type: admin` will be able to write config changes to disk.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
---
|
||||
pageInfo:
|
||||
title: Home Lab
|
||||
sections: # An array of sections
|
||||
- name: Section 1 - Getting Started
|
||||
items: # An array of items
|
||||
- title: GitHub
|
||||
description: Source code and documentation on GitHub
|
||||
icon: fab fa-github
|
||||
url: https://github.com/Lissy93/dashy
|
||||
- title: Issues
|
||||
description: View currently open issues, or raise a new one
|
||||
icon: fas fa-bug
|
||||
url: https://github.com/Lissy93/dashy/issues
|
||||
- title: Demo
|
||||
description: A live demo
|
||||
icon: far fa-rocket
|
||||
url: https://dashy-demo-1.netlify.app
|
||||
- name: Section 2 - Local Services
|
||||
items:
|
||||
- title: Firewall
|
||||
icon: favicon
|
||||
url: http://192.168.1.1/
|
||||
- title: Game Server
|
||||
icon: https://i.ibb.co/710B3Yc/space-invader-x256.png
|
||||
url: http://192.168.130.1/
|
||||
```
|
||||
|
||||
For more example config files, see: [this gist](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
|
||||
|
||||
If you need any help, feel free to [Raise an Issue](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question&template=question.md&title=%5BQUESTION%5D) or [Start a Discussion](https://github.com/Lissy93/dashy/discussions)
|
||||
|
||||
Happy Configuring 🤓🔧
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
# Configuring
|
||||
|
||||
All app configuration is specified in [`/user-data/conf.yml`](https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml) which is in [YAML Format](https://yaml.org/) format. If you're using Docker, this file can be passed in as a volume. Changes can either be made directly to this file, or done [through the UI](#editing-config-through-the-ui). From the UI you can also export, backup, reset, validate and download your configuration file.
|
||||
|
||||
## There are three ways to edit the config
|
||||
|
||||
- **Directly in the YAML file** _(5/5 reliability, 3/5 usability)_
|
||||
- Write changes directly to the conf.yml file, optionally using one of the templates provided. This can be done in your favorite editor and uploading to your server, or directly editing the file via SSH, but the easiest method would be to use [Code Server](https://github.com/coder/code-server)
|
||||
- **UI JSON Editor** _(4/5 reliability, 4/5 usability)_
|
||||
- From the UI, under the config menu there is a JSON editor, with built-in validation, documentation and advanced options
|
||||
- **UI Visual Editor** _(3/5 reliability, 5/5 usability)_
|
||||
- From the UI, enter the Interactive Edit Mode, then click any part of the page to edit. Changes are previewed live, and then saved to disk
|
||||
- **REST API** _(Coming soon)_
|
||||
- Programmatically edit config either through the command line, using a script or a third-party application
|
||||
|
||||
## Tips
|
||||
|
||||
- You may find it helpful to look at some sample config files to get you started, a collection of which can be found [here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
|
||||
- You can check that your config file fits the schema, by running `yarn validate-config`
|
||||
- After modifying your config, the app needs to be recompiled, by running `yarn build` - this happens automatically if you're using Docker
|
||||
- It is recommended to keep a backup of your config file. You can download it under Config menu, or use the [Cloud Backup](./docs/backup-restore.md) feature.
|
||||
- You can make use of YAML features, like anchors, comments, multi-line strings, etc to reuse attributes and keep your config file readable
|
||||
- Once you have finished configuring your dashboard, you can choose to [disable UI config](#preventing-changes) if you wish
|
||||
- All fields are optional, unless otherwise stated.
|
||||
|
||||
The following file provides a reference of all supported configuration options.
|
||||
|
||||
## Contents
|
||||
|
||||
- [**`pageInfo`**](#pageinfo) - Header text, footer, title, navigation, etc
|
||||
- [`navLinks`](#pageinfonavlinks-optional) - Links to display in the navigation bar
|
||||
- [**`pages`**](#pages-optional) - List of additional config files, for multi-page dashboards
|
||||
- [**`appConfig`**](#appconfig-optional) - Main application settings
|
||||
- [`webSearch`](#appconfigwebsearch-optional) - Configure web search engine options
|
||||
- [`hideComponents`](#appconfighidecomponents-optional) - Show/ hide page components
|
||||
- [`auth`](#appconfigauth-optional) - Built-in authentication setup
|
||||
- [`users`](#appconfigauthusers-optional) - List or users (for simple auth)
|
||||
- [`keycloak`](#appconfigauthkeycloak-optional) - Auth config for Keycloak
|
||||
- [`headerAuth`](#appconfigauthheaderauth-optional) - Auth config for HeaderAuth
|
||||
- [**`sections`**](#section) - List of sections
|
||||
- [`displayData`](#sectiondisplaydata-optional) - Section display settings
|
||||
- [`show/hideForKeycloakUsers`](#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers) - Set user controls
|
||||
- [`icon`](#sectionicon-and-sectionitemicon) - Icon for a section
|
||||
- [`items`](#sectionitem) - List of items
|
||||
- [`icon`](#sectionicon-and-sectionitemicon) - Icon for an item
|
||||
- [`displayData`](#itemdisplaydata-optional) - Item display settings
|
||||
- [`show/hideForKeycloakUsers`](#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers) - Set user controls
|
||||
- [`widgets`](#sectionwidget-optional) - List of widgets
|
||||
- [**Notes**](#notes)
|
||||
- [Editing Config through the UI](#editing-config-through-the-ui)
|
||||
- [About YAML](#about-yaml)
|
||||
- [Config Saving Methods](#config-saving-methods)
|
||||
- [Preventing Changes](#preventing-changes)
|
||||
- [Example](#example)
|
||||
|
||||
---
|
||||
|
||||
## Top-Level Fields
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`pageInfo`** | `object` | Required | Basic meta data like title, description, nav bar links, footer text. See [`pageInfo`](#pageinfo)
|
||||
**`appConfig`** | `object` | _Optional_ | Settings related to how the app functions, including API keys and global styles. See [`appConfig`](#appconfig-optional)
|
||||
**`sections`** | `array` | Required | An array of sections, each containing an array of items, which will be displayed as links. See [`section`](#section)
|
||||
**`pages`** | `array` | _Optional_ | An array additional config files, used for multi-page dashboards. See [`pages`](#pages-optional)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `PageInfo`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`title`** | `string` | Required | Your dashboard title, displayed in the header and browser tab
|
||||
**`description`** | `string` | _Optional_ | Description of your dashboard, also displayed as a subtitle
|
||||
**`navLinks`** | `array` | _Optional_ | Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See [`navLinks`](#pageinfonavlinks-optional)
|
||||
**`footerText`** | `string` | _Optional_ | Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS
|
||||
**`logo`** | `string` | _Optional_ | The path to an image to display in the header (to the right of the title). This can be either local, where `/` is the root of `./public`, or any remote image, such as `https://i.ibb.co/yhbt6CY/dashy.png`. It's recommended to scale your image down, so that it doesn't impact load times
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `pageInfo.navLinks` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`title`** | `string` | Required | The text to display on the link button
|
||||
**`path`** | `string` | Required | The URL to navigate to when clicked. Can be relative (e.g. `/about`) or absolute (e.g. `https://example.com` or `http://192.168.1.1`)
|
||||
**`target`** | `string` | _Optional_ | The opening method (external links only). Can be either `newtab`, `sametab`, `top` or `parent`. Defaults to `newtab`
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `pages[]` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`name`** | `string` | Required | A unique name for that page
|
||||
**`path`** | `string` | Required | The path (local or remote) to the config file to use.<br>For files located within `/public`, you only need to specify filename, for externally hosted files you must include the full URL
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`language`** | `string` | _Optional_ | The 2 (or 4-digit) [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language, e.g. `en` or `en-GB`. This must be a language that the app has already been [translated](https://github.com/Lissy93/dashy/tree/master/src/assets/locales) into. If your language is unavailable, Dashy will fallback to English. By default Dashy will attempt to auto-detect your language, although this may not work on some privacy browsers.
|
||||
~~**`startingView`**~~ | `enum` | _Optional_ | Which page to load by default, and on the base page or domain root. You can still switch to different views from within the UI. Can be either `default`, `minimal` or `workspace`. Defaults to `default`. NOTE: This has been replaced by an environmental variable: `VUE_APP_STARTING_VIEW` in V3 onwards
|
||||
**`defaultOpeningMethod`** | `enum` | _Optional_ | The default opening method for items, if no `target` is specified for a given item. Can be either `newtab`, `sametab`, `modal`, `workspace`, `clipboard`, `top` or `parent`. Defaults to `newtab`
|
||||
**`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping each of your services and display their status as a dot next to each item. This can be overridden by setting `statusCheck` under each item. Defaults to `false`
|
||||
**`statusCheckInterval`** | `number` | _Optional_ | The number of seconds between checks. If set to `0` then service will only be checked on initial page load, which is usually the desired functionality. If value is less than `10` you may experience a hit in performance. Defaults to `0`
|
||||
**`webSearch`** | `object` | _Optional_ | Configuration options for the web search feature, set your default search engine, opening method or disable web search. See [`webSearch`](#appconfigwebsearch-optional)
|
||||
**`backgroundImg`** | `string` | _Optional_ | Path to an optional full-screen app background image. This can be either remote (http) or local (relative to /app/public/item-icons/ inside the container). Note that this will slow down initial load
|
||||
**`enableFontAwesome`** | `boolean` | _Optional_ | If set to `true` font-awesome will be loaded, if set to `false` they will not be. if left blank font-awesome will be enabled only if required by 1 or more icons
|
||||
**`enableMaterialDesignIcons`** | `boolean` | _Optional_ | If set to `true` mdi icons will be loaded, if set to `false` they will not be. Where `true` is enabled, if left blank material design icons will be enabled only if required by 1 or more icons
|
||||
**`fontAwesomeKey`** | `string` | _Optional_ | If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. `13014ae648`)
|
||||
**`faviconApi`** | `enum` | _Optional_ | Only applicable if you are using favicons for item icons. Specifies which service to use to resolve favicons. Set to `local` to do this locally, without using an API. Services running locally will use this option always. Available options are: `local`, `faviconkit`, `iconhorse`, `google`, `clearbit`, `webmasterapi` and `allesedv`. Defaults to `faviconkit`. See [Icons](/docs/icons.md#favicons) for more info
|
||||
**`auth`** | `object` | _Optional_ | All settings relating to user authentication. See [`auth`](#appconfigauth-optional)
|
||||
**`defaultIcon`** | `string` | _Optional_ | An icon to be applied to any items, which don't already have an icon set. See [Icon Docs](/docs/icons.md#default-icon) for more info
|
||||
**`layout`** | `enum` | _Optional_ | Layout for homepage, either `horizontal`, `vertical` or `auto`. Defaults to `auto`. This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified and overridden from the UI.
|
||||
**`iconSize`** | `enum` | _Optional_ | The size of link items / icons. Can be either `small`, `medium,` or `large`. Defaults to `medium`. This can also be set directly from the UI.
|
||||
**`colCount`** | `number` | _Optional_ | The number of columns of sections displayed on the homepage, using the default view. Should be in integer between `1` and `8`. Note that by default this is applied responsively, based on current screen size, and specifying a value here will override this behavior, which may not be desirable.
|
||||
**`theme`** | `string` | _Optional_ | The default theme for first load (you can change this later from the UI)
|
||||
**`cssThemes`** | `string[]` | _Optional_ | An array of custom theme names which can be used in the theme switcher dropdown
|
||||
**`customColors`** | `object`| _Optional_ | Enables you to apply a custom color palette to any given theme. Use the theme name (lowercase) as the key, for an object including key-value-pairs, with the color variable name as keys, and 6-digit hex code as value. See [Theming](/docs/theming.md#modifying-theme-colors) for more info
|
||||
**`externalStyleSheet`** | `string` or `string[]` | _Optional_ | Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI
|
||||
**`customCss`** | `string` | _Optional_ | Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first.
|
||||
**`hideComponents`** | `object` | _Optional_ | A list of key page components (header, footer, search, settings, etc) that are present by default, but can be removed using this option. See [`appConfig.hideComponents`](#appconfighideComponents-optional)
|
||||
**`routingMode`** | `string` | _Optional_ | Can be either `hash` or `history`. Determines the URL format for sub-pages, hash mode will look like `/#/home` whereas with history mode available you have nice clean URLs, like `/home`. For more info, see the [Vue docs](https://router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations). If you're hosting Dashy with a custom BASE_URL, you will find that a bit of extra server config is necessary to get history mode working, so here you may want to instead use `hash` mode.Defaults to `history`.
|
||||
**`enableMultiTasking`** | `boolean` | _Optional_ | If set to true, will keep apps open in the background when in the workspace view. Useful for quickly switching between multiple sites, and preserving their state, but comes at the cost of performance.
|
||||
**`workspaceLandingUrl`** | `string` | _Optional_ | The URL or an app, service or website to launch when the workspace view is opened, before another service has been launched
|
||||
**`preventWriteToDisk`** | `boolean` | _Optional_ | If set to `true`, users will be prevented from saving config changes to disk through the UI
|
||||
**`preventLocalSave`** | `boolean` | _Optional_ | If set to `true`, users will be prevented from applying config changes to local storage
|
||||
**`disableConfiguration`** | `boolean` | _Optional_ | If set to true, no users will be able to view or edit the config through the UI
|
||||
**`disableConfigurationForNonAdmin`** | `boolean` | _Optional_ | If set to true, only admin users will be able to view or edit the config through the UI. disableConfiguration must not be set to true.
|
||||
**`widgetsAlwaysUseProxy`** | `boolean` | _Optional_ | If set to `true`, requests made by widgets will always be proxied, same as setting `useProxy: true` on each widget. Note that this may break some widgets.
|
||||
**`showSplashScreen`** | `boolean` | _Optional_ | If set to `true`, a loading screen will be shown. Defaults to `false`.
|
||||
**`enableErrorReporting`** | `boolean` | _Optional_ | Enable reporting of unexpected errors and crashes. This is off by default, and **no data will ever be captured unless you explicitly enable it**. Turning on error reporting helps previously unknown bugs get discovered and fixed. Dashy uses [Sentry](https://github.com/getsentry/sentry) for error reporting. Defaults to `false`.
|
||||
**`sentryDsn`** | `boolean` | _Optional_ | If you need to monitor errors in your instance, then you can use Sentry to collect and process bug reports. Sentry can be self-hosted, or used as SaaS, once your instance is setup, then all you need to do is pass in the DSN here, and enable error reporting. You can learn more on the [Sentry DSN Docs](https://docs.sentry.io/product/sentry-basics/dsn-explainer/). Note that this will only ever be used if `enableErrorReporting` is explicitly enabled.
|
||||
**`disableSmartSort`** | `boolean` | _Optional_ | For the most-used and last-used app sort functions to work, a basic open-count is stored in local storage. If you do not want this to happen, then disable smart sort here, but you wil no longer be able to use these sort options. Defaults to `false`.
|
||||
**`disableUpdateChecks`** | `boolean` | _Optional_ | If set to true, Dashy will not check for updates. Defaults to `false`.
|
||||
**`enableServiceWorker`** | `boolean` | _Optional_ | Service workers cache web applications to improve load times and offer basic offline functionality, and are enabled by default in Dashy. The service worker can sometimes cause older content to be cached, requiring the app to be hard-refreshed. If you do not want SW functionality, or are having issues with caching, set this property to `false` to disable all service workers.
|
||||
**`disableContextMenu`** | `boolean` | _Optional_ | If set to `true`, the custom right-click context menu will be disabled. Defaults to `false`.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig.auth` _(optional)_
|
||||
|
||||
> [!NOTE]
|
||||
> Since the auth is initiated in the main app entry point (for security), a rebuild is required to apply changes to the auth configuration.
|
||||
> You can trigger a rebuild through the UI, under Config --> Rebuild, or by running `yarn build` in the root directory.
|
||||
|
||||
> [!WARNING]
|
||||
> Built-in auth should **not be used** for security-critical applications, or if your Dashy instance is publicly accessible.
|
||||
> For these, it is recommended to use an [alternate authentication method](/docs/authentication.md#alternative-authentication-methods).
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`users`** | `array` | _Optional_ | An array of objects containing usernames and hashed passwords. If this is not provided, then authentication will be off by default, and you will not need any credentials to access the app. See [`appConfig.auth.users`](#appconfigauthusers-optional). <br>**Note** this method of authentication is handled on the client side, so for security critical situations, it is recommended to use an [alternate authentication method](/docs/authentication.md#alternative-authentication-methods).
|
||||
**`enableKeycloak`** | `boolean` | _Optional_ | If set to `true`, then authentication using Keycloak will be enabled. Note that you need to have an instance running, and have also configured `auth.keycloak`. Defaults to `false`
|
||||
**`keycloak`** | `object` | _Optional_ | Config options to point Dashy to your Keycloak server. Requires `enableKeycloak: true`. See [`auth.keycloak`](#appconfigauthkeycloak-optional) for more info
|
||||
**`enableHeaderAuth`** | `boolean` | _Optional_ | If set to `true`, then authentication using HeaderAuth will be enabled. Note that you need to have your web server/reverse proxy running, and have also configured `auth.headerAuth`. Defaults to `false`
|
||||
**`headerAuth`** | `object` | _Optional_ | Config options to point Dashy to your headers for authentication. Requires `enableHeaderAuth: true`. See [`auth.headerAuth`](#appconfigauthheaderauth-optional) for more info
|
||||
**`enableGuestAccess`** | `boolean` | _Optional_ | When set to `true`, an unauthenticated user will be able to access the dashboard, with read-only access, without having to login. Requires `auth.users` to be configured. Defaults to `false`.
|
||||
|
||||
For more info, see the **[Authentication Docs](/docs/authentication.md)**
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig.auth.users` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`user`** | `string` | Required | Username to log in with
|
||||
**`hash`** | `string` | Required | A SHA-256 hashed password
|
||||
**`type`** | `string` | _Optional_ | The user type, either admin or normal
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig.auth.keycloak` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`serverUrl`** | `string` | Required | The URL (or URL/ IP + Port) where your keycloak server is running
|
||||
**`realm`** | `string` | Required | The name of the realm (must already be created) that you want to use
|
||||
**`clientId`** | `string` | Required | The Client ID of the client you created for use with Dashy
|
||||
**`legacySupport`** | `boolean` | _Optional_ | If using Keycloak 17 or older, then set this to `true`
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig.auth.headerAuth` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`userHeader`** | `string` | _Optional_ | The Header name which contains username (default: REMOTE_USER). Case insensitive
|
||||
**`proxyWhitelist`** | `array` | Required | An array of Upstream proxy servers to expect authencticated requests from
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig.webSearch` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`disableWebSearch`** | `string` | _Optional_ | Web search is enabled by default, but can be disabled by setting this property to `true`
|
||||
**`searchEngine`** | `string` | _Optional_ | Set the key name for your search engine. Can also use a custom engine by setting this property to `custom`. Currently supported: `duckduckgo`, `google`, `whoogle`, `qwant`, `startpage`, `searx-bar` and `searx-info`. Defaults to `duckduckgo`
|
||||
**`customSearchEngine`** | `string` | _Optional_ | You can also use a custom search engine, or your own self-hosted instance. This requires `searchEngine: custom` to be set. Then add the URL of your service, with GET query string included here
|
||||
**`openingMethod`** | `string` | _Optional_ | Set your preferred opening method for search results: `newtab`, `sametab`, `workspace`. Defaults to `newtab`
|
||||
**`searchBangs`** | `object` | _Optional_ | A key-value-pair set of custom search _bangs_ for redirecting query to a specific app or search engine. The key of each should be the bang you will type (typically starting with `/`, `!` or `:`), and value is the destination, either as a search engine key (e.g. `reddit`) or a URL with search parameters (e.g. `https://en.wikipedia.org/w/?search=`)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `appConfig.hideComponents` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`hideHeading`** | `boolean` | _Optional_ | If set to `true`, the page title & sub-title will not be visible. Defaults to `false`
|
||||
**`hideNav`** | `boolean` | _Optional_ | If set to `true`, the navigation menu will not be visible. Defaults to `false`
|
||||
**`hideSearch`** | `boolean` | _Optional_ | If set to `true`, the search bar will not be visible. Defaults to `false`
|
||||
**`hideSettings`** | `boolean` | _Optional_ | If set to `true`, the settings menu will be initially collapsed. Defaults to `false`
|
||||
**`hideFooter`** | `boolean` | _Optional_ | If set to `true`, the footer will not be visible. Defaults to `false`
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `section`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`name`** | `string` | Required | The title for the section
|
||||
**`icon`** | `string` | _Optional_ | An single icon to be displayed next to the title. See [`section.icon`](#sectionicon-and-sectionitemicon)
|
||||
**`items`** | `array` | _Optional_ | An array of items to be displayed within the section. See [`item`](#sectionitem). Sections must include either 1 or more items, or 1 or more widgets.
|
||||
**`widgets`** | `array` | _Optional_ | An array of widgets to be displayed within the section. See [`widget`](#sectionwidget-optional)
|
||||
**`displayData`** | `object` | _Optional_ | Meta-data to optionally override display settings for a given section. See [`displayData`](#sectiondisplaydata-optional)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `section.item`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`title`** | `string` | Required | The text to display/ title of a given item. Max length `18`
|
||||
**`description`** | `string` | _Optional_ | Additional info about an item, which is shown in the tooltip on hover, or visible on large tiles
|
||||
**`url`** | `string` | Required | The URL / location of web address for when the item is clicked
|
||||
**`icon`** | `string` | _Optional_ | The icon for a given item. Can be a font-awesome icon, favicon, remote URL or local URL. See [`item.icon`](#sectionicon-and-sectionitemicon)
|
||||
**`target`** | `string` | _Optional_ | The opening method for when the item is clicked, either `newtab`, `sametab`, `modal`, `workspace`, `clipboard`, `top` or `parent`. Where `newtab` will open the link in a new tab, `sametab` will open it in the current tab, and `modal` will open a pop-up modal, `workspace` will open in the Workspace view and `clipboard` will copy the URL to system clipboard (but not launch app). Defaults to `newtab`
|
||||
**`hotkey`** | `number` | _Optional_ | Give frequently opened applications a numeric hotkey, between `0 - 9`. You can then just press that key to launch that application.
|
||||
**`tags`** | `string[]` | _Optional_ | A list of tags, which can be used for improved search
|
||||
**`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override `appConfig.statusCheck` so you can turn off or on checks for a given service. Defaults to `appConfig.statusCheck`, falls back to `false`
|
||||
**`statusCheckUrl`** | `string` | _Optional_ | If you've enabled `statusCheck`, and want to use a different URL to what is defined under the item, then specify it here
|
||||
**`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here
|
||||
**`statusCheckAllowInsecure`** | `boolean` | _Optional_ | By default, any request to insecure content will be blocked. Setting this option to `true` will disable the `rejectUnauthorized` option, enabling you to ping non-HTTPS services for the current item. Defaults to `false`
|
||||
**`statusCheckAcceptCodes`** | `string` | _Optional_ | If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code. E.g. if you expect your server to return 403, but still want the status indicator to be green, set this value to `403`
|
||||
**`statusCheckMaxRedirects`** | `number` | _Optional_ | If your service redirects to another page, and you would like status checks to follow redirects, then specify the maximum number of redirects here. Defaults to `0` / will not follow redirects
|
||||
**`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well
|
||||
**`rel`** | `string` | _Optional_ | The value of the `rel` attribute for the link. Useful for specifying the relationship between the target link/document and Dashy. Defaults to `noopener noreferrer`
|
||||
**`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background
|
||||
**`provider`** | `string` | _Optional_ | The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name
|
||||
**`displayData`** | `object` | _Optional_ | Meta-data to optionally override display settings for a given item. See [`displayData`](#itemdisplaydata-optional)
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `item.displayData` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`hideForUsers`** | `string[]` | _Optional_ | Current item will be visible to all users, except for those specified in this list
|
||||
**`showForUsers`** | `string[]` | _Optional_ | Current item will be hidden from all users, except for those specified in this list
|
||||
**`hideForGuests`** | `boolean` | _Optional_ | Current item will be visible for logged in users, but not for guests (see `appConfig.enableGuestAccess`). Defaults to `false`
|
||||
**`hideForKeycloakUsers`** | `object` | _Optional_ | Current item will be visible to all keycloak users, except for those configured via these groups and roles. See `hideForKeycloakUsers`
|
||||
**`showForKeycloakUsers`** | `object` | _Optional_ | Current item will be hidden from all keycloak users, except for those configured via these groups and roles. See `showForKeycloakUsers`
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `section.widgets` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`type`** | `string` | Required | The widget type. See [Widget Docs](/docs/widgets.md) for full list of supported widgets
|
||||
**`options`** | `object` | _Optional_ | Some widgets accept either optional or required additional options. Again, see the [Widget Docs](/docs/widgets.md) for full list of options
|
||||
**`updateInterval`** | `number` | _Optional_ | You can keep a widget constantly updated by specifying an update interval, in seconds. See [Continuous Updates Docs](/docs/widgets.md#continuous-updates) for more info
|
||||
**`useProxy`** | `boolean` | _Optional_ | Some widgets make API requests to services that are not CORS-enabled. For these instances, you will need to route requests through a proxy, Dashy has a built in CORS-proxy, which you can use by setting this option to `true`. Defaults to `false`. See the [Proxying Requests Docs](/docs/widgets.md#proxying-requests) for more info
|
||||
**`timeout`** | `number` | _Optional_ | Request timeout in milliseconds, defaults to ½ a second (`500`)
|
||||
**`ignoreErrors`** | `boolean` | _Optional_ | Prevent an error message being displayed, if a network request or something else fails. Useful for false-positives
|
||||
**`label`** | `string` | _Optional_ | Add custom label to a given widget. Useful for identification, if there are multiple of the same type of widget in a single section
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `section.displayData` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`sortBy`** | `string` | _Optional_ | The sort order for items within the current section. By default items are displayed in the order in which they are listed in within the config. The following sort options are supported: `most-used` (most opened apps first), `last-used` (the most recently used apps), `alphabetical`, `reverse-alphabetical`, `random` and `default`
|
||||
**`collapsed`** | `boolean` | _Optional_ | If true, the section will be collapsed initially, and will need to be clicked to open. Useful for less regularly used, or very long sections. Defaults to `false`
|
||||
**`cutToHeight`** | `boolean` | _Optional_ | By default, sections will fill available space. Set this option to true to match section height with content height
|
||||
**`rows`** | `number` | _Optional_ | Height of the section, specified as the number of rows it should span vertically, e.g. `2`. Defaults to `1`. Max is `5`.
|
||||
**`cols`** | `number` | _Optional_ | Width of the section, specified as the number of columns the section should span horizontally, e.g. `2`. Defaults to `1`. Max is `5`.
|
||||
**`itemSize`** | `string` | _Optional_ | Specify the size for items within this group, either `small`, `medium` or `large`. Note that this will override any settings specified through the UI
|
||||
**`color`** | `string` | _Optional_ | A custom accent color for the section, as a hex code or HTML color (e.g. `#fff`)
|
||||
**`customStyles`** | `string` | _Optional_ | Custom CSS properties that should be applied to that section, e.g. `border: 2px dashed #ff0000;`
|
||||
**`sectionLayout`** | `string` | _Optional_ | Specify which CSS layout will be used to responsively place items. Can be either `auto` (which uses flex layout), or `grid`. If `grid` is selected, then `itemCountX` and `itemCountY` may also be set. Defaults to `auto`
|
||||
**`itemCountX`** | `number` | _Optional_ | The number of items to display per row / horizontally. If not set, it will be calculated automatically based on available space. Can only be set if `sectionLayout` is set to `grid`. Must be a whole number between `1` and `12`
|
||||
**`itemCountY`** | `number` | _Optional_ | The number of items to display per column / vertically. If not set, it will be calculated automatically based on available space. If `itemCountX` is set, then `itemCountY` can be calculated automatically. Can only be set if `sectionLayout` is set to `grid`. Must be a whole number between `1` and `12`
|
||||
**`hideForUsers`** | `string[]` | _Optional_ | Current section will be visible to all users, except for those specified in this list
|
||||
**`showForUsers`** | `string[]` | _Optional_ | Current section will be hidden from all users, except for those specified in this list
|
||||
**`hideForGuests`** | `boolean` | _Optional_ | Current section will be visible for logged in users, but not for guests (see `appConfig.enableGuestAccess`). Defaults to `false`
|
||||
**`hideForKeycloakUsers`** | `object` | _Optional_ | Current section will be visible to all keycloak users, except for those configured via these groups and roles. See `hideForKeycloakUsers`
|
||||
**`showForKeycloakUsers`** | `object` | _Optional_ | Current section will be hidden from all keycloak users, except for those configured via these groups and roles. See `showForKeycloakUsers`
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `section.icon` and `section.item.icon`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
**`icon`** | `string` | _Optional_ | The icon for a given item or section. <br>See [Icon Docs](/docs/icons.md) for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, and icons specified by URL
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
## `section.displayData.hideForKeycloakUsers`, `section.displayData.showForKeycloakUsers`, `item.displayData.hideForKeycloakUsers` and `item.displayData.showForKeycloakUsers`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- |------------| --- | ---
|
||||
**`groups`** | `string[]` | _Optional_ | Current Section or Item will be hidden or shown based on the user having any of the groups in this list
|
||||
**`roles`** | `string[]` | _Optional_ | Current Section or Item will be hidden or shown based on the user having any of the roles in this list
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
### Editing Config through the UI
|
||||
|
||||
Config can be modified directly through the UI, and then written to disk, or applied locally. This can be done wither with the raw config editor (introduced in V 0.6.5 / [#3](https://github.com/Lissy93/dashy/pull/3)), or the interactive editor (introduced in V 1.8.9 / [#298](https://github.com/Lissy93/dashy/pull/298)).
|
||||
|
||||
<p align="center">
|
||||
<a href="https://ibb.co/CzkyMNb">
|
||||
<b>Interactive Editor</b><br>
|
||||
<img alt="Interactive Editor demo" src="https://user-images.githubusercontent.com/1862727/139543020-b0576d28-0830-476f-afc8-a815d4de6def.gif" width="600" />
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://ibb.co/zRv542H">
|
||||
<b>JSON Editor</b><br>
|
||||
<img alt="Config Editor demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif" width="600" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
### About YAML
|
||||
|
||||
If you're new to YAML, it's pretty straight-forward. The format is exactly the same as that of JSON, but instead of using curly braces, structure is denoted using whitespace. This [quick guide](https://linuxhandbook.com/yaml-basics/) should get you up to speed in a few minutes, for more advanced topics take a look at this [Wikipedia article](https://en.wikipedia.org/wiki/YAML).
|
||||
|
||||
### Config Saving Methods
|
||||
|
||||
When updating the config through the JSON editor in the UI, you have two save options: **Local** or **Write to Disk**.
|
||||
|
||||
- Changes saved locally will only be applied to the current user through the browser, and will not apply to other instances - you either need to use the cloud sync feature, or manually update the conf.yml file.
|
||||
- On the other-hand, if you choose to write changes to disk, then your main `conf.yml` file will be updated, and changes will be applied to all users, and visible across all devices. For this functionality to work, you must be running Dashy with using the Docker container, or the Node server. A backup of your current configuration will also be saved in the same directory.
|
||||
|
||||
### Preventing Changes
|
||||
|
||||
If you have authentication set up, then any user who is not an admin (with `type: admin`) will not be able to write changes to disk.
|
||||
|
||||
You can also prevent changes from any user being written to disk, using `preventWriteToDisk`. Or prevent any changes from being saved locally in browser storage, using `preventLocalSave`.
|
||||
|
||||
To disable all UI config features, set `disableConfiguration`. Alternatively you can disable UI config features for all non Admin users by setting `disableConfigurationForNonAdmin` to true.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
---
|
||||
pageInfo:
|
||||
title: Home Lab
|
||||
sections: # An array of sections
|
||||
- name: Section 1 - Getting Started
|
||||
items: # An array of items
|
||||
- title: GitHub
|
||||
description: Source code and documentation on GitHub
|
||||
icon: fab fa-github
|
||||
url: https://github.com/Lissy93/dashy
|
||||
- title: Issues
|
||||
description: View currently open issues, or raise a new one
|
||||
icon: fas fa-bug
|
||||
url: https://github.com/Lissy93/dashy/issues
|
||||
- title: Demo
|
||||
description: A live demo
|
||||
icon: far fa-rocket
|
||||
url: https://dashy-demo-1.netlify.app
|
||||
- name: Section 2 - Local Services
|
||||
items:
|
||||
- title: Firewall
|
||||
icon: favicon
|
||||
url: http://192.168.1.1/
|
||||
- title: Game Server
|
||||
icon: https://i.ibb.co/710B3Yc/space-invader-x256.png
|
||||
url: http://192.168.130.1/
|
||||
```
|
||||
|
||||
For more example config files, see: [this gist](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
|
||||
|
||||
If you need any help, feel free to [Raise an Issue](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question&template=question.md&title=%5BQUESTION%5D) or [Start a Discussion](https://github.com/Lissy93/dashy/discussions)
|
||||
|
||||
Happy Configuring 🤓🔧
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
|
|
@ -1,120 +1,137 @@
|
|||
# Contributing
|
||||
|
||||
First off, thank you for considering contributing towards Dashy! 🙌
|
||||
There are several ways that you can help out (but don't feel you have to).
|
||||
Any contributions, however small will always be very much appreciated, and you will be appropriately credited in the readme - huge thank you to [everyone who has helped](/docs/credits.md) so far 💞
|
||||
|
||||
## Submit a PR
|
||||
Contributing to the code or documentation is super helpful. You can fix a bug, add a new feature or improve an existing one. I've written [several guides](https://github.com/Lissy93/dashy/blob/master/docs/development-guides.md) to help you get started. For setting up the development environment, outline of the standards, and understanding the PR flow, see the [Development Docs](https://github.com/Lissy93/dashy/blob/master/docs/development.md). I've tried to keep the code neat and documentation thorough, so understanding what everything does should be fairly straight forward, but feel free to ask if you have any questions.
|
||||
|
||||
## Add Translations
|
||||
If you speak another language, then adding translations would be really helpful, and you will be credited in the readme for your work. Multi-language support makes Dashy accessible for non-English speakers, which I feel is important. This is a very quick and easy task, as all application text is located in [`locales/en.json`](https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json), so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the [Multi-Language Support Docs](https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md).
|
||||
|
||||
## Take a 2-minute survey
|
||||
Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)
|
||||
|
||||
[![Take the Survey](https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy)](https://survey.typeform.com/to/gl0L68ou)
|
||||
|
||||
## Share your dashboard
|
||||
Dashy now has a [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-) where you can show off a screenshot of your dashboard, and get inspiration from other users. I also really enjoy seeing how people are using Dashy. To [submit your dashboard](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard), please either open a PR or raise an issue.
|
||||
|
||||
## Improve the Docs
|
||||
Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.
|
||||
All content is located either in the [`./README.md`](/README.md) or [`/docs/`](/docs) directory, and synced to the Wiki and website using a GH [action](/actions/workflows/wiki-sync.yml).
|
||||
|
||||
## Raise a bug
|
||||
If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary.
|
||||
|
||||
[![Raise a Bug](https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot)](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E)
|
||||
|
||||
## Join the discussion
|
||||
I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users.
|
||||
|
||||
[![Join the Discussion on GitHub](https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat)](https://github.com/Lissy93/dashy/discussions)
|
||||
|
||||
## Spread the word
|
||||
Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing on social platforms.
|
||||
|
||||
[![Share Dashy on Mastodon](https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=for-the-badge&logo=mastodon)](https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social)
|
||||
[![Share Dashy on Reddit](https://img.shields.io/badge/Share-Reddit-%23FF5700?style=for-the-badge&logo=reddit)](http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy on Twitter](https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=for-the-badge&logo=twitter)](https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy on Facebook](https://img.shields.io/badge/Share-Facebook-%234267B2?style=for-the-badge&logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy)
|
||||
[![Share Dashy on LinkedIn](https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy)
|
||||
[![Share Dashy on Pinterest](https://img.shields.io/badge/Share-Pinterest-%23E60023?style=for-the-badge&logo=pinterest)](https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy on VK](https://img.shields.io/badge/Share-VK-%234C75A3?style=for-the-badge&logo=vk)](https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy via Viber](https://img.shields.io/badge/Share-Viber-%238176d6?style=for-the-badge&logo=viber)](viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy via Telegram](https://img.shields.io/badge/Share-Telegram-%230088cc?style=for-the-badge&logo=telegram)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy via Email](https://img.shields.io/badge/Share-Email-%238A90C7?style=for-the-badge&logo=protonmail)](mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy)
|
||||
|
||||
## Star, Upvote or Leave a Review
|
||||
Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users find it.
|
||||
|
||||
[![ProductHunt](https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=for-the-badge&logo=producthunt)](https://www.producthunt.com/posts/dashy)
|
||||
[![AlternativeTo](https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=for-the-badge&logo=abletonlive)](https://alternativeto.net/software/dashy/about/)
|
||||
[![Slant](https://img.shields.io/badge/Review-Slant-%2346a1df?style=for-the-badge&logo=capacitor)](https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy)
|
||||
[![Star on GitHub](https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=for-the-badge)](https://github.com/Lissy93/dashy/stargazers)
|
||||
[![Star on DockerHub](https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=for-the-badge)](https://hub.docker.com/r/lissy93/dashy)
|
||||
|
||||
## Make a small donation
|
||||
Please only do this is you can definitely afford to. Don't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever.
|
||||
|
||||
[![Sponsor Lissy93 on GitHub](./assets/sponsor-button.svg)](https://github.com/sponsors/Lissy93)
|
||||
|
||||
Sponsoring will give you several perks, from $1 / £0.70 per month, as well as a sponsor badge on your profile, you can also be credited on the readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see [@Lissy93's Sponsor Page](https://github.com/sponsors/Lissy93).
|
||||
|
||||
<details>
|
||||
<summary>You can also send a one-off small contribution using crypto</summary>
|
||||
<p>
|
||||
|
||||
[![Donate with BTC](https://en.cryptobadges.io/badge/big/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC)](https://en.cryptobadges.io/donate/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC)[![Donate with Ethereum](https://en.cryptobadges.io/badge/big/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017)](https://en.cryptobadges.io/donate/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017)
|
||||
|
||||
- **BTC**: `3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC`
|
||||
- **ETH**: `0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017` / `aliciasykes.eth`
|
||||
- **XMR**: `471KZdxb6N63aABR4WYwMRjTVkc1p1x7wGsUTEF7AMYzL8L94A5pCuYWkosgJQ5Ze8Y2PscVCGZFJa3hDPg6MaDq47GUm8r`
|
||||
- **LTC**: `MAuck6Ea1qaNihwKfXutkR1R6BorMth86H`
|
||||
- **ZEC**: `t1bw1SefijsXRDQVxC9w64XsRK8hBhtQohQ`
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
## Request a feature via BountySource
|
||||
BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone.
|
||||
|
||||
[![Request a Feature on BountySource](https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty)](https://www.bountysource.com/teams/dashy)
|
||||
|
||||
## Enable Anonymous Bug Reports
|
||||
[Sentry](https://github.com/getsentry/sentry) is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it). It helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy.
|
||||
|
||||
To enable error reporting:
|
||||
```yaml
|
||||
appConfig:
|
||||
enableErrorReporting: true
|
||||
```
|
||||
|
||||
All reporting is **disabled** by default, and no data will ever be sent to any external endpoint without your explicit consent. In fact, the error tracking package will not even be imported unless you have actively enabled it. All statistics are anonomized and stored securely. For more about privacy and security, see the [Sentry Docs](https://sentry.io/security/).
|
||||
|
||||
## Follow for More
|
||||
If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on.
|
||||
|
||||
[![Alicia Sykes on Twitter](https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter)](https://twitter.com/Lissy_Sykes)
|
||||
[![Alicia Sykes on GitHub](https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social)](https://github.com/Lissy93)
|
||||
[![Alicia Sykes on Mastodon](https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social)](https://mastodon.social/web/accounts/1032965)
|
||||
[![Alicia Sykes on Keybase](https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase)](https://keybase.io/aliciasykes)
|
||||
[![Alicia Sykes's PGP](https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt)](https://keybase.io/aliciasykes/pgp_keys.asc)
|
||||
[![Alicia Sykes's Website](https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ)](https://aliciasykes.com)
|
||||
[![Alicia Sykes's Blog](https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog)](https://notes.aliciasykes.com/)
|
||||
|
||||
If you like, you could also consider [subscribing to my mailing list](https://notes.aliciasykes.com/subscribe) for very occasional blog post updates.
|
||||
|
||||
---
|
||||
|
||||
### Contributors
|
||||
|
||||
For a full list of Dashy's contributors, see the [Credits Page](/docs/credits.md)
|
||||
|
||||
[![Auto-generated contributors](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg)](/docs/credits.md)
|
||||
|
||||
### Star-Gazers Over Time
|
||||
|
||||
[![Stargazers](https://starchart.cc/Lissy93/dashy.svg)](https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy)
|
||||
|
||||
# Contributing
|
||||
|
||||
First off, thank you for considering contributing towards Dashy! 🙌
|
||||
There are several ways that you can help out, and any contributions, however small will always be very much appreciated.
|
||||
You will be appropriately credited in the readme - huge thank you to [everyone who has helped](/docs/credits.md) so far 💞
|
||||
|
||||
## Take a 2-minute survey
|
||||
|
||||
Help improve Dashy by taking a very short, 6-question survey. This will give me a better understanding of what is important to you, so that I can make Dashy better in the future :)
|
||||
|
||||
[![Take the Survey](https://img.shields.io/badge/Take_the-Survey-%231a86fd?style=for-the-badge&logo=buddy)](https://survey.typeform.com/to/gl0L68ou)
|
||||
|
||||
## Share your dashboard
|
||||
|
||||
Dashy now has a [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#dashy-showcase-) where you can show off a screenshot of your dashboard, and get inspiration from other users (and I really love seeing how people are using Dashy). To [submit your dashboard](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard), either open a PR or raise an issue.
|
||||
|
||||
[![Add your Dashboard to the Showcase](https://img.shields.io/badge/Add_your_Dashboard-Showcase-%238616ee?style=for-the-badge&logo=feathub&logoColor=8616ee)](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%92%AF+Showcase&template=showcase-addition.yml&title=%5BSHOWCASE%5D+%3Ctitle%3E)
|
||||
|
||||
## Make a small donation
|
||||
|
||||
Donations help to cover server costs, development time and caffeine ;)
|
||||
Don't feel any pressure to donate anything, as Dashy and my other projects will always be 100% free, for everyone, for ever.
|
||||
|
||||
[![Sponsor Lissy93 on GitHub](https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda)](https://github.com/sponsors/Lissy93)
|
||||
|
||||
Sponsoring will give you several perks - for $1 / £0.75 per month, you'll get a sponsor badge on your profile, be credited on the Dashy's readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see [@Lissy93's Sponsor Page](https://github.com/sponsors/Lissy93).
|
||||
|
||||
<details>
|
||||
<summary>You can also send a one-off small contribution using crypto</summary>
|
||||
<p>
|
||||
|
||||
[![Donate with BTC](https://en.cryptobadges.io/badge/big/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC)](https://en.cryptobadges.io/donate/3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC)[![Donate with Ethereum](https://en.cryptobadges.io/badge/big/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017)](https://en.cryptobadges.io/donate/0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017)
|
||||
|
||||
- **BTC**: `3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC`
|
||||
- **ETH**: `0x0fc98cBf8bea932B4470C46C0FbE1ed1f6765017` / `aliciasykes.eth`
|
||||
- **XMR**: `471KZdxb6N63aABR4WYwMRjTVkc1p1x7wGsUTEF7AMYzL8L94A5pCuYWkosgJQ5Ze8Y2PscVCGZFJa3hDPg6MaDq47GUm8r`
|
||||
- **LTC**: `MAuck6Ea1qaNihwKfXutkR1R6BorMth86H`
|
||||
- **ZEC**: `t1bw1SefijsXRDQVxC9w64XsRK8hBhtQohQ`
|
||||
|
||||
</p>
|
||||
|
||||
</details>
|
||||
|
||||
## Enable Anonymous Bug Reports
|
||||
|
||||
Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. [Sentry](https://github.com/getsentry/sentry) is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it).
|
||||
|
||||
To enable error reporting:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
enableErrorReporting: true
|
||||
```
|
||||
|
||||
All reporting is **disabled** by default, and no data will ever be sent to any external endpoint without your explicit consent. All statistics are anonymized and stored securely. For more about privacy and security, see the [Sentry Security Docs](https://sentry.io/security/).
|
||||
|
||||
## Add Translations
|
||||
|
||||
If you speak another language, then adding translations will help make Dashy available to non-native English speakers. This is a very quick and easy task, as all application text is located in [`locales/en.json`](https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json), so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the [Multi-Language Support Docs](https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md).
|
||||
|
||||
## Submit a PR
|
||||
|
||||
Contributing to the code or docs is super helpful. You can fix a bug, add a new feature or improve an existing one. If you've built your own custom widget, theme or view, consider sharing it in a PR. I've written [several guides](/docs/development-guides.md) to help you get started, and the steps for setting up the development environment are outlined in the [Development Docs](/docs/developing.md). Feel free to ask if you have any questions.
|
||||
|
||||
## Improve the Docs
|
||||
|
||||
Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.
|
||||
All content is located either in the [`./README.md`](/README.md) or [`/docs/`](/docs) directory, and synced to the Wiki and website using a GH [action](/actions/workflows/wiki-sync.yml).
|
||||
|
||||
## Raise a bug
|
||||
|
||||
If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary.
|
||||
|
||||
[![Raise a Bug](https://img.shields.io/badge/Raise_a-Bug-%23dc2d76?style=for-the-badge&logo=dependabot)](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E)
|
||||
|
||||
## Join the discussion
|
||||
|
||||
I've enabled the discussion feature on GitHub, here you can share tips and tricks, useful information, or your dashboard. You can also ask questions, and offer basic support to other users.
|
||||
|
||||
[![Join the Discussion on GitHub](https://img.shields.io/badge/Join_the-Discussion-%23ffd000?style=for-the-badge&logo=livechat)](https://github.com/Lissy93/dashy/discussions)
|
||||
|
||||
## Request a feature via BountySource
|
||||
|
||||
BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone.
|
||||
|
||||
[![Request a Feature on BountySource](https://img.shields.io/badge/BountySource-Dashy-%23F67909?style=for-the-badge&logo=openbugbounty)](https://www.bountysource.com/teams/dashy)
|
||||
|
||||
## Spread the word
|
||||
|
||||
Dashy is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms.
|
||||
|
||||
[![Share Dashy on Mastodon](https://img.shields.io/badge/Share-Mastodon-%232b90d9?style=flat-square&logo=mastodon)](https://mastodon.social/?text=Check%20out%20Dashy%2C%20the%20privacy-friendly%2C%20self-hosted%20startpage%20for%20organizing%20your%20life%3A%20https%3A%2F%2Fgithub.com%2FLissy93%2Fdashy%20-%20By%20%40lissy93%40mastodon.social)
|
||||
[![Share Dashy on Reddit](https://img.shields.io/badge/Share-Reddit-%23FF5700?style=flat-square&logo=reddit)](http://www.reddit.com/submit?url=https://github.com/Lissy93/dashy&title=Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy on Twitter](https://img.shields.io/badge/Share-Twitter-%231DA1F2?style=flat-square&logo=twitter)](https://twitter.com/intent/tweet?url=https://github.com/lissy93/dashy&text=Check%20out%20Dashy%20by%20@Lissy_Sykes,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy on Facebook](https://img.shields.io/badge/Share-Facebook-%234267B2?style=flat-square&logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/lissy93/dashy)
|
||||
[![Share Dashy on LinkedIn](https://img.shields.io/badge/Share-LinkedIn-%230077b5?style=flat-square&logo=linkedin)](https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/lissy93/dashy)
|
||||
[![Share Dashy on Pinterest](https://img.shields.io/badge/Share-Pinterest-%23E60023?style=flat-square&logo=pinterest)](https://pinterest.com/pin/create/button/?url=https://github.com/lissy93/dashy&media=https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png&description=Check%20out%20Dashy,%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy on VK](https://img.shields.io/badge/Share-VK-%234C75A3?style=flat-square&logo=vk)](https://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%2F&title=Check%20out%20Dashy%20-%20The%20Self-Hosted%20Dashboard%20for%20your%20Homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy via Viber](https://img.shields.io/badge/Share-Viber-%238176d6?style=flat-square&logo=viber)](viber://forward?text=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy%0ACheck%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy via Telegram](https://img.shields.io/badge/Share-Telegram-%230088cc?style=flat-square&logo=telegram)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
|
||||
[![Share Dashy via Email](https://img.shields.io/badge/Share-Email-%238A90C7?style=flat-square&logo=protonmail)](mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy)
|
||||
|
||||
## Star, Upvote or Leave a Review
|
||||
|
||||
Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users discover Dashy
|
||||
|
||||
[![ProductHunt](https://img.shields.io/badge/Review-ProductHunt-%23b74424?style=flat-square&logo=producthunt)](https://www.producthunt.com/posts/dashy)
|
||||
[![AlternativeTo](https://img.shields.io/badge/Review-AlternativeTo-%235581a6?style=flat-square&logo=abletonlive)](https://alternativeto.net/software/dashy/about/)
|
||||
[![Slant](https://img.shields.io/badge/Review-Slant-%2346a1df?style=flat-square&logo=capacitor)](https://www.slant.co/improve/topics/27783/viewpoints/1/~self-hosted-homelab-startpage~dashy)
|
||||
[![Star on GitHub](https://img.shields.io/github/stars/Lissy93/Dashy?color=ba96d6&label=Star%20-%20GitHub&logo=github&style=flat-square)](https://github.com/Lissy93/dashy/stargazers)
|
||||
[![Star on DockerHub](https://img.shields.io/docker/stars/lissy93/dashy?color=4cb6e0&label=Star%20-%20Docker&logo=docker&style=flat-square)](https://hub.docker.com/r/lissy93/dashy)
|
||||
|
||||
## Follow for More
|
||||
|
||||
If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on.
|
||||
|
||||
[![Alicia Sykes on Twitter](https://img.shields.io/twitter/follow/Lissy_Sykes?style=social&logo=twitter)](https://twitter.com/Lissy_Sykes)
|
||||
[![Alicia Sykes on GitHub](https://img.shields.io/github/followers/lissy93?label=Lissy93&style=social)](https://github.com/Lissy93)
|
||||
[![Alicia Sykes on Mastodon](https://img.shields.io/mastodon/follow/1032965?domain=https%3A%2F%2Fmastodon.social)](https://mastodon.social/web/accounts/1032965)
|
||||
[![Alicia Sykes on Keybase](https://img.shields.io/badge/aliciasykes--lightgrey?style=social&logo=Keybase)](https://keybase.io/aliciasykes)
|
||||
[![Alicia Sykes's Website](https://img.shields.io/badge/aliciasykes.com--lightgrey?style=social&logo=Tencent%20QQ)](https://aliciasykes.com)
|
||||
[![Alicia Sykes's Blog](https://img.shields.io/badge/Blog--lightgrey?style=social&logo=micro.blog)](https://notes.aliciasykes.com/)
|
||||
[![Alicia Sykes's PGP](https://img.shields.io/badge/PGP--lightgrey?style=social&logo=Let%E2%80%99s%20Encrypt)](https://keybase.io/aliciasykes/pgp_keys.asc)
|
||||
|
||||
If you like, you could also consider [subscribing to my mailing list](https://notes.aliciasykes.com/subscribe) for occasional blog post updates.
|
||||
|
||||
---
|
||||
|
||||
### Contributors
|
||||
|
||||
For a full list of Dashy's contributors, see the [Credits Page](/docs/credits.md)
|
||||
|
||||
[![Auto-generated contributors](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/CONTRIBUTORS.svg)](https://github.com/Lissy93/dashy/blob/master/docs/credits.md)
|
||||
|
||||
### Star-Gazers Over Time
|
||||
|
||||
[![Stargazers](https://starchart.cc/Lissy93/dashy.svg)](https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy)
|
||||
|
|
1080
docs/credits.md
|
@ -1,270 +1,380 @@
|
|||
# Deployment
|
||||
|
||||
Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are several methods available depending on what type of system you're using. If you're self-hosting, then deploying with Docker (or similar container engine) is the recommended approach.
|
||||
|
||||
#### Quick Start
|
||||
If you want to skip the fuss, and [get straight down to it](/docs/quick-start.md), then you can spin up a new instance of Dashy by running:
|
||||
```
|
||||
docker run -p 8080:80 lissy93/dashy
|
||||
```
|
||||
|
||||
See [Management Docs](/docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc
|
||||
|
||||
Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the [configuring docs](/docs/configuring.md).
|
||||
|
||||
## Deployment Methods
|
||||
|
||||
- [Deploy with Docker](#deploy-with-docker)
|
||||
- [Using Docker Compose](#using-docker-compose)
|
||||
- [Build from Source](#build-from-source)
|
||||
- [Hosting with CDN](#hosting-with-cdn)
|
||||
- [Run as executable](#run-as-executable)
|
||||
- [Install with NPM](#install-with-npm)
|
||||
- [Deploy to cloud service](#deploy-to-cloud-service)
|
||||
- [Use managed instance](#use-managed-instance)
|
||||
|
||||
### Deploy with Docker
|
||||
|
||||
**Container Info**: [
|
||||
![Docker Supported Architecture](https://img.shields.io/badge/Architectures-amd64%20|%20arm32v7%20|%20arm64v8-6ba6e5)
|
||||
![Docker Base Image](https://img.shields.io/badge/Base_Image-Alpine_3.14-6ba6e5)
|
||||
![Docker Hosted on](https://img.shields.io/badge/Hosted_on-DockerHub-6ba6e5)
|
||||
](https://hub.docker.com/r/lissy93/dashy)<br>
|
||||
**Status**: [
|
||||
![Docker Build Status](https://img.shields.io/docker/cloud/build/lissy93/dashy?label=Docker%20Build)
|
||||
![Docker Pulls](https://img.shields.io/docker/pulls/lissy93/dashy?color=ecb2f7)
|
||||
![Docker Stars](https://img.shields.io/docker/stars/lissy93/dashy?color=f7f754&label=Docker%20Stars)
|
||||
![Docker Image Size](https://img.shields.io/docker/image-size/lissy93/dashy/latest?color=1eea76)
|
||||
![Docker Cloud Build](https://img.shields.io/docker/cloud/automated/lissy93/dashy?color=f4a966&label=Docker%20Build)
|
||||
](https://hub.docker.com/r/lissy93/dashy)
|
||||
|
||||
Dashy has a built container image hosted on [Docker Hub](https://hub.docker.com/r/lissy93/dashy). You will need [Docker](https://docs.docker.com/get-docker/) installed on your system.
|
||||
|
||||
|
||||
```docker
|
||||
docker run -d \
|
||||
-p 8080:80 \
|
||||
-v /root/my-local-conf.yml:/app/public/conf.yml \
|
||||
--name my-dashboard \
|
||||
--restart=always \
|
||||
lissy93/dashy:latest
|
||||
```
|
||||
|
||||
Explanation of the above options:
|
||||
- `-d` Detached mode (not running in the foreground of your terminal)
|
||||
- `-p` The port that should be exposed, and the port it should be mapped to in your host system `[host-port][container-port]`, leave the container port as is
|
||||
- `-v` Specify volumes, to pass data from your host system to the container, in the format of `[host-path]:[container-path]`, you can use this to pass your config file, directory of assets (like icons), custom CSS or web assets (like favicon.ico, manifest.json etc)
|
||||
- `--name` Give your container a human-readable name
|
||||
- `--restart=always` Spin up the container when the daemon starts, or after it has been stopped
|
||||
- `lissy93/dashy:latest` This last option is the image the container should be built from, you can also use a specific version or architecture type, by replacing `:latest` with one of the [tags](https://hub.docker.com/r/lissy93/dashy/tags)
|
||||
|
||||
For all available options, and to learn more, see the [Docker Run Docs](https://docs.docker.com/engine/reference/commandline/run/)
|
||||
|
||||
Dashy is also available through GHCR: `docker pull ghcr.io/lissy93/dashy:latest`
|
||||
|
||||
If you're deploying Dashy on a modern ARM-based board, such as a Raspberry Pi (2+), then you'll need to use one of Dashy's ARM images. Set the base image + tag to either `lissy93/dashy:arm64v8` or `lissy93/dashy:arm32v7`, depending on your system architecture. You can also use the `multi-arch` image, which should work on all system architectures.
|
||||
|
||||
The image defaults to `:latest`, but you can instead specify a specific version, e.g. `docker pull lissy93/dashy:release-1.5.0`
|
||||
|
||||
### Using Docker Compose
|
||||
|
||||
Using Docker Compose can be useful for saving your specific config in files, without having to type out a long run command each time. Save compose config as a YAML file, and then run `docker compose up -d` (optionally use the `-f` flag to specify file location, if it isn't located at `./docker-compose.yml`), `-d` is detached mode (not running in the foreground of your terminal). Compose is also useful if you are using clusters, as the format is very similar to stack files, used with Docker Swarm.
|
||||
|
||||
The following is a complete example of a [`docker-compose.yml`](https://github.com/Lissy93/dashy/blob/master/docker-compose.yml) for Dashy. Run it as is, or uncomment the additional options you need.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "3.8"
|
||||
services:
|
||||
dashy:
|
||||
# To build from source, replace 'image: lissy93/dashy' with 'build: .'
|
||||
# build: .
|
||||
image: lissy93/dashy
|
||||
container_name: Dashy
|
||||
# Pass in your config file below, by specifying the path on your host machine
|
||||
# volumes:
|
||||
# - /root/my-config.yml:/app/public/conf.yml
|
||||
ports:
|
||||
- 4000:80
|
||||
# Set any environmental variables
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
# Specify your user ID and group ID. You can find this by running `id -u` and `id -g`
|
||||
# - UID=1000
|
||||
# - GID=1000
|
||||
# Specify restart policy
|
||||
restart: unless-stopped
|
||||
# Configure healthchecks
|
||||
healthcheck:
|
||||
test: ['CMD', 'node', '/app/services/healthcheck']
|
||||
interval: 1m30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 40s
|
||||
```
|
||||
You can use a different tag, by for example setting `image: lissy93/dashy:arm64v8`, or pull from GHCR instead by setting `image: ghcr.io/lissy93/dashy`.
|
||||
|
||||
If you are building from source, and would like to use one of the [other Dockerfiles](https://github.com/Lissy93/dashy/tree/master/docker), then under `services.dashy` first set `context: .`, then specify the the path to the dockerfile, e.g. `dockerfile: ./docker/Dockerfile-arm32v7`
|
||||
|
||||
### Build from Source
|
||||
|
||||
If you do not want to use Docker, you can run Dashy directly on your host system. For this, you will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed, and optionally [yarn](https://yarnpkg.com/)
|
||||
|
||||
1. Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
|
||||
2. Configuration: Fill in you're settings in `./public/conf.yml`
|
||||
3. Install dependencies: `yarn`
|
||||
4. Build: `yarn build`
|
||||
5. Run: `yarn start`
|
||||
|
||||
### Deploy to cloud service
|
||||
|
||||
If you don't have a home server, then fear not - Dashy can be deployed to pretty much any cloud provider. The above Docker and NPM guides will work exactly the same on a VPS, but I've also setup some 1-Click deploy links for 10+ of the most common cloud providers, to make things easier. Note that if your instance is exposed to the internet, it will be your responsibility to adequately secure it.
|
||||
|
||||
Some hosting providers required a bit of extra configuration, which was why I've made separate branches for deploying to those services (named: [`deploy_cloudflare`](https://github.com/Lissy93/dashy/tree/deploy_cloudflare), [`deploy_digital-ocean`](https://github.com/Lissy93/dashy/tree/deploy_digital-ocean), [`deploy_platform-sh`](https://github.com/Lissy93/dashy/tree/deploy_platform-sh) and [`deploy_render`](https://github.com/Lissy93/dashy/tree/deploy_render)). If there's another cloud service which you'd like 1-click deployment to be supported for, feel free to raise an issue.
|
||||
|
||||
**Note** If you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be availible. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though.
|
||||
|
||||
#### Netlify
|
||||
[![Deploy to Netlify](https://i.ibb.co/GtKMysT/deploy-netlify-button.png)](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
|
||||
|
||||
[Netlify](https://www.netlify.com/) offers Git-based serverless cloud hosting for web applications. Their services are free to use for personal use, and they support deployment from both public and private repos, as well as direct file upload. The free plan also allows you to use your own custom domain or sub-domain, and is easy to setup.
|
||||
|
||||
To deploy Dashy to Netlify, use the following link
|
||||
```
|
||||
https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy
|
||||
```
|
||||
|
||||
#### Heroku
|
||||
[![Deploy to Heroku](https://i.ibb.co/GdMFzBP/deploy-heroku-button.png)](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
|
||||
|
||||
[Heroku](https://www.heroku.com/) is a fully managed cloud platform as a service. You define app settings in a Procfile and app.json, which specifying how the app should be build and how the server should be started. Heroku is free to use for unlimited, non-commercial, single dyno apps, and supports custom domains. Heroku's single-dyno service is not as quite performant as some other providers, and the app will have a short wake-up time when not visited for a while
|
||||
|
||||
To deploy Dashy to Heroku, use the following link
|
||||
```
|
||||
https://heroku.com/deploy?template=https://github.com/Lissy93/dashy
|
||||
```
|
||||
|
||||
#### Cloudflare Workers
|
||||
[![Deploy to Cloudflare Workers](https://i.ibb.co/jf9xVdm/deploy-cloudflare-button.png)](https://deploy.workers.cloudflare.com/?url=https://github.com/lissy93/dashy/tree/deploy_cloudflare)
|
||||
|
||||
[Cloudflare Workers](https://workers.cloudflare.com/) is a simple yet powerful service for running cloud functions and hosting web content. It requires a Cloudflare account, but is completely free for smaller projects, and very reasonably priced ($0.15/million requests per month) for large applications. You can use your own domain, and applications are protected with Cloudflare's state of the art DDoS protection. For more info, see the docs on [Worker Sites](https://developers.cloudflare.com/workers/platform/sites)
|
||||
|
||||
To deploy Dashy to Cloudflare, use the following link
|
||||
```
|
||||
https://deploy.workers.cloudflare.com/?url=https://github.com/lissy93/dashy/tree/deploy_cloudflare
|
||||
```
|
||||
|
||||
#### Vercel
|
||||
[![Deploy with Vercel](https://i.ibb.co/mJF3R7m/deploy-vercel-button.png)](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
|
||||
|
||||
[Vercel](https://vercel.com/) is a performance-focused platform for hosting static frontend apps. It comes bundled with some useful tools for monitoring and anaylzing application performance and other metrics. Vercel is free for personal use, allows for custom domains and has very reasonable limits.
|
||||
|
||||
To deploy Dashy to Vercel, use the following link
|
||||
```
|
||||
https://vercel.com/new/project?template=https://github.com/lissy93/dashy
|
||||
```
|
||||
|
||||
#### DigitalOcean
|
||||
[![Deploy to DO](https://i.ibb.co/PFt0PkB/deploy-digital-ocean-button.png)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean&refcode=3838338e7f79)
|
||||
|
||||
[DigitalOcan](https://www.digitalocean.com/) is a cloud service providing affordable developer-friendly virtual machines from $5/month. But they also have an app platform, where you can run web apps, static sites, APIs and background workers. CDN-backed static sites are free for personal use.
|
||||
|
||||
```
|
||||
https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean
|
||||
```
|
||||
|
||||
#### Google Cloud Platform
|
||||
[![Run on Google Cloud](https://i.ibb.co/LkvHttd/deploy-google-cloud-button.png)](https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git)
|
||||
|
||||
[Cloud Run](https://cloud.google.com/run/) is a service offered by [Google Cloud](https://cloud.google.com/). It's a fully managed serverless platform, for developing and deploying highly scalable containerized applications. Similar to AWS and Azure, GCP offers a wide range of cloud services, which are billed on a pay‐per‐use basis, but Cloud Run has a [free tier](https://cloud.google.com/run/pricing) offering 180,000 vCPU-seconds, 360,000 GiB-seconds, and 2 million requests per month.
|
||||
|
||||
To deploy Dashy to GCP, use the following link
|
||||
```
|
||||
https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git
|
||||
```
|
||||
|
||||
#### Platform.sh
|
||||
[![Deploy to Platform.sh](https://i.ibb.co/nPnJgJP/deploy-platform-sh-button.png)](https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy&utm_campaign=deploy_on_platform?utm_medium=button&utm_source=affiliate_links&utm_content=https://github.com/lissy93/dashy)
|
||||
|
||||
[Platform.sh](https://platform.sh) is an end-to-end solution for developing and deploying applications. It is geared towards enterprise users with large teams, and focuses on allowing applications to scale up and down. Unlike the above providers, Platform.sh is not free, although you can deploy a test app to it without needing a payment method
|
||||
|
||||
To deploy Dashy to Platform.sh, use the following link
|
||||
```
|
||||
https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy
|
||||
```
|
||||
|
||||
#### Render
|
||||
[![Deploy to Render](https://i.ibb.co/QXNCbxT/deploy-render-button.png)](https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render)
|
||||
|
||||
[Render](https://render.com) is cloud provider that provides easy deployments for static sites, Docker apps, web services, databases and background workers. Render is great for developing applications, and very easy to use. Static sites are free, and services start at $7/month. Currently there are only 2 server locations - Oregon, USA and Frankfurt, Germany. For more info, see the [Render Docs](https://render.com/docs)
|
||||
|
||||
To deploy Dashy to Render, use the following link
|
||||
```
|
||||
https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render
|
||||
```
|
||||
|
||||
#### Scalingo
|
||||
[![Deploy on Scalingo](https://i.ibb.co/nj0KxyH/deploy-scalingo-button.png)](https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master)
|
||||
|
||||
[Scalingo](https://scalingo.com/) is a scalable container-based cloud platform as a service. It's focus is on compliance and uptime, and is geared towards enterprise users. Scalingo is also not free, although they do have a 3-day free trial that does not require a payment method
|
||||
|
||||
To deploy Dashy to Scalingo, use the following link
|
||||
```
|
||||
https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master
|
||||
```
|
||||
|
||||
#### Play-with-Docker
|
||||
[![Try in PWD](https://i.ibb.co/SfbH7Zy/deploy-pwd-button.png)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
|
||||
[Play with Docker](https://labs.play-with-docker.com/) is a community project by Marcos Liljedhal and Jonathan Leibiusky and sponsored by Docker, intended to provide a hands-on learning environment. Their labs let you quickly spin up a Docker container or stack, and test out the image in a temporary, sandboxed environment. There's no need to sign up, and it's completely free.
|
||||
|
||||
To run Dashy in PWD, use the following URL:
|
||||
```
|
||||
https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml
|
||||
```
|
||||
|
||||
#### Surge.sh
|
||||
![Follow instructions below](https://i.ibb.co/XkcKzKz/deploy-surge-button.png)
|
||||
|
||||
[Surge.sh](http://surge.sh/) is quick and easy static web publishing platform for frontend-apps.
|
||||
Surge supports [password-protected projects](https://surge.sh/help/adding-password-protection-to-a-project). You can also [add a custom domain](https://surge.sh/help/adding-a-custom-domain) and then [force HTTPS by default](https://surge.sh/help/using-https-by-default) and optionally [set a custom SSL certificate](https://surge.sh/help/securing-your-custom-domain-with-ssl)
|
||||
|
||||
To deploy Dashy to Surge.sh, first clone and cd into Dashy, install dependencies, and then use the following commands
|
||||
```
|
||||
yarn add -g surge
|
||||
yarn build
|
||||
surge ./dist
|
||||
```
|
||||
|
||||
|
||||
### Hosting with CDN
|
||||
|
||||
Once Dashy has been built, it is effectivley just a static web app. This means that it can be served up with pretty much any static host, CDN or web server. To host Dashy through a CDN, the steps are very similar to building from source: clone the project, cd into it, install dependencies, write your config file and build the app. Once build is complete you will have a `./dist` directory within Dashy's root, and this is the build application which is ready to be served up.
|
||||
|
||||
However without Dashy's node server, there are a couple of features that will be unavailible to you, including: Writing config changes to disk through the UI, triggering a rebuild through the UI and application status checks. Everything else will work fine.
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
### System Requirements
|
||||
|
||||
Dashy works well on a Raspberry Pi (tested on Pi 3 and later), but should also run well on any system.
|
||||
|
||||
### Docker
|
||||
Initial app build causes a spike in resource usage, but once the built app is running it is fairly steady. For this reason, Dashy works best with a minimum of 1GB of memory, and 1GB of disk space.
|
||||
|
||||
### Bare Metal
|
||||
Minimum 526mb mem, 2GB disk space,
|
||||
|
||||
### CDN / Cloud Deploy
|
||||
No specific requirements. The built application alone (without the Node server) is very light-weight, and can be handled smoothly by pretty much any CDN or cloud deployment service (see [this list](/docs/deployment.md#deploy-to-cloud-service) or natively supported cloud providers).
|
||||
|
||||
If you're using your own icons, or other assets, additional disk space will be required for those resources.
|
||||
|
||||
### Browser Support
|
||||
|
||||
JavaScript is required to run Dashy.
|
||||
|
||||
In terms of browser support, pretty much any browser released since 2018 should render content just fine. However, for Internet Explorer, only IE11+ is supported, yet performance here is still not optimal. The recommended browser is either a Chromium-based / Webkit browser (Chrome, Brave, Vivaldi, Edge, Yandex, etc), or Firefox or one of it's forks (FF-ESR, Tor, LibreWolf, etc). Recent versions of Safari and Opera are also supported, but with limited continuous testing.
|
||||
|
||||
<p align="center"><img width="500" src="https://i.ibb.co/pjnmbw9/browser-compatibility.png" /></p>
|
||||
# Deployment
|
||||
|
||||
Welcome to Dashy, so glad you're here :) Deployment is super easy, and there are several methods available depending on what type of system you're using. If you're self-hosting, then deploying with Docker (or similar container engine) is the recommended approach.
|
||||
|
||||
## Quick Start
|
||||
|
||||
If you want to skip the fuss, and [get straight down to it](/docs/quick-start.md), then you can spin up a new instance of Dashy by running:
|
||||
|
||||
```bash
|
||||
docker run -p 8080:8080 lissy93/dashy
|
||||
```
|
||||
|
||||
See [Management Docs](/docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc
|
||||
|
||||
Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the [configuring docs](/docs/configuring.md).
|
||||
|
||||
## Deployment Methods
|
||||
|
||||
- [Deployment](#deployment)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Deployment Methods](#deployment-methods)
|
||||
- [Deploy with Docker](#deploy-with-docker)
|
||||
- [Using Docker Compose](#using-docker-compose)
|
||||
- [Kubernetes](#kubernetes)
|
||||
- [Unraid](#unraid)
|
||||
- [Synology NAS](#synology-nas)
|
||||
- [Build from Source](#build-from-source)
|
||||
- [Deploy to cloud service](#deploy-to-cloud-service)
|
||||
- [Netlify](#netlify)
|
||||
- [Heroku](#heroku)
|
||||
- [Vercel](#vercel)
|
||||
- [DigitalOcean](#digitalocean)
|
||||
- [Google Cloud Platform](#google-cloud-platform)
|
||||
- [Platform.sh](#platformsh)
|
||||
- [Render](#render)
|
||||
- [Railway](#railway)
|
||||
- [Scalingo](#scalingo)
|
||||
- [Play-with-Docker](#play-with-docker)
|
||||
- [Surge.sh](#surgesh)
|
||||
- [Easypanel](#easypanel)
|
||||
- [Hosting with CDN](#hosting-with-cdn)
|
||||
- [Requirements](#requirements)
|
||||
- [System Requirements](#system-requirements)
|
||||
- [Docker](#docker)
|
||||
- [Bare Metal](#bare-metal)
|
||||
- [CDN / Cloud Deploy](#cdn--cloud-deploy)
|
||||
- [Browser Support](#browser-support)
|
||||
|
||||
---
|
||||
|
||||
## Deploy with Docker
|
||||
|
||||
**Container Info**: [
|
||||
![Docker Supported Architecture](https://img.shields.io/badge/Architectures-amd64%20|%20arm32v7%20|%20arm64v8-6ba6e5)
|
||||
![Docker Base Image](https://img.shields.io/badge/Base_Image-Alpine_3.14-6ba6e5)
|
||||
![Docker Hosted on](https://img.shields.io/badge/Hosted_on-DockerHub-6ba6e5)
|
||||
](https://hub.docker.com/r/lissy93/dashy)<br>
|
||||
**Status**: [
|
||||
![Docker Build Status](https://img.shields.io/docker/cloud/build/lissy93/dashy?label=Docker%20Build)
|
||||
![Docker Pulls](https://img.shields.io/docker/pulls/lissy93/dashy?color=ecb2f7)
|
||||
![Docker Stars](https://img.shields.io/docker/stars/lissy93/dashy?color=f7f754&label=Docker%20Stars)
|
||||
![Docker Image Size](https://img.shields.io/docker/image-size/lissy93/dashy/latest?color=1eea76)
|
||||
![Docker Cloud Build](https://img.shields.io/docker/cloud/automated/lissy93/dashy?color=f4a966&label=Docker%20Build)
|
||||
](https://hub.docker.com/r/lissy93/dashy)
|
||||
|
||||
Dashy has a built container image hosted on [Docker Hub](https://hub.docker.com/r/lissy93/dashy). You will need [Docker](https://docs.docker.com/get-docker/) installed on your system.
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 8080:8080 \
|
||||
-v /root/my-local-conf.yml:/app/user-data/conf.yml \
|
||||
--name my-dashboard \
|
||||
--restart=always \
|
||||
lissy93/dashy:latest
|
||||
```
|
||||
|
||||
Explanation of the above options:
|
||||
|
||||
- `-d` Detached mode (not running in the foreground of your terminal)
|
||||
- `-p` The port that should be exposed, and the port it should be mapped to in your host system `[host-port][container-port]`, leave the container port as is
|
||||
- `-v` Specify volumes, to pass data from your host system to the container, in the format of `[host-path]:[container-path]`, you can use this to pass your config file, directory of assets (like icons), custom CSS or web assets (like favicon.ico, manifest.json etc)
|
||||
- `--name` Give your container a human-readable name
|
||||
- `--restart=always` Spin up the container when the daemon starts, or after it has been stopped
|
||||
- `lissy93/dashy:latest` This last option is the image the container should be built from, you can also use a specific version or architecture type, by replacing `:latest` with one of the [tags](https://hub.docker.com/r/lissy93/dashy/tags)
|
||||
|
||||
For all available options, and to learn more, see the [Docker Run Docs](https://docs.docker.com/engine/reference/commandline/run/)
|
||||
|
||||
Dashy is also available through GHCR: `docker pull ghcr.io/lissy93/dashy:latest`
|
||||
|
||||
If you're deploying Dashy on a modern ARM-based board, such as a Raspberry Pi (2+), then you'll need to use one of Dashy's ARM images. Set the base image + tag to either `lissy93/dashy:arm64v8` or `lissy93/dashy:arm32v7`, depending on your system architecture. You can also use the `multi-arch` image, which should work on all system architectures.
|
||||
|
||||
The image defaults to `:latest`, but you can instead specify a specific version, e.g. `docker pull lissy93/dashy:release-1.5.0`
|
||||
|
||||
---
|
||||
|
||||
## Using Docker Compose
|
||||
|
||||
Using Docker Compose can be useful for saving your specific config in files, without having to type out a long run command each time. Save compose config as a YAML file, and then run `docker compose up -d` (optionally use the `-f` flag to specify file location, if it isn't located at `./docker-compose.yml`), `-d` is detached mode (not running in the foreground of your terminal). Compose is also useful if you are using clusters, as the format is very similar to stack files, used with Docker Swarm.
|
||||
|
||||
The following is a complete example of a [`docker-compose.yml`](https://github.com/Lissy93/dashy/blob/master/docker-compose.yml) for Dashy. Run it as is, or uncomment the additional options you need.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "3.8"
|
||||
services:
|
||||
dashy:
|
||||
# To build from source, replace 'image: lissy93/dashy' with 'build: .'
|
||||
# build: .
|
||||
image: lissy93/dashy
|
||||
container_name: Dashy
|
||||
# Pass in your config file below, by specifying the path on your host machine
|
||||
# volumes:
|
||||
# - /root/my-config.yml:/app/user-data/conf.yml
|
||||
ports:
|
||||
- 4000:8080
|
||||
# Set any environmental variables
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
# Specify your user ID and group ID. You can find this by running `id -u` and `id -g`
|
||||
# - UID=1000
|
||||
# - GID=1000
|
||||
# Specify restart policy
|
||||
restart: unless-stopped
|
||||
# Configure healthchecks
|
||||
healthcheck:
|
||||
test: ['CMD', 'node', '/app/services/healthcheck']
|
||||
interval: 1m30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 40s
|
||||
```
|
||||
|
||||
You can use a different tag, by for example setting `image: lissy93/dashy:arm64v8`, or pull from GHCR instead by setting `image: ghcr.io/lissy93/dashy`.
|
||||
|
||||
If you are building from source, and would like to use one of the [other Dockerfiles](https://github.com/Lissy93/dashy/tree/master/docker), then under `services.dashy` first set `context: .`, then specify the the path to the dockerfile, e.g. `dockerfile: ./docker/Dockerfile-arm32v7`
|
||||
|
||||
---
|
||||
|
||||
## Kubernetes
|
||||
|
||||
@vyrtualsynthese has written a Helm Chart for deploying with Kubernetes, available [here](https://github.com/vyrtualsynthese/selfhosted-helmcharts/tree/main/charts/dashy)
|
||||
|
||||
---
|
||||
|
||||
## Unraid
|
||||
|
||||
// TODO
|
||||
|
||||
---
|
||||
|
||||
## Synology NAS
|
||||
|
||||
Installing dashy is really simply and fast:
|
||||
|
||||
1. Install Docker via Synology ```Package Center```.
|
||||
2. Go to ```File Station``` and open the ```docker``` folder. Inside the docker folder, create one new folder and name it ```dashy```.
|
||||
|
||||
> Note: Be careful to enter only lowercase, not uppercase letters.
|
||||
|
||||
3. Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script.
|
||||
4. Once you click on ```User-defined``` script a new window will open.
|
||||
5. Follow the instructions below:
|
||||
6. General: In the Task field type in Install dashy. Uncheck "Enabled" option. Select root User.
|
||||
7. Schedule: Select Run on the following date then select "Do not repeat".
|
||||
8. Task Settings: Check "Send run details by email", add your email then copy paste the code below in the Run command area. After that click OK.
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 4000:8080 \
|
||||
-v /volume1/docker/dashy/my-local-conf.yml:/app/user-data/conf.yml \
|
||||
--name dashy \
|
||||
--restart=always \
|
||||
lissy93/dashy:latest
|
||||
```
|
||||
|
||||
dashy should be up within 1-2min after you've started the install task procedure
|
||||
|
||||
---
|
||||
|
||||
## Build from Source
|
||||
|
||||
If you do not want to use Docker, you can run Dashy directly on your host system. For this, you will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed, and optionally [yarn](https://yarnpkg.com/)
|
||||
|
||||
1. Get Code: `git clone https://github.com/Lissy93/dashy.git` and `cd dashy`
|
||||
2. Configuration: Fill in you're settings in `./user-data/conf.yml`
|
||||
3. Install dependencies: `yarn`
|
||||
4. Build: `yarn build`
|
||||
5. Run: `yarn start`
|
||||
|
||||
---
|
||||
|
||||
## Deploy to cloud service
|
||||
|
||||
If you don't have a home server, then fear not - Dashy can be deployed to pretty much any cloud provider. The above Docker and NPM guides will work exactly the same on a VPS, but I've also setup some 1-Click deploy links for 10+ of the most common cloud providers, to make things easier. Note that if your instance is exposed to the internet, it will be your responsibility to adequately secure it.
|
||||
|
||||
Some hosting providers required a bit of extra configuration, which was why I've made separate branches for deploying to those services (named: [`deploy_cloudflare`](https://github.com/Lissy93/dashy/tree/deploy_cloudflare), [`deploy_digital-ocean`](https://github.com/Lissy93/dashy/tree/deploy_digital-ocean), [`deploy_platform-sh`](https://github.com/Lissy93/dashy/tree/deploy_platform-sh) and [`deploy_render`](https://github.com/Lissy93/dashy/tree/deploy_render)). If there's another cloud service which you'd like 1-click deployment to be supported for, feel free to raise an issue.
|
||||
|
||||
> [!NOTE]
|
||||
> If you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be available. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though.
|
||||
|
||||
### Netlify
|
||||
|
||||
[![Deploy to Netlify](https://i.ibb.co/GtKMysT/deploy-netlify-button.png)](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
|
||||
|
||||
[Netlify](https://www.netlify.com/) offers Git-based serverless cloud hosting for web applications. Their services are free to use for personal use, and they support deployment from both public and private repos, as well as direct file upload. The free plan also allows you to use your own custom domain or sub-domain, and is easy to setup.
|
||||
|
||||
To deploy Dashy to Netlify, use the following link
|
||||
|
||||
```text
|
||||
https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy
|
||||
```
|
||||
|
||||
### Heroku
|
||||
|
||||
[![Deploy to Heroku](https://i.ibb.co/GdMFzBP/deploy-heroku-button.png)](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
|
||||
|
||||
[Heroku](https://www.heroku.com/) is a fully managed cloud platform as a service. You define app settings in a Procfile and app.json, which specifying how the app should be build and how the server should be started. Heroku costs a minimum of $5 for 1,000 dyno hours per month (there are around 720 hours in a month), and supports custom domains. Heroku's single-dyno service is not as quite performant as some other providers, and the app will have a short wake-up time when not visited for a while
|
||||
|
||||
To deploy Dashy to Heroku, use the following link
|
||||
|
||||
```text
|
||||
https://heroku.com/deploy?template=https://github.com/Lissy93/dashy
|
||||
```
|
||||
|
||||
### Vercel
|
||||
|
||||
[![Deploy with Vercel](https://i.ibb.co/mJF3R7m/deploy-vercel-button.png)](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
|
||||
|
||||
[Vercel](https://vercel.com/) is a performance-focused platform for hosting static frontend apps. It comes bundled with some useful tools for monitoring and analyzing application performance and other metrics. Vercel is free for personal use, allows for custom domains and has very reasonable limits.
|
||||
|
||||
To deploy Dashy to Vercel, use the following link
|
||||
|
||||
```text
|
||||
https://vercel.com/new/project?template=https://github.com/lissy93/dashy
|
||||
```
|
||||
|
||||
### DigitalOcean
|
||||
|
||||
[![Deploy to DO](https://i.ibb.co/PFt0PkB/deploy-digital-ocean-button.png)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean&refcode=3838338e7f79)
|
||||
|
||||
[DigitalOcean](https://www.digitalocean.com/) is a cloud service providing affordable developer-friendly virtual machines from $5/month. But they also have an app platform, where you can run web apps, static sites, APIs and background workers. CDN-backed static sites are free for personal use.
|
||||
|
||||
```text
|
||||
https://cloud.digitalocean.com/apps/new?repo=https://github.com/lissy93/dashy/tree/deploy_digital-ocean
|
||||
```
|
||||
|
||||
### Google Cloud Platform
|
||||
|
||||
[![Run on Google Cloud](https://i.ibb.co/LkvHttd/deploy-google-cloud-button.png)](https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git)
|
||||
|
||||
[Cloud Run](https://cloud.google.com/run/) is a service offered by [Google Cloud](https://cloud.google.com/). It's a fully managed serverless platform, for developing and deploying highly scalable containerized applications. Similar to AWS and Azure, GCP offers a wide range of cloud services, which are billed on a pay‐per‐use basis, but Cloud Run has a [free tier](https://cloud.google.com/run/pricing) offering 180,000 vCPU-seconds, 360,000 GiB-seconds, and 2 million requests per month.
|
||||
|
||||
To deploy Dashy to GCP, use the following link
|
||||
|
||||
```text
|
||||
https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git
|
||||
```
|
||||
|
||||
### Platform.sh
|
||||
|
||||
[![Deploy to Platform.sh](https://i.ibb.co/nPnJgJP/deploy-platform-sh-button.png)](https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy&utm_campaign=deploy_on_platform?utm_medium=button&utm_source=affiliate_links&utm_content=https://github.com/lissy93/dashy)
|
||||
|
||||
[Platform.sh](https://platform.sh) is an end-to-end solution for developing and deploying applications. It is geared towards enterprise users with large teams, and focuses on allowing applications to scale up and down. Unlike the above providers, Platform.sh is not free, although you can deploy a test app to it without needing a payment method
|
||||
|
||||
To deploy Dashy to Platform.sh, use the following link
|
||||
|
||||
```text
|
||||
https://console.platform.sh/projects/create-project/?template=https://github.com/lissy93/dashy
|
||||
```
|
||||
|
||||
### Render
|
||||
|
||||
[![Deploy to Render](https://i.ibb.co/QXNCbxT/deploy-render-button.png)](https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render)
|
||||
|
||||
[Render](https://render.com) is cloud provider that provides easy deployments for static sites, Docker apps, web services, databases and background workers. Render is great for developing applications, and very easy to use. Static sites are free, and services start at $7/month. Currently there are only 2 server locations - Oregon, USA and Frankfurt, Germany. For more info, see the [Render Docs](https://render.com/docs)
|
||||
|
||||
To deploy Dashy to Render, use the following link
|
||||
|
||||
```text
|
||||
https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render
|
||||
```
|
||||
|
||||
### Railway
|
||||
|
||||
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/MtdjAQ?referralCode=app)
|
||||
|
||||
[Railway](https://railway.app/) is a Platform as a Service (PaaS) that offers a complete platform for building and delivering programs to the backend of the cloud. You bring your code and Railway does the rest. Railway offers an extremely good developer experience and makes it effortless to deploy apps. Railway offers a free Trial Plan, and paid plans start at $5/month. Railway has 4 server locations: US-west, US-east, EU-west and ASIA-South-East.
|
||||
|
||||
```text
|
||||
https://railway.app/template/MtdjAQ
|
||||
```
|
||||
|
||||
### Scalingo
|
||||
|
||||
[![Deploy on Scalingo](https://i.ibb.co/nj0KxyH/deploy-scalingo-button.png)](https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master)
|
||||
|
||||
[Scalingo](https://scalingo.com/) is a scalable container-based cloud platform as a service. It's focus is on compliance and uptime, and is geared towards enterprise users. Scalingo is also not free, although they do have a 3-day free trial that does not require a payment method.
|
||||
|
||||
To deploy Dashy to Scalingo, use the following link
|
||||
|
||||
```text
|
||||
https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master
|
||||
```
|
||||
|
||||
### Play-with-Docker
|
||||
|
||||
[![Try in PWD](https://i.ibb.co/SfbH7Zy/deploy-pwd-button.png)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
|
||||
[Play with Docker](https://labs.play-with-docker.com/) is a community project by Marcos Liljedhal and Jonathan Leibiusky and sponsored by Docker, intended to provide a hands-on learning environment. Their labs let you quickly spin up a Docker container or stack, and test out the image in a temporary, sandboxed environment. There's no need to sign up, and it's completely free.
|
||||
|
||||
To run Dashy in PWD, use the following URL:
|
||||
|
||||
```text
|
||||
https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml
|
||||
```
|
||||
|
||||
### Surge.sh
|
||||
|
||||
![Follow instructions below](https://i.ibb.co/XkcKzKz/deploy-surge-button.png)
|
||||
|
||||
[Surge.sh](http://surge.sh/) is quick and easy static web publishing platform for frontend-apps.
|
||||
Surge supports [password-protected projects](https://surge.sh/help/adding-password-protection-to-a-project). You can also [add a custom domain](https://surge.sh/help/adding-a-custom-domain) and then [force HTTPS by default](https://surge.sh/help/using-https-by-default) and optionally [set a custom SSL certificate](https://surge.sh/help/securing-your-custom-domain-with-ssl)
|
||||
|
||||
To deploy Dashy to Surge.sh, first clone and cd into Dashy, install dependencies, and then use the following commands
|
||||
|
||||
```bash
|
||||
yarn add -g surge
|
||||
yarn build
|
||||
surge ./dist
|
||||
```
|
||||
|
||||
### Easypanel
|
||||
|
||||
[![Deploy to Easypanel](https://i.ibb.co/ZNPwQX3/deploy-easypanel-button.png)](https://easypanel.io/docs/templates/dashy)
|
||||
|
||||
[Easypanel](https://easypanel.io) it's a modern server control panel. You can use it to deploy Dashy on your own server.
|
||||
|
||||
To deploy Dashy to Easypanel, use the following link
|
||||
|
||||
```text
|
||||
https://easypanel.io/docs/templates/dashy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Hosting with CDN
|
||||
|
||||
Once Dashy has been built, it is effectively just a static web app. This means that it can be served up with pretty much any static host, CDN or web server. To host Dashy through a CDN, the steps are very similar to building from source: clone the project, cd into it, install dependencies, write your config file and build the app. Once build is complete you will have a `./dist` directory within Dashy's root, and this is the build application which is ready to be served up.
|
||||
|
||||
However without Dashy's node server, there are a couple of features that will be unavailable to you, including: Writing config changes to disk through the UI, triggering a rebuild through the UI and application status checks. Everything else will work fine.
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### System Requirements
|
||||
|
||||
Dashy works well on a Raspberry Pi (tested on Pi 3 and later), but should also run well on any system.
|
||||
|
||||
### Docker
|
||||
|
||||
Initial app build causes a spike in resource usage, but once the built app is running it is fairly steady. For this reason, Dashy works best with a minimum of 1GB of memory, and 1GB of disk space.
|
||||
|
||||
### Bare Metal
|
||||
|
||||
Minimum 526mb mem, 2GB disk space.
|
||||
|
||||
### CDN / Cloud Deploy
|
||||
|
||||
No specific requirements. The built application alone (without the Node server) is very light-weight, and can be handled smoothly by pretty much any CDN or cloud deployment service (see [this list](/docs/deployment.md#deploy-to-cloud-service) or natively supported cloud providers).
|
||||
|
||||
If you're using your own icons, or other assets, additional disk space will be required for those resources.
|
||||
|
||||
### Browser Support
|
||||
|
||||
JavaScript is required to run Dashy.
|
||||
|
||||
In terms of browser support, pretty much any browser released since 2018 should render content just fine. However, for Internet Explorer, only IE11+ is supported, yet performance here is still not optimal. The recommended browser is either a Chromium-based / Webkit browser (Chrome, Brave, Vivaldi, Edge, Yandex, etc), or Firefox or one of it's forks (FF-ESR, Tor, LibreWolf, etc). Recent versions of Safari and Opera are also supported, but with limited continuous testing.
|
||||
|
||||
<p align="center"><img width="500" src="https://i.ibb.co/pjnmbw9/browser-compatibility.png" /></p>
|
||||
|
|
|
@ -24,6 +24,7 @@ If you're adding new features, you may want to check out the [Development Guides
|
|||
## Setting up the Dev Environment
|
||||
|
||||
### Prerequisites
|
||||
|
||||
You will need either the latest or LTS version of **[Node.js](https://nodejs.org/)** to build and serve the application and **[Git](https://git-scm.com/downloads)** to easily fetch the code, and push any changes. If you plan on running or deploying the container, you'll also need **[Docker](https://docs.docker.com/get-docker/)**. To avoid any unexpected issues, ensure you've got at least **[NPM](https://www.npmjs.com/get-npm)** V 7.5 or **[Yarn](https://classic.yarnpkg.com/en/docs/install/#windows-stable)** 1.22 (you may find [NVM](https://github.com/nvm-sh/nvm) helpful for switching/ managing versions).
|
||||
|
||||
### Running the Project
|
||||
|
@ -33,34 +34,40 @@ You will need either the latest or LTS version of **[Node.js](https://nodejs.org
|
|||
3. Install dependencies: `yarn`
|
||||
4. Start dev server: `yarn dev`
|
||||
|
||||
Dashy should now be being served on http://localhost:8080/. Hot reload is enabled, so making changes to any of the files will trigger them to be rebuilt and the page refreshed.
|
||||
Dashy should now be being served on <http://localhost:8080/>. Hot reload is enabled, so making changes to any of the files will trigger them to be rebuilt and the page refreshed.
|
||||
|
||||
### Project Commands
|
||||
|
||||
#### Basics
|
||||
|
||||
- **`yarn build`** - In the interest of speed, the application is pre-compiled, this means that the config file is read during build-time, and therefore the app needs to rebuilt for any new changes to take effect. Luckily this is very straight forward. Just run `yarn build` or `docker exec -it [container-id] yarn build`
|
||||
- **`yarn start`** - Starts a web server, and serves up the production site from `./dist` (must run build command first)
|
||||
|
||||
#### Development
|
||||
|
||||
- **`yarn dev`** - Starts the development server with hot reloading
|
||||
- **`yarn lint`** - Lints code to ensure it follows a consistent, neat style
|
||||
- **`yarn test`** - Runs tests, and outputs results
|
||||
|
||||
#### Utils and Checks
|
||||
- **`yarn validate-config`** - If you have quite a long configuration file, you may wish to check that it's all good to go, before deploying the app. This can be done with `yarn validate-config` or `docker exec -it [container-id] yarn validate-config`. Your config file needs to be in `/public/conf.yml` (or within your Docker container at `/app/public/conf.yml`). This will first check that your YAML is valid, and then validates it against Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js).
|
||||
|
||||
- **`yarn validate-config`** - If you have quite a long configuration file, you may wish to check that it's all good to go, before deploying the app. This can be done with `yarn validate-config` or `docker exec -it [container-id] yarn validate-config`. Your config file needs to be in `/user-data/conf.yml` (or within your Docker container at `/app/user-data/conf.yml`). This will first check that your YAML is valid, and then validates it against Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js).
|
||||
- **`yarn health-check`** - Checks that the application is up and running on it's specified port, and outputs current status and response times. Useful for integrating into your monitoring service, if you need to maintain high system availability
|
||||
|
||||
#### Alternate Start Commands
|
||||
|
||||
- **`yarn build-and-start`** - Builds the app, runs checks and starts the production server. Commands are run in parallel, and so is faster than running them in independently. Uses the `yarn build` and `yarn start` commands
|
||||
- **`yarn build-watch`** - If you find yourself making frequent changes to your configuration, and do not want to have to keep manually rebuilding, then this option is for you. It will watch for changes to any files within the projects root, and then trigger a rebuild. Note that if you are developing new features, then `yarn dev` would be more appropriate, as it's significantly faster at recompiling (under 1 second), and has hot reloading, linting and testing integrated
|
||||
- **`yarn pm2-start`** - Starts the Node server using [PM2](https://pm2.keymetrics.io/), a process manager for Node.js applications, that helps them stay alive. PM2 has some built-in basic monitoring features, and an optional [management solution](https://pm2.io/). If you are running the app on bare metal, it is recommended to use this start command
|
||||
|
||||
#### Notes
|
||||
|
||||
- If you are using NPM, replace `yarn` with `npm run`
|
||||
- If you are using Docker, precede each command with `docker exec -it [container-id]`. Container ID can be found by running `docker ps`
|
||||
- You can manage the app using the [Vue-CLI Service](https://cli.vuejs.org/guide/cli-service.html), with `npx vue-cli-service [command]`. Or to start the Vue Management UI, run `npx vue ui`, and open `http://localhost:8000`
|
||||
- You can manage the app using the [Vue-CLI Service](https://cli.vuejs.org/guide/cli-service.html), with `npx vue-cli-service [command]`. Or to start the Vue Management UI, run `npx vue ui`, and open `http://localhost:8000`
|
||||
|
||||
### Environmental Variables
|
||||
|
||||
All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under `appConfig` in the `conf.yml` file.
|
||||
|
||||
You can set variables either in your environment, or using the [`.env`](https://github.com/Lissy93/dashy/blob/master/.env) file.
|
||||
|
@ -73,8 +80,10 @@ You can set variables either in your environment, or using the [`.env`](https://
|
|||
- `INTEGRITY` - Should enable SRI for build script and link resources
|
||||
- `IS_DOCKER` - Computed automatically on build. Indicates if running in container
|
||||
- `VUE_APP_VERSION` - Again, set automatically using package.json during build time
|
||||
- `BACKUP_DIR` - Directory for conf.yml backups
|
||||
|
||||
### Environment Modes
|
||||
|
||||
You can set the environment using the `NODE_ENV` variable. By default, the correct environment should be selected based on the script you run to start the app. The following environments are supported: `production`, `development` and `test`. For more info, see [Vue CLI Environment Modes](https://cli.vuejs.org/guide/mode-and-env.html#modes).
|
||||
|
||||
---
|
||||
|
@ -82,6 +91,7 @@ You can set the environment using the `NODE_ENV` variable. By default, the corre
|
|||
## Git Strategy
|
||||
|
||||
### Git Flow
|
||||
|
||||
Like most Git repos, we are following the [Github Flow](https://guides.github.com/introduction/flow) standard.
|
||||
|
||||
1. Create a branch (or fork if you don'd have write access)
|
||||
|
@ -93,10 +103,12 @@ Like most Git repos, we are following the [Github Flow](https://guides.github.co
|
|||
7. Merge 🎉
|
||||
|
||||
### Git Branch Naming
|
||||
|
||||
The format of your branch name should be something similar to: `[TYPE]/[TICKET]_[TITLE]`
|
||||
For example, `FEATURE/420_Awesome-feature` or `FIX/690_login-server-error`
|
||||
|
||||
### Commit Emojis
|
||||
|
||||
Using a single emoji at the start of each commit message, to indicate the type task, makes the commit ledger easier to understand, plus it looks cool.
|
||||
|
||||
- 🎨 `:art:` - Improve structure / format of the code.
|
||||
|
@ -127,14 +139,17 @@ Using a single emoji at the start of each commit message, to indicate the type t
|
|||
For a full list of options, see [gitmoji.dev](https://gitmoji.dev/)
|
||||
|
||||
### PR Guidelines
|
||||
|
||||
Once you've made your changes, and pushed them to your fork or branch, you're ready to open a pull request!
|
||||
|
||||
For a pull request to be merged, it must:
|
||||
|
||||
- Must be backwards compatible
|
||||
- The build, lint and tests (run by GH actions) must pass
|
||||
- There must not be any merge conflicts
|
||||
|
||||
When you submit your PR, include the required info, by filling out the PR template. Including:
|
||||
|
||||
- A brief description of your changes
|
||||
- The issue, ticket or discussion number (if applicable)
|
||||
- For UI relate updates include a screenshot
|
||||
|
@ -144,7 +159,9 @@ When you submit your PR, include the required info, by filling out the PR templa
|
|||
---
|
||||
|
||||
## Resources for Beginners
|
||||
|
||||
New to Web Development? Glad you're here! Dashy is a pretty simple app, so it should make a good candidate for your first PR. Presuming that you already have a basic knowledge of JavaScript, the following articles should point you in the right direction for getting up to speed with the technologies used in this project:
|
||||
|
||||
- [Open Source for Beginners](https://opensource.guide/how-to-contribute/)
|
||||
- [Introduction to Vue.js](https://v3.vuejs.org/guide/introduction.html)
|
||||
- [Vue.js Walkthrough](https://www.taniarascia.com/getting-started-with-vue/)
|
||||
|
@ -158,41 +175,45 @@ New to Web Development? Glad you're here! Dashy is a pretty simple app, so it sh
|
|||
- [Git cheat sheet](http://git-cheatsheet.com/)
|
||||
- [Basics of using NPM](https://www.freecodecamp.org/news/what-is-npm-a-node-package-manager-tutorial-for-beginners/)
|
||||
|
||||
As well as Node, Git and Docker- you'll also need an IDE (e.g. [VS Code](https://code.visualstudio.com/) or [Vim](https://www.vim.org/)) and a terminal (Windows users may find [WSL](https://docs.microsoft.com/en-us/windows/wsl/) more convenient).
|
||||
As well as Node, Git and Docker- you'll also need an IDE (e.g. [VS Code](https://code.visualstudio.com/) or [Vim](https://www.vim.org/)) and a terminal (Windows users may find [WSL](https://docs.microsoft.com/en-us/windows/wsl/) more convenient).
|
||||
|
||||
---
|
||||
|
||||
## App Info
|
||||
|
||||
## Style Guide
|
||||
### Style Guide
|
||||
|
||||
Linting is done using [ESLint](https://eslint.org/), and using the [Vue.js Styleguide](https://github.com/vuejs/eslint-config-standard), which is very similar to the [AirBnB Stylguide](https://github.com/airbnb/javascript). You can run `yarn lint` to report and fix issues. While the dev server is running, issues will be reported to the console automatically, and any lint errors will trigger the build to fail. Note that all lint checks must pass before any PR can be merged. Linting is also run as a git pre-commit hook
|
||||
Linting is done using [ESLint](https://eslint.org/), and using the [Vue.js Styleguide](https://github.com/vuejs/eslint-config-standard), which is very similar to the [AirBnB Styleguide](https://github.com/airbnb/javascript). You can run `yarn lint` to report and fix issues. While the dev server is running, issues will be reported to the console automatically, and any lint errors will trigger the build to fail. Note that all lint checks must pass before any PR can be merged. Linting is also run as a git pre-commit hook
|
||||
|
||||
The most significant things to note are:
|
||||
|
||||
- Indentation should be done with two spaces
|
||||
- Strings should use single quotes
|
||||
- All statements must end in a semi-colon
|
||||
- The final element in all objects must be preceded with a comma
|
||||
- Maximum line length is 100
|
||||
- There must be exactly one blank line between sections, before function names, and at the end of the file
|
||||
- With conditionals, put else on the same line as your if block’s closing brace
|
||||
- With conditionals, put else on the same line as your if block's closing brace
|
||||
- All multiline blocks must use braces
|
||||
- Avoid console statements in the frontend
|
||||
|
||||
Styleguides:
|
||||
|
||||
- Vue: [Vue styleguide](https://vuejs.org/v2/style-guide/)
|
||||
- JavaScript: [github.com/airbnb/javascript](https://github.com/airbnb/javascript)
|
||||
- JavaScript: [github.com/airbnb/javascript](https://github.com/airbnb/javascript)
|
||||
|
||||
---
|
||||
|
||||
## Application Structure
|
||||
### Application Structure
|
||||
|
||||
#### Files in the Root: `./`
|
||||
```
|
||||
|
||||
```text
|
||||
╮
|
||||
├── package.json # Project meta-data, dependencies and paths to scripts
|
||||
├── src/ # Project front-end source code
|
||||
├── server.js # A Node.js server to serve up the /dist directory
|
||||
├── services/ # All server-side endpoints and utilities
|
||||
├── vue.config.js # Vue.js configuration
|
||||
├── Dockerfile # The blueprint for building the Docker container
|
||||
├── docker-compose.yml # A Docker run command
|
||||
|
@ -206,14 +227,17 @@ Styleguides:
|
|||
|
||||
#### Frontend Source: `./src/`
|
||||
|
||||
```
|
||||
```text
|
||||
./src
|
||||
├── App.vue # Vue.js starting file
|
||||
├── assets # Static non-compiled assets
|
||||
│ ├── fonts # .ttf font files
|
||||
│ ├── locales # All app text, each language in a separate JSON file
|
||||
│ ╰── interface-icons # SVG icons used in the app
|
||||
│ ╰── interface-icons # SVG icons used in the app
|
||||
├── components # All front-end Vue web components
|
||||
│ ├── Charts # Charting components for dynamically displaying widget data
|
||||
│ │ ├── Gauge.vue # A speed-dial style chart for showing 0 - 100 values
|
||||
│ │ ╰── PercentageChart.vue # A horizontal bar for showing percentage breakdowns
|
||||
│ ├── Configuration # Components relating to the user config pop-up
|
||||
│ │ ├── AppInfoModal.vue # A modal showing core app info, like version, language, etc
|
||||
│ │ ├── AppVersion.vue # Shows current version from package.json, compares with GitHub
|
||||
|
@ -225,15 +249,30 @@ Styleguides:
|
|||
│ │ ╰── RebuildApp.vue # A component allowing user to trigger a rebuild through the UI
|
||||
│ ├── FormElements # Basic form elements used throughout the app
|
||||
│ │ ├── Button.vue # Standard button component
|
||||
│ │ ╰── Input.vue # Standard text field input component
|
||||
│ │ ├── Radio.vue # Standard radio button input
|
||||
│ │ ├── Select.vue # Standard dropdown input selector
|
||||
│ │ ├── Input.vue # Standard text field input component
|
||||
│ │ ╰── Toggle.vue # Standard on / off toggle switch
|
||||
│ ├── InteractiveEditor # Components for the interactive UI config editor
|
||||
│ │ ├── AddNewSectionLauncher # Button that launches the EditSection form, used for adding new section
|
||||
│ │ ├── EditAppConfig.vue # Form for editing appConfig
|
||||
│ │ ├── EditPageInfo.vue # Form for editing pageInfo
|
||||
│ │ ├── EditSection.vue # Form for adding / editing sections
|
||||
│ │ ├── EditItem.vue # Form for adding or editing items
|
||||
│ │ ├── EditModeSaveMenu.vue # The bar at the bottom of screen in edit mode, containing save buttons
|
||||
│ │ ├── EditModeTopBanner.vue # The bar at the top of screen in edit mode
|
||||
│ │ ├── ExportConfigMenu.vue # Modal for viewing / exporting edited config
|
||||
│ │ ├── MoveItemTo.vue # Form for moving / copying items to other sections
|
||||
│ │ ╰── SaveCancelButtons.vue # Buttons visible in all the edit menus, to save or cancel changes
|
||||
│ ├── LinkItems # Components for Sections and Link Items
|
||||
│ │ ├── Collapsable.vue # The collapsible functionality of sections
|
||||
│ │ ├── ContextMenu.vue # The right-click menu, for showing Item opening methods and info
|
||||
│ │ ├── IframeModal.vue # Pop-up iframe modal, for viewing websites within the app
|
||||
│ │ ├── Item.vue # Main link item, which is displayed within an item group
|
||||
│ │ ├── ItemGroup.vue # Item group is a section containing icons
|
||||
│ │ ├── ItemIcon.vue # The icon used by both items and sections
|
||||
│ │ ├── ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening method
|
||||
│ │ ├── ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening method
|
||||
│ │ ├── ItemContextMenu.vue # The right-click menu, for showing Item opening methods and info
|
||||
│ │ ├── SectionContextMenu.vue # The right-click menu, for showing Section edit/ open options
|
||||
│ │ ╰── StatusIndicator.vue # Traffic light dot, showing if app is online or down
|
||||
│ ├── Minimal View # Components used for the startpage / minimal alternative view
|
||||
│ │ ├── MinimalHeading.vue # Title part of minimal view
|
||||
|
@ -250,7 +289,10 @@ Styleguides:
|
|||
│ │ ├── SideBar.vue # The left sidebar for the workspace view
|
||||
│ │ ├── SideBarItem.vue # App item for the sidebar view
|
||||
│ │ ├── SideBarSection.vue # Collapsible collection of items within workspace sidebar
|
||||
│ │ ╰── WebContent.vue # Workspace iframe view, displays content of current app
|
||||
│ │ ├── WebContent.vue # Workspace iframe view, displays content of current app
|
||||
│ │ ╰── WidgetView.vue # Workspace container for displaying widgets in main content
|
||||
│ ├── Widgets # Directory contains all custom widget components
|
||||
│ │ ╰── .... # Too many to list, see widget docs instead
|
||||
│ ╰── Settings # Components relating to the quick-settings, in the top-right
|
||||
│ ├── AuthButtons.vue # Logout button and other app info
|
||||
│ ├── ConfigLauncher.vue # Icon that when clicked will launch the Configuration component
|
||||
|
@ -266,6 +308,19 @@ Styleguides:
|
|||
├── registerServiceWorker.js # Registers and manages service workers, for PWA apps
|
||||
├── router.js # Defines all available application routes
|
||||
├── styles # Directory of all globally used common SCSS styles
|
||||
│ ├── color-palette.scss # All color variable names and default values
|
||||
│ ├── color-themes.scss # All variable values for built-in themes
|
||||
│ ├── dimensions.scss # Dimensions and sizes as variables
|
||||
│ ├── global-styles.scss # Basics and style resets used globally
|
||||
│ ├── media-queries.scss # Screen sizes and media queries
|
||||
│ ├── style-helpers.scss # SCSS functions used for modifying values
|
||||
│ ├── typography.scss # Font and text styles used globally
|
||||
│ ╰── user-defined-themes.scss # Empty, put any custom styles or themes here
|
||||
├── mixins # Reusable component bases, extended by other views / components
|
||||
│ ├── ChartingMixin.js # Functions for rendering charts in widget components
|
||||
│ ├── GlancesMixin.js # Functions for fetching system info from Glances for widgets
|
||||
│ ├── HomeMixin.js # Functions for homepage, used by default, minimal and workspace views
|
||||
│ ╰── WidgetMixin.js # Functions for all widgets, like data fetching, updating and error handling
|
||||
├── utils # Directory of re-used helper functions
|
||||
│ ├── ArrowKeyNavigation.js # Functionality for arrow-key navigation
|
||||
│ ├── Auth.js # Handles all authentication related actions
|
||||
|
@ -285,6 +340,7 @@ Styleguides:
|
|||
│ ├── InitServiceWorker.js # Initializes and manages service worker, if enabled
|
||||
│ ├── Search.js # Helper functions for searching/ filtering items in all views
|
||||
│ ├── JsonToYaml.js # Function that parses and converts raw JSON into valid YAML
|
||||
│ ├── KeycloakAuth.js # Singleton class to manage Keycloak authentication
|
||||
│ ├── languages.js # Handles fetching, switching and validating languages
|
||||
│ ╰── ThemeHelper.js # Function that handles the fetching and setting of user themes
|
||||
╰── views # Directory of available pages, corresponding to available routes
|
||||
|
@ -304,9 +360,11 @@ Styleguides:
|
|||
## Development Tools
|
||||
|
||||
### Performance - Lighthouse
|
||||
|
||||
The easiest method of checking performance is to use Chromium's build in auditing tool, Lighthouse. To run the test, open Developer Tools (usually F12) --> Lighthouse and click on the 'Generate Report' button at the bottom.
|
||||
|
||||
### Dependencies - BundlePhobia
|
||||
|
||||
[BundlePhobia](https://bundlephobia.com/) is a really useful app that lets you analyze the cost of adding any particular dependency to an application
|
||||
|
||||
---
|
||||
|
@ -320,4 +378,3 @@ When running the build command, several warnings appear. These are not errors, a
|
|||
`WARN A new version of sass-loader is available. Please upgrade for best experience.` - Currently we're using an older version of SASS loader, since the more recent releases do not seem to be compatible with the Vue CLI's webpack configuration.
|
||||
|
||||
`WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB).` - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed.
|
||||
|
||||
|
|
|
@ -1,221 +1,473 @@
|
|||
# Development Guides
|
||||
|
||||
A series of short tutorials, to guide you through the most common development tasks.
|
||||
|
||||
Sections:
|
||||
- [Creating a new theme](#creating-a-new-theme)
|
||||
- [Writing Translations](#writing-translations)
|
||||
- [Adding a new option in the config file](#adding-a-new-option-in-the-config-file)
|
||||
- [Updating Dependencies](#updating-dependencies)
|
||||
|
||||
## Creating a new theme
|
||||
|
||||
Adding a new theme is really easy. There's two things you need to do: Pass the theme name to Dashy, so that it can be added to the theme selector dropdown menu, and then write some styles!
|
||||
|
||||
##### 1. Add Theme Name
|
||||
Choose a snappy name for you're theme, and add it to the `builtInThemes` array inside [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L27).
|
||||
|
||||
##### 2. Write some Styles!
|
||||
Put your theme's styles inside [`color-themes.scss`](https://github.com/Lissy93/dashy/blob/master/src/styles/color-themes.scss).
|
||||
Create a new block, and make sure that `data-theme` matches the theme name you chose above. For example:
|
||||
|
||||
```css
|
||||
html[data-theme='tiger'] {
|
||||
--primary: #f58233;
|
||||
--background: #0b1021;
|
||||
}
|
||||
```
|
||||
|
||||
Then you can go ahead and write you're own custom CSS. Although all CSS is supported here, the best way to define you're theme is by setting the CSS variables. You can find a [list of all CSS variables, here](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#css-variables).
|
||||
|
||||
For a full guide on styling, see [Theming Docs](./theming.md).
|
||||
|
||||
Note that if you're theme is just for yourself, and you're not submitting a PR, then you can instead just pass it under `appConfig.cssThemes` inside your config file. And then put your theme in your own stylesheet, and pass it into the Docker container - [see how](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#adding-your-own-theme).
|
||||
|
||||
## Writing Translations
|
||||
|
||||
For full docs about Dashy's multi-language support, see [Multi-Language Support](./multi-language-support.md)
|
||||
|
||||
Dashy is using [vue-i18n](https://vue-i18n.intlify.dev/guide/) to manage multi-language support.
|
||||
|
||||
Adding a new language is pretty straightforward, with just three steps:
|
||||
|
||||
##### 1. Create a new Language File
|
||||
Create a new JSON file in `./src/assets/locales` name is a 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language, E.g. for German `de.json`, French `fr.json` or Spanish `es.json` - You can find a list of all ISO codes at [iso.org](https://www.iso.org/obp/ui).
|
||||
|
||||
##### 2. Translate!
|
||||
Using [`en.json`](https://github.com/Lissy93/dashy/tree/master/src/assets/locales/en.json) as an example, translate the JSON values to your language, while leaving the keys as they are. It's fine to leave out certain items, as if they're missing they will fall-back to English. If you see any attribute which include curly braces (`{xxx}`), then leave the inner value of these braces as is, as this is for variables.
|
||||
|
||||
```json
|
||||
{
|
||||
"theme-maker": {
|
||||
"export-button": "Benutzerdefinierte Variablen exportieren",
|
||||
"reset-button": "Stile zurücksetzen für",
|
||||
"show-all-button": "Alle Variablen anzeigen",
|
||||
"save-button": "Speichern",
|
||||
"cancel-button": "Abbrechen",
|
||||
"saved-toast": "{theme} Erfolgreich aktualisiert",
|
||||
"reset-toast": "Benutzerdefinierte Farben für {theme} entfernt"
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
##### 3. Add your file to the app
|
||||
|
||||
In [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/tree/master/src/utils/languages.js), you need to do 2 small things:
|
||||
|
||||
First import your new translation file, do this at the top of the page.
|
||||
E.g. `import de from '@/assets/locales/de.json';`
|
||||
|
||||
Second, add it to the array of languages, e.g:
|
||||
```javascript
|
||||
export const languages = [
|
||||
{
|
||||
name: 'English',
|
||||
code: 'en',
|
||||
locale: en,
|
||||
flag: '🇬🇧',
|
||||
},
|
||||
{
|
||||
name: 'German', // The name of your language
|
||||
code: 'de', // The ISO code of your language
|
||||
locale: de, // The name of the file you imported (no quotes)
|
||||
flag: '🇩🇪', // An optional flag emoji
|
||||
},
|
||||
];
|
||||
```
|
||||
You can also add your new language to the readme, under the [Language Switching](https://github.com/Lissy93/dashy#language-switching-) section, and optionally include your name/ username if you'd like to be credited for your work. Done!
|
||||
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
|
||||
# Adding a new option in the config file
|
||||
|
||||
This section is for, if you're adding a new component or setting, that requires an additional item to be added to the users config file.
|
||||
|
||||
All of the users config is specified in `./public/conf.yml` - see [Configuring Docs](./configuring.md) for info.
|
||||
Before adding a new option in the config file, first ensure that there is nothing similar available, that is is definitely necessary, it will not conflict with any other options and most importantly that it will not cause any breaking changes. Ensure that you choose an appropriate and relevant section to place it under.
|
||||
|
||||
Next decide the most appropriate place for your attribute:
|
||||
- Application settings should be located under `appConfig`
|
||||
- Page info (such as text and metadata) should be under `pageInfo`
|
||||
- Data relating to specific sections should be under `section[n].displayData`
|
||||
- And for setting applied to specific items, it should be under `item[n]`
|
||||
|
||||
In order for the user to be able to add your new attribute using the Config Editor, and for the build validation to pass, your attribute must be included within the [ConfigSchema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js). You can read about how to do this on the [ajv docs](https://ajv.js.org/json-schema.html). Give your property a type and a description, as well as any other optional fields that you feel are relevant. For example:
|
||||
|
||||
```json
|
||||
"fontAwesomeKey": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-z0-9]{10}$",
|
||||
"description": "API key for font-awesome",
|
||||
"example": "0821c65656"
|
||||
}
|
||||
```
|
||||
or
|
||||
```json
|
||||
"iconSize": {
|
||||
"enum": [ "small", "medium", "large" ],
|
||||
"default": "medium",
|
||||
"description": "The size of each link item / icon"
|
||||
}
|
||||
```
|
||||
|
||||
Next, if you're property should have a default value, then add it to [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js). This ensures that nothing will break if the user does not use your property, and having all defaults together keeps things organised and easy to manage.
|
||||
|
||||
If your property needs additional logic for fetching, setting or processing, then you can add a helper function within [`ConfigHelpers.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigHelpers.js).
|
||||
|
||||
Finally, add your new property to the [`configuring.md`](./configuring.md) API docs. Put it under the relevant section, and be sure to include field name, data type, a description and mention that it is optional. If your new feature needs more explaining, then you can also document it under the relevant section elsewhere in the documentation.
|
||||
|
||||
Checklist:
|
||||
- [ ] Ensure the new attribute is actually necessary, and nothing similar already exists
|
||||
- [ ] Update the [Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js) with the parameters for your new option
|
||||
- [ ] Set a default value (if required) within [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js)
|
||||
- [ ] Document the new value in [`configuring.md`](./configuring.md)
|
||||
- [ ] Test that the reading of the new attribute is properly handled, and will not cause any errors when it is missing or populated with an unexpected value
|
||||
|
||||
---
|
||||
|
||||
## Updating Dependencies
|
||||
|
||||
Running `yarn upgrade` will updated all dependencies based on the ranges specified in the `package.json`. The `yarn.lock` file will be updated, as will the contents of `./node_modules`, for more info, see the [yarn upgrade documentation](https://classic.yarnpkg.com/en/docs/cli/upgrade/). It is important to thoroughly test after any big dependency updates.
|
||||
|
||||
---
|
||||
|
||||
## Developing Netlify Cloud Functions
|
||||
|
||||
When Dashy is deployed to Netlify, it is effectively running as a static app, and therefore the server-side code for the Node.js endpoints is not available. However Netlify now supports serverless cloud lambda functions, which can be used to replace most functionality.
|
||||
|
||||
#### 1. Run Netlify Dev Server
|
||||
|
||||
First off, install the Netlify CLI: `npm install netlify-cli -g`
|
||||
Then, from within the root of Dashy's directory, start the server, by running: `netlify dev`
|
||||
|
||||
#### 2. Create a lambda function
|
||||
|
||||
This should be saved it in the [`./services/serverless-functions`](https://github.com/Lissy93/dashy/tree/master/services/serverless-functions) directory
|
||||
|
||||
```javascript
|
||||
exports.handler = async () => ({
|
||||
statusCode: 200,
|
||||
body: 'Return some data here...',
|
||||
});
|
||||
```
|
||||
|
||||
#### 3. Redirect the Node endpoint to the function
|
||||
|
||||
In the [`netlify.toml`](https://github.com/Lissy93/dashy/blob/FEATURE/serverless-functions/netlify.toml) file, add a 301 redirect, with the path to the original Node.js endpoint, and the name of your cloud function
|
||||
|
||||
```toml
|
||||
[[redirects]]
|
||||
from = "/status-check"
|
||||
to = "/.netlify/functions/cloud-status-check"
|
||||
status = 301
|
||||
force = true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Hiding Page Furniture on Certain Routes
|
||||
For some pages (such as the login page, the minimal start page, etc) the basic page furniture, (like header, footer, nav, etc) is not needed. This section explains how you can hide furniture on a new view (step 1), or add a component that should be hidden on certain views (step 2).
|
||||
|
||||
##### 1. Add the route name to the should hide array
|
||||
|
||||
In [`./src/utils/defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js), there's an array called `hideFurnitureOn`. Append the name of the route (the same as it appears in [`router.js`](https://github.com/Lissy93/dashy/blob/master/src/router.js)) here.
|
||||
|
||||
##### 2. Add the conditional to the structural component to hide
|
||||
|
||||
First, import the helper function:
|
||||
```javascript
|
||||
import { shouldBeVisible } from '@/utils/MiscHelpers';
|
||||
```
|
||||
|
||||
Then you can create a computed value, that calls this function, passing in the route name:
|
||||
```javascript
|
||||
export default {
|
||||
...
|
||||
computed: {
|
||||
...
|
||||
isVisible() {
|
||||
return shouldBeVisible(this.$route.name);
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
Finally, in the markup of your component, just add a `v-if` statement, referencing your computed value
|
||||
```vue
|
||||
<header v-if="isVisible">
|
||||
...
|
||||
</header>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Adding / Using Environmental Variables
|
||||
All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under `appConfig` in the `conf.yml` file.
|
||||
|
||||
You can set variables either in your environment, or using the [`.env`](https://github.com/Lissy93/dashy/blob/master/.env) file.
|
||||
|
||||
Any environmental variables used by the frontend are preceded with `VUE_APP_`. Vue will merge the contents of your `.env` file into the app in a similar way to the ['dotenv'](https://github.com/motdotla/dotenv) package, where any variables that you set on your system will always take preference over the contents of any `.env` file.
|
||||
|
||||
If add any new variables, ensure that there is always a fallback (define it in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js)), so as to not cause breaking changes. Don't commit the contents of your `.env` file to git, but instead take a few moments to document what you've added under the appropriate section. Try and follow the concepts outlined in the [12 factor app](https://12factor.net/config).
|
||||
# Development Guides
|
||||
|
||||
A series of short tutorials, to guide you through the most common development tasks.
|
||||
|
||||
Sections:
|
||||
|
||||
- [Creating a new theme](#creating-a-new-theme)
|
||||
- [Writing Translations](#writing-translations)
|
||||
- [Adding a new option in the config file](#adding-a-new-option-in-the-config-file)
|
||||
- [Updating Dependencies](#updating-dependencies)
|
||||
- [Writing Netlify Cloud Functions](#developing-netlify-cloud-functions)
|
||||
- [Hiding Page Furniture](#hiding-page-furniture-on-certain-routes)
|
||||
- [Adding / Using Environmental Variables](#adding--using-environmental-variables)
|
||||
- [Building a Widget](#building-a-widget)
|
||||
- [Respecting Config Permissions](#respecting-config-permissions)
|
||||
|
||||
## Creating a new theme
|
||||
|
||||
Adding a new theme is really easy. There're two things you need to do: Pass the theme name to Dashy, so that it can be added to the theme selector dropdown menu, and then write some styles!
|
||||
|
||||
### 1. Add Theme Name
|
||||
|
||||
Choose a snappy name for your theme, and add it to the `builtInThemes` array inside [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L27).
|
||||
|
||||
### 2. Write some Styles
|
||||
|
||||
Put your theme styles inside [`color-themes.scss`](https://github.com/Lissy93/dashy/blob/master/src/styles/color-themes.scss).
|
||||
Create a new block, and make sure that `data-theme` matches the theme name you chose above. For example:
|
||||
|
||||
```css
|
||||
html[data-theme='tiger'] {
|
||||
--primary: #f58233;
|
||||
--background: #0b1021;
|
||||
}
|
||||
```
|
||||
|
||||
Then you can go ahead and write your own custom CSS. Although all CSS is supported here, the best way to define your theme is by setting the CSS variables. You can find a [list of all CSS variables, here](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#css-variables).
|
||||
|
||||
For a full guide on styling, see [Theming Docs](./theming.md).
|
||||
|
||||
Note that if your theme is just for yourself, and you're not submitting a PR, then you can instead just pass it under `appConfig.cssThemes` inside your config file. And then put your theme in your own stylesheet, and pass it into the Docker container - [see how](https://github.com/Lissy93/dashy/blob/master/docs/theming.md#adding-your-own-theme).
|
||||
|
||||
## Writing Translations
|
||||
|
||||
For full docs about Dashy's multi-language support, see [Multi-Language Support](./multi-language-support.md)
|
||||
|
||||
Dashy is using [vue-i18n](https://vue-i18n.intlify.dev/guide/) to manage multi-language support.
|
||||
|
||||
Adding a new language is pretty straightforward, with just three steps:
|
||||
|
||||
### 1. Create a new Language File
|
||||
|
||||
Create a new JSON file in `./src/assets/locales` name is a 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language, E.g. for German `de.json`, French `fr.json` or Spanish `es.json` - You can find a list of all ISO codes at [iso.org](https://www.iso.org/obp/ui).
|
||||
|
||||
### 2. Translate
|
||||
|
||||
Using [`en.json`](https://github.com/Lissy93/dashy/tree/master/src/assets/locales/en.json) as an example, translate the JSON values to your language, while leaving the keys as they are. It's fine to leave out certain items, as if they're missing they will fall-back to English. If you see any attribute which include curly braces (`{xxx}`), then leave the inner value of these braces as is, as this is for variables.
|
||||
|
||||
```json
|
||||
{
|
||||
"theme-maker": {
|
||||
"export-button": "Benutzerdefinierte Variablen exportieren",
|
||||
"reset-button": "Stile zurücksetzen für",
|
||||
"show-all-button": "Alle Variablen anzeigen",
|
||||
"save-button": "Speichern",
|
||||
"cancel-button": "Abbrechen",
|
||||
"saved-toast": "{theme} Erfolgreich aktualisiert",
|
||||
"reset-toast": "Benutzerdefinierte Farben für {theme} entfernt"
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Add your file to the app
|
||||
|
||||
In [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/tree/master/src/utils/languages.js), you need to do 2 small things:
|
||||
|
||||
First import your new translation file, do this at the top of the page.
|
||||
E.g. `import de from '@/assets/locales/de.json';`
|
||||
|
||||
Second, add it to the array of languages, e.g:
|
||||
|
||||
```javascript
|
||||
export const languages = [
|
||||
{
|
||||
name: 'English',
|
||||
code: 'en',
|
||||
locale: en,
|
||||
flag: '🇬🇧',
|
||||
},
|
||||
{
|
||||
name: 'German', // The name of your language
|
||||
code: 'de', // The ISO code of your language
|
||||
locale: de, // The name of the file you imported (no quotes)
|
||||
flag: '🇩🇪', // An optional flag emoji
|
||||
},
|
||||
];
|
||||
```
|
||||
|
||||
You can also add your new language to the readme file, under the [Language Switching](https://github.com/Lissy93/dashy#language-switching-) section, and optionally include your name/ username if you'd like to be credited for your work. Done!
|
||||
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
|
||||
## Adding a new option in the config file
|
||||
|
||||
This section is for, adding a new setting to the config file.
|
||||
|
||||
All of the users config is specified in `./user-data/conf.yml` - see [Configuring Docs](./configuring.md) for info.
|
||||
It's important to first ensure that there isn't a similar option already available, the new option is definitely necessary, and most importantly that it is fully backwards compatible.
|
||||
|
||||
Next choose the appropriate section to place it under
|
||||
|
||||
- Application settings should be located under `appConfig`
|
||||
- Page info (such as text and metadata) should be under `pageInfo`
|
||||
- Data relating to specific sections should be under `section[n].displayData`
|
||||
- Settings applied to specific items or widgets, should be under `item[n]` or `widget[n]`
|
||||
|
||||
For example, if your option is added under `appConfig`, you can access it within your component using the `$store`, this is typically placed in a computed property, e.g:
|
||||
|
||||
```javascript
|
||||
computed: {
|
||||
appConfig() {
|
||||
return this.$store.getters.appConfig;
|
||||
},
|
||||
...
|
||||
},
|
||||
```
|
||||
|
||||
Then, where you want to get the users value within your component, use something like: `this.appConfig.myProperty`. If the user hasn't specified the value, Don't forget to have a fallback or default for it.
|
||||
|
||||
If you have a default fallback value, then this would typically be specified in the [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js) file.
|
||||
|
||||
You will now need to add the definition of your new attribute into the [ConfigSchema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js). This will make it available in the UI config editor, and also ensure that the config validation check doesn't fail.
|
||||
For example:
|
||||
|
||||
```json
|
||||
"fontAwesomeKey": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-z0-9]{10}$",
|
||||
"description": "API key for font-awesome",
|
||||
"example": "0821c65656"
|
||||
}
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```json
|
||||
"iconSize": {
|
||||
"enum": [ "small", "medium", "large" ],
|
||||
"default": "medium",
|
||||
"description": "The size of each link item / icon"
|
||||
}
|
||||
```
|
||||
|
||||
Finally, add your new property to the [`configuring.md`](./configuring.md) API docs. Put it under the relevant section, and be sure to include field name, data type, a description and mention that it is optional. If your new feature needs more explanation, then you can also document it under the relevant section elsewhere in the documentation.
|
||||
|
||||
Checklist:
|
||||
|
||||
- [ ] Ensure the new attribute is actually necessary, and nothing similar already exists
|
||||
- [ ] Update the [Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js) with the parameters for your new option
|
||||
- [ ] If required, set a default or fallback value (usually in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js))
|
||||
- [ ] Document the new value in [`configuring.md`](./configuring.md), and if required under the relevant section in the docs
|
||||
- [ ] Ensure your changes are backwards compatible, and that nothing breaks if the attribute isn't specified
|
||||
|
||||
---
|
||||
|
||||
## Updating Dependencies
|
||||
|
||||
Running `yarn upgrade` will updated all dependencies based on the ranges specified in the `package.json`. The `yarn.lock` file will be updated, as will the contents of `./node_modules`, for more info, see the [yarn upgrade documentation](https://classic.yarnpkg.com/en/docs/cli/upgrade/). [`npm-check-updates`](https://github.com/raineorshine/npm-check-updates) is a useful tool to help with this.
|
||||
It is important to thoroughly test after any big dependency updates.
|
||||
|
||||
---
|
||||
|
||||
## Developing Netlify Cloud Functions
|
||||
|
||||
When Dashy is deployed to Netlify, it is effectively running as a static app, and therefore the server-side code for the Node.js endpoints is not available. However Netlify now supports serverless cloud lambda functions, which can be used to replace most functionality.
|
||||
|
||||
### 1. Run Netlify Dev Server
|
||||
|
||||
First off all, install the Netlify CLI: `npm install netlify-cli -g`
|
||||
Then, from within the root of Dashy's directory, start the server, by running: `netlify dev`
|
||||
|
||||
### 2. Create a lambda function
|
||||
|
||||
This should be saved in the [`./services/serverless-functions`](https://github.com/Lissy93/dashy/tree/master/services/serverless-functions) directory
|
||||
|
||||
```javascript
|
||||
exports.handler = async () => ({
|
||||
statusCode: 200,
|
||||
body: 'Return some data here...',
|
||||
});
|
||||
```
|
||||
|
||||
### 3. Redirect the Node endpoint to the function
|
||||
|
||||
In the [`netlify.toml`](https://github.com/Lissy93/dashy/blob/FEATURE/serverless-functions/netlify.toml) file, add a 301 redirect, with the path to the original Node.js endpoint, and the name of your cloud function
|
||||
|
||||
```toml
|
||||
[[redirects]]
|
||||
from = "/status-check"
|
||||
to = "/.netlify/functions/cloud-status-check"
|
||||
status = 301
|
||||
force = true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Hiding Page Furniture on Certain Routes
|
||||
|
||||
For some pages (such as the login page, the minimal start page, etc) the basic page furniture, (like header, footer, nav, etc) is not needed. This section explains how you can hide furniture on a new view (step 1), or add a component that should be hidden on certain views (step 2).
|
||||
|
||||
### 1. Add the route name to the should hide array
|
||||
|
||||
In [`./src/utils/defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js), there's an array called `hideFurnitureOn`. Append the name of the route (the same as it appears in [`router.js`](https://github.com/Lissy93/dashy/blob/master/src/router.js)) here.
|
||||
|
||||
### 2. Add the conditional to the structural component to hide
|
||||
|
||||
First, import the helper function:
|
||||
|
||||
```javascript
|
||||
import { shouldBeVisible } from '@/utils/SectionHelpers';
|
||||
```
|
||||
|
||||
Then you can create a computed value, that calls this function, passing in the route name:
|
||||
|
||||
```javascript
|
||||
export default {
|
||||
...
|
||||
computed: {
|
||||
...
|
||||
isVisible() {
|
||||
return shouldBeVisible(this.$route.name);
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
Finally, in the markup of your component, just add a `v-if` statement, referencing your computed value
|
||||
|
||||
```vue
|
||||
<header v-if="isVisible">
|
||||
...
|
||||
</header>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Adding / Using Environmental Variables
|
||||
|
||||
All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under `appConfig` in the `conf.yml` file.
|
||||
|
||||
You can set variables either in your environment, or using the [`.env`](https://github.com/Lissy93/dashy/blob/master/.env) file.
|
||||
|
||||
Any environmental variables used by the frontend are preceded with `VUE_APP_`. Vue will merge the contents of your `.env` file into the app in a similar way to the ['dotenv'](https://github.com/motdotla/dotenv) package, where any variables that you set on your system will always take preference over the contents of any `.env` file.
|
||||
|
||||
If add any new variables, ensure that there is always a fallback (define it in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js)), so as to not cause breaking changes. Don't commit the contents of your `.env` file to git, but instead take a few moments to document what you've added under the appropriate section. Try and follow the concepts outlined in the [12 factor app](https://12factor.net/config).
|
||||
|
||||
---
|
||||
|
||||
## Building a Widget
|
||||
|
||||
### Step 0 - Prerequisites
|
||||
|
||||
If this is your first time working on Dashy, then the [Developing Docs](https://github.com/Lissy93/dashy/blob/master/docs/developing.md) instructions for project setup and running. In short, you just need to clone the project, cd into it, install dependencies (`yarn`) and then start the development server (`yarn dev`).
|
||||
|
||||
To build a widget, you'll also need some basic knowledge of Vue.js. The [official Vue docs](https://vuejs.org/v2/guide/) provides a good starting point, as does [this guide](https://www.taniarascia.com/getting-started-with-vue/) by Tania Rascia
|
||||
|
||||
If you just want to jump straight in, then [here](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e) is a complete implementation of a new example widget, or take a look at the [`XkcdComic.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/XkcdComic.vue) widget, which is pretty simple.
|
||||
|
||||
### Step 1 - Create Widget
|
||||
|
||||
Firstly, create a new `.vue` file under [`./src/components/Widgets`](https://github.com/Lissy93/dashy/tree/master/src/components/Widgets).
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<div class="example-wrapper">
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
|
||||
import axios from 'axios';
|
||||
import WidgetMixin from '@/mixins/WidgetMixin';
|
||||
import { widgetApiEndpoints } from '@/utils/defaults';
|
||||
|
||||
export default {
|
||||
mixins: [WidgetMixin],
|
||||
data() {
|
||||
return {
|
||||
results: null,
|
||||
};
|
||||
},
|
||||
computed: {
|
||||
endpoint() {
|
||||
return `${widgetApiEndpoints.myApi}/something`;
|
||||
},
|
||||
},
|
||||
methods: {
|
||||
fetchData() {
|
||||
this.makeRequest(this.endpoint).then(this.processData);
|
||||
},
|
||||
processData(data) {
|
||||
// Do processing any here, and set component data
|
||||
this.results = data;
|
||||
},
|
||||
},
|
||||
};
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
</style>
|
||||
```
|
||||
|
||||
All widgets extend from the [Widget](https://github.com/Lissy93/dashy/blob/master/src/mixins/WidgetMixin.js) mixin. This provides some basic functionality that is shared by all widgets. The mixin includes the following `options`, `startLoading()`, `finishLoading()`, `error()` and `update()`.
|
||||
|
||||
- **Getting user options: `options`**
|
||||
- Any user-specific config can be accessed with `this.options.something` (where something is the data key you're accessing)
|
||||
- **Loading state: `startLoading()` and `finishLoading()`**
|
||||
- You can show the loader with `this.startLoading()`, then when your data request completes, hide it again with `this.finishLoading()`
|
||||
- **Error handling: `error()`**
|
||||
- If something goes wrong (such as API error, or missing user parameters), then call `this.error()` to show message to user
|
||||
- **Updating data: `update()`**
|
||||
- When the user clicks the update button, or if continuous updates are enabled, then the `update()` method within your widget will be called
|
||||
|
||||
### Step 2 - Adding Functionality
|
||||
|
||||
#### **Accessing User Options**
|
||||
|
||||
If your widget is going to accept any parameters from the user, then we can access these with `this.options.[parmName]`. It's best to put these as computed properties, which will enable us to check it exists, is valid, and if needed format it. For example, if we have an optional property called `count` (to determine number of results), we can do the following, and then reference it within our component with `this.count`
|
||||
|
||||
```javascript
|
||||
computed: {
|
||||
count() {
|
||||
if (!this.options.count) {
|
||||
return 5;
|
||||
}
|
||||
return this.options.count;
|
||||
},
|
||||
...
|
||||
},
|
||||
```
|
||||
|
||||
#### **Adding an API Endpoint**
|
||||
|
||||
If your widget makes a data request, then add the URL for the API endpoint to the `widgetApiEndpoints` array in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L207)
|
||||
|
||||
```javascript
|
||||
widgetApiEndpoints: {
|
||||
...
|
||||
exampleEndpoint: 'https://hub.dummyapis.com/ImagesList',
|
||||
},
|
||||
```
|
||||
|
||||
Then in your widget file:
|
||||
|
||||
```javascript
|
||||
import { widgetApiEndpoints } from '@/utils/defaults';
|
||||
```
|
||||
|
||||
For GET requests, you may need to add some parameters onto the end of the URL. We can use another computed property for this, for example:
|
||||
|
||||
```javascript
|
||||
endpoint() {
|
||||
return `${widgetApiEndpoints.exampleEndpoint}?count=${this.count}`;
|
||||
},
|
||||
```
|
||||
|
||||
#### **Making an API Request**
|
||||
|
||||
Axios is used for making data requests, so import it into your component: `import axios from 'axios';`
|
||||
|
||||
Under the `methods` block, we'll create a function called `fetchData`, here we can use Axios to make a call to our endpoint.
|
||||
|
||||
```javascript
|
||||
fetchData() {
|
||||
this.makeRequest(this.endpoint, this.headers).then(this.processData);
|
||||
},
|
||||
```
|
||||
|
||||
There are three things happening here:
|
||||
|
||||
- If the response completes successfully, we'll pass the results to another function that will handle them
|
||||
- If there's an error, then we call `this.error()`, which will show a message to the user
|
||||
- Whatever the result, once the request has completed, we call `this.finishLoading()`, which will hide the loader
|
||||
|
||||
#### **Processing Response**
|
||||
|
||||
In the above example, we call the `processData()` method with the result from the API, so we need to create that under the `methods` section. How you handle this data will vary depending on what's returned by the API, and what you want to render to the user. But however you do it, you will likely need to create a data variable to store the response, so that it can be easily displayed in the HTML.
|
||||
|
||||
```javascript
|
||||
data() {
|
||||
return {
|
||||
myResults: null,
|
||||
};
|
||||
},
|
||||
```
|
||||
|
||||
And then, inside your `processData()` method, you can set the value of this, with:
|
||||
|
||||
```javascript
|
||||
`this.myResults = 'whatever'`
|
||||
```
|
||||
|
||||
#### **Rendering Response**
|
||||
|
||||
Now that the results are in the correct format, and stored as data variables, we can use them within the `<template>` to render results to the user. Again, how you do this will depend on the structure of your data, and what you want to display, but at it's simplest, it might look something like this:
|
||||
|
||||
```vue
|
||||
<p class="results">{{ myResults }}</p>
|
||||
```
|
||||
|
||||
#### **Styling**
|
||||
|
||||
Styles can be written for your widget within the `<style>` block.
|
||||
|
||||
There are several color variables used by widgets, which extend from the base palette. Using these enables users to override colors to theme their dashboard, if they wish. The variables are: `--widget-text-color`, `--widget-background-color` and `--widget-accent-color`
|
||||
|
||||
```vue
|
||||
<style scoped lang="scss">
|
||||
p.results {
|
||||
color: var(--widget-text-color);
|
||||
}
|
||||
</style>
|
||||
```
|
||||
|
||||
For examples of finished widget components, see the [Widgets](https://github.com/Lissy93/dashy/tree/master/src/components/Widgets) directory. Specifically, the [`XkcdComic.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/XkcdComic.vue) widget is quite minimal, so would make a good example, as will [this example implementation](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e).
|
||||
|
||||
### Step 3 - Register
|
||||
|
||||
Next, register your new widget in [`WidgetBase.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Widgets/WidgetBase.vue). In this file, you'll need to add the following:
|
||||
|
||||
```javascript
|
||||
const COMPAT = {
|
||||
...
|
||||
'example-widget': 'ExampleWidget',
|
||||
};
|
||||
```
|
||||
|
||||
Here, the `example-widget` property name will be used to identify the widget when parsing the `type` property in a configuration file. The `ExampleWidget` string is used to dynamically import the widget, and therefore must match the widget's filename as it exists in the `components/widgets` folder.
|
||||
|
||||
### Step 4 - Docs
|
||||
|
||||
Finally, add some documentation for your widget in the [Widget Docs](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md), so that others know how to use it. Include the following information: Title, short description, screenshot, config options and some example YAML.
|
||||
|
||||
**Summary**: For a complete example of everything discussed here, see: [`3da76ce`](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e)
|
||||
|
||||
---
|
||||
|
||||
## Respecting Config Permissions
|
||||
|
||||
Any screen that displays part or all of the users config, must not be shown when the user has disabled viewing config.
|
||||
|
||||
This can be done by checking the `allowViewConfig` attribute of the `permissions` getter, in the store.
|
||||
First create a new `computed` property, like:
|
||||
|
||||
```javascript
|
||||
allowViewConfig() {
|
||||
return this.$store.getters.permissions.allowViewConfig;
|
||||
},
|
||||
```
|
||||
|
||||
Then wrap the part of your UI which displays config with: `v-if="allowViewConfig"`
|
||||
|
||||
If required, add a message showing that the component isn't available, using the `AccessError` component. E.g.
|
||||
|
||||
```javascript
|
||||
import AccessError from '@/components/Configuration/AccessError';
|
||||
```
|
||||
|
||||
```vue
|
||||
<AccessError v-else />
|
||||
```
|
||||
|
||||
The `$store.getters.permissions` object also returns options for when and where config can be saved, using: `allowWriteToDisk`, and `allowSaveLocally` - both are booleans.
|
||||
|
|
400
docs/icons.md
|
@ -1,190 +1,210 @@
|
|||
# Icons
|
||||
|
||||
Both sections and items can have an icon, which is specified using the `icon` attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here.
|
||||
|
||||
- [Auto-Fetched Favicons](#favicons)
|
||||
- [Font Awesome Icons](#font-awesome)
|
||||
- [Simple Icons](#simple-icons)
|
||||
- [Generative Icons](#generative-icons)
|
||||
- [Emoji Icons](#emoji-icons)
|
||||
- [Home-Lab Icons](#home-lab-icons)
|
||||
- [Material Icons](#material-design-icons)
|
||||
- [Icons by URL](#icons-by-url)
|
||||
- [Local Icons](#local-icons)
|
||||
- [No Icon](#no-icon)
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/GTVmZnc/dashy-example-icons.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Favicons
|
||||
Dashy can auto-fetch an icon for a given service, using it's favicon. Just set `icon: favicon` to use this feature.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/k6wyhnB/favicon-icons.png" />
|
||||
</p>
|
||||
|
||||
Since different websites host their favicons at different paths, for the best results Dashy can use an API to resolve a websites icon.
|
||||
|
||||
The default favicon API is [allesedv.com](https://favicon.allesedv.com/), but you can change this under `appConfig.faviconApi`. If you'd prefer not to use an API, just set this value to `local`. You can also use different APIs for individual items, by setting `icon: favicon-[api]`, e.g. `favicon-clearbit`.
|
||||
|
||||
The following favicon APIs are supported:
|
||||
- `allesedv` - [allesedv.com](https://favicon.allesedv.com/) is a highly efficient IPv6-enabled service
|
||||
- `clearbit` - [Clearbit](https://clearbit.com/logo) returns high-quality square logos from mainstream websites
|
||||
- `faviconkit` - [faviconkit.com](https://faviconkit.com/) good quality icons and most sites supported (Note: down as of Nov '21)
|
||||
- `besticon` - [BestIcon](https://github.com/mat/besticon) fetches websites icons from manifest
|
||||
- `mcapi` - [MC-API](https://eu.mc-api.net/) fetches default website favicon, originally a Minecraft util
|
||||
- `duckduckgo` - Returns decent quality website icons, from DuckDuckGo search
|
||||
- `google` - Official Google favicon API service, good support for all sites, but poor quality
|
||||
- `yandex` - Lower quality icons, but useful in some regions where other services are blocked
|
||||
- `local` - Set to local to fetch the default icon at /favicon.ico instead of using an API
|
||||
|
||||
If for a given service none of the APIs work in your situation, and nor does local, then the best option is to find the path of the services logo or favicon, and set the icon to the URL of the raw image. For example, `icon: https://monitoring.local/faviconx128.png`- you can find this path using the browser dev tools.
|
||||
|
||||
---
|
||||
|
||||
## Font Awesome
|
||||
You can use any [Font Awesome Icon](https://fontawesome.com/icons) simply by specifying it's identifier. This is in the format of `[category] [name]` and can be found on the page for that icon on the Font Awesome site. For example: `fas fa-rocket`, `fab fa-monero` or `fas fa-unicorn`.
|
||||
|
||||
Font-Awesome has a wide variety of free icons, but you can also use their pro icons if you have a membership. To do so, you need to specify your license key under: `appConfig.fontAwesomeKey`. This is usually a 10-digit string, for example `13014ae648`.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/tMtwNYZ/fontawesome-icons3.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Simple Icons
|
||||
[SimpleIcons.org](https://simpleicons.org/) is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the [website](https://simpleicons.org/), then just set your icon the the simple icon slug, prefixed with `si-`.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/MVhkXfC/simple-icons-example.png" />
|
||||
</p>
|
||||
|
||||
For example:
|
||||
```yaml
|
||||
sections:
|
||||
- name: Simple Icons Example
|
||||
items:
|
||||
- title: Portainer
|
||||
icon: si-portainer
|
||||
- title: FreeNAS
|
||||
icon: si-freenas
|
||||
- title: NextCloud
|
||||
icon: si-nextcloud
|
||||
- title: Home Assistant
|
||||
icon: si-homeassistant
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Generative Icons
|
||||
To uses a unique and programmatically generated icon for a given service just set `icon: generative`. This is particularly useful when you have a lot of similar services with a different IP or port, and no specific icon. These icons are generated with [DiceBear](https://avatars.dicebear.com/) (or [Evatar](https://evatar.io/) for fallback), and use a hash of the services domain/ ip for entropy, so each domain will have a unique icon.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/b2pC2CL/generative-icons-2.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Emoji Icons
|
||||
You can use almost any emoji as an icon for items or sections. You can specify the emoji either by pasting it directly, using it's unicode ( e.g. `'U+1F680'`) or shortcode (e.g. `':rocket:'`). You can find these codes for any emoji using [Emojipedia](https://emojipedia.org/) (near the bottom of emoji each page), or for a quick reference to emoji shortcodes, check out [emojis.ninja](https://emojis.ninja/) by @nomanoff.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/YLwgTf9/emoji-icons-1.png" />
|
||||
</p>
|
||||
|
||||
For example, these will all render the same rocket (🚀) emoji: `icon: ':rocket:'` or `icon: 'U+1F680'` or `icon: 🚀`
|
||||
|
||||
---
|
||||
|
||||
## Home-Lab Icons
|
||||
|
||||
The [dashboard-icons](https://github.com/WalkxCode/dashboard-icons) repo by [@WalkxCode](https://github.com/WalkxCode) provides a comprehensive collection of 360+ high-quality PNG icons for commonly self-hosted services. Dashy natively supports these icons, and you can use them just by specifying the icon name (without extension) preceded by `hl-`. See [here](https://github.com/WalkxCode/dashboard-icons/tree/master/png) for a full list of all available icons. Note that these are fetched and cached strait from GitHub, so if you require offline access, the [Local Icons](#local-icons) method may be a better option for you.
|
||||
|
||||
For example:
|
||||
```yaml
|
||||
sections:
|
||||
- name: Home Lab Icons Example
|
||||
items:
|
||||
- title: AdGuard Home
|
||||
icon: hl-adguardhome
|
||||
- title: Long Horn
|
||||
icon: hl-longhorn
|
||||
- title: Nagios
|
||||
icon: hl-nagios
|
||||
- title: Whoogle Search
|
||||
icon: hl-whooglesearch
|
||||
```
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/PQzYHmD/homelab-icons-2.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Material Design Icons
|
||||
Dashy also supports 5000+ [material-design-icons](https://github.com/Templarian/MaterialDesign). To use these, first find the name/ slug for your icon [here](https://dev.materialdesignicons.com/icons), and then prefix is with `mdi-`.
|
||||
|
||||
For example:
|
||||
```yaml
|
||||
sections:
|
||||
- name: Material Design Icons Example
|
||||
items:
|
||||
- title: Alien Icon
|
||||
icon: mdi-alien
|
||||
- title: Fire Icon
|
||||
icon: mdi-fire
|
||||
- title: Dino Icon
|
||||
icon: mdi-google-downasaur
|
||||
```
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/fC9B4mq/icons-mdi-example.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Icons by URL
|
||||
You can also set an icon by passing in a valid URL pointing to the icons location. For example `icon: https://i.ibb.co/710B3Yc/space-invader-x256.png`, this can be in .png, .jpg or .svg format, and hosted anywhere (local or remote) - so long as it's accessible from where you are hosting Dashy. The icon will be automatically scaled to fit, however loading in a lot of large icons may have a negative impact on performance, especially if you visit Dashy from new devices often.
|
||||
|
||||
---
|
||||
|
||||
## Local Icons
|
||||
You may also want to store your icons locally, bundled within Dashy so that there is no reliance on outside services. This can be done by putting the icons within Dashy's `./public/item-icons/` directory. If you are using Docker, then the easiest option is to map a volume from your host system, for example: `-v /local/image/directory:/app/public/item-icons/`. To reference an icon stored locally, just specify it's name and extension. For example, if my icon was stored in `/app/public/item-icons/maltrail.png`, then I would just set `icon: maltrail.png`.
|
||||
|
||||
You can also use sub-folders within the `item-icons` directory to keep things organized. You would then specify an icon with it's folder name slash image name. For example: `networking/monit.png`
|
||||
|
||||
---
|
||||
|
||||
## No Icon
|
||||
If you don't wish for a given item or section to have an icon, just leave out the `icon` attribute.
|
||||
|
||||
---
|
||||
|
||||
## Icon Collections and Resources
|
||||
|
||||
The following websites provide good-quality, free icon sets. To use any of these icons, either copy the link to the raw icon (it should end in `.svg` or `.png`) and paste it as your `icon`, or download and save the icons in `/public/item-icons` / mapped Docker volume. Full credit to the authors, please see the licenses for each service for usage and copyright information.
|
||||
|
||||
- [Icons for Self-Hosted Apps](https://thehomelab.wiki/books/helpful-tools-resources/page/icons-for-self-hosted-dashboards) - 350+ high-quality icons for commonly self-hosted services
|
||||
- [SVG Box](https://svgbox.net/iconsets/) - Cryptocurrency, social media apps and flag icons
|
||||
- [Simple Icons](https://simpleicons.org/) - Free SVG brand icons, with easy API access
|
||||
- [Material Design Icons](https://github.com/google/material-design-icons/) - Hundreds of Open source PNG + SVG icons by Google
|
||||
- [Icons8](https://icons8.com/icons) - Thousands of icons, all with free versions at 64x64
|
||||
- [Flat Icon](https://www.flaticon.com/) - Wide variety of icon sets, most of which are free to use
|
||||
- [SVG Repo](https://www.svgrepo.com/) - 300,000+ Vector Icons
|
||||
|
||||
If you are a student, then you can get free access to premium icons on [Icon Scout](https://education.github.com/pack/redeem/iconscout-student) or [Icons8](https://icons8.com/github-students) using the [GitHub Student Pack](https://education.github.com/pack).
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
If you are using icons from an external source, these will be fetched on initial page load automatically, if and when needed. But combining icons from multiple services may have a negative impact on performance.
|
||||
|
||||
You can improve load speeds, by downloading your required icons, and serving them locally. Scaling icons to the minimum required dimensions (e.g. 128x128 or 64x64) will also greatly improve application load times.
|
||||
|
||||
For icons from external sources, please see the Privacy Policies and Licenses for that provider.
|
||||
# Icons
|
||||
|
||||
Both sections and items can have an icon, which is specified using the `icon` attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. Dashy supports multiple different icon providers, usage instructions for which are explained here.
|
||||
|
||||
- [Auto-Fetched Favicons](#favicons)
|
||||
- [Font Awesome Icons](#font-awesome)
|
||||
- [Simple Icons](#simple-icons)
|
||||
- [Generative Icons](#generative-icons)
|
||||
- [Emoji Icons](#emoji-icons)
|
||||
- [Home-Lab Icons](#home-lab-icons)
|
||||
- [Material Icons](#material-design-icons)
|
||||
- [Icons by URL](#icons-by-url)
|
||||
- [Local Icons](#local-icons)
|
||||
- [Using a Default Icon](#default-icon)
|
||||
- [No Icon](#no-icon)
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/GTVmZnc/dashy-example-icons.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Favicons
|
||||
|
||||
Dashy can auto-fetch an icon for a given service, using it's favicon. Just set `icon: favicon` to use this feature.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/k6wyhnB/favicon-icons.png" />
|
||||
</p>
|
||||
|
||||
Since different websites host their favicons at different paths, for the best results Dashy can use an API to resolve a websites icon.
|
||||
|
||||
The default favicon API is [allesedv.com](https://favicon.allesedv.com/), but you can change this under `appConfig.faviconApi`. If you'd prefer not to use an API, just set this value to `local`. You can also use different APIs for individual items, by setting `icon: favicon-[api]`, e.g. `favicon-clearbit`.
|
||||
|
||||
The following favicon APIs are supported:
|
||||
|
||||
- `allesedv` - [allesedv.com](https://favicon.allesedv.com/) is a highly efficient IPv6-enabled service
|
||||
- `iconhorse` - [Icon.Horse](https://icon.horse/) returns quality icons for any site, with caching for speed and fallbacks for sites without an icon
|
||||
- `clearbit` - [Clearbit](https://clearbit.com/logo) returns high-quality square logos from mainstream websites
|
||||
- `faviconkit` - [faviconkit.com](https://faviconkit.com/) good quality icons and most sites supported (Note: down as of Nov '21)
|
||||
- `besticon` - [BestIcon](https://github.com/mat/besticon) fetches websites icons from manifest
|
||||
- `mcapi` - [MC-API](https://eu.mc-api.net/) fetches default website favicon, originally a Minecraft util
|
||||
- `duckduckgo` - Returns decent quality website icons, from DuckDuckGo search
|
||||
- `google` - Official Google favicon API service, good support for all sites, but poor quality
|
||||
- `yandex` - Lower quality icons, but useful in some regions where other services are blocked
|
||||
- `local` - Set to local to fetch the default icon at /favicon.ico instead of using an API
|
||||
|
||||
If for a given service none of the APIs work in your situation, and nor does local, then the best option is to find the path of the services logo or favicon, and set the icon to the URL of the raw image. For example, `icon: https://monitoring.local/faviconx128.png`- you can find this path using the browser dev tools.
|
||||
|
||||
---
|
||||
|
||||
## Font Awesome
|
||||
|
||||
You can use any [Font Awesome Icon](https://fontawesome.com/icons) simply by specifying it's identifier. This is in the format of `[category] [name]` and can be found on the page for that icon on the Font Awesome site. For example: `fas fa-rocket`, `fab fa-monero` or `fas fa-unicorn`.
|
||||
|
||||
Font-Awesome has a wide variety of free icons, but you can also use their pro icons if you have a membership. To do so, you need to specify your license key under: `appConfig.fontAwesomeKey`. This is usually a 10-digit string, for example `13014ae648`.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/tMtwNYZ/fontawesome-icons3.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Simple Icons
|
||||
|
||||
[SimpleIcons.org](https://simpleicons.org/) is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the [website](https://simpleicons.org/), then just set your icon the the simple icon slug, prefixed with `si-`.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/MVhkXfC/simple-icons-example.png" />
|
||||
</p>
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
sections:
|
||||
- name: Simple Icons Example
|
||||
items:
|
||||
- title: Portainer
|
||||
icon: si-portainer
|
||||
- title: FreeNAS
|
||||
icon: si-freenas
|
||||
- title: NextCloud
|
||||
icon: si-nextcloud
|
||||
- title: Home Assistant
|
||||
icon: si-homeassistant
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Generative Icons
|
||||
|
||||
To uses a unique and programmatically generated icon for a given service just set `icon: generative`. This is particularly useful when you have a lot of similar services with a different IP or port, and no specific icon. These icons are generated with [DiceBear](https://api.dicebear.com/) (or [Evatar](https://evatar.io/) for fallback), and use a hash of the services domain/ ip for entropy, so each domain will have a unique icon.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/b2pC2CL/generative-icons-2.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Emoji Icons
|
||||
|
||||
You can use almost any emoji as an icon for items or sections. You can specify the emoji either by pasting it directly, using it's unicode ( e.g. `'U+1F680'`) or shortcode (e.g. `':rocket:'`). You can find these codes for any emoji using [Emojipedia](https://emojipedia.org/) (near the bottom of emoji each page), or for a quick reference to emoji shortcodes, check out [emojis.ninja](https://emojis.ninja/) by @nomanoff.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/YLwgTf9/emoji-icons-1.png" />
|
||||
</p>
|
||||
|
||||
For example, these will all render the same rocket (🚀) emoji: `icon: ':rocket:'` or `icon: 'U+1F680'` or `icon: 🚀`
|
||||
|
||||
---
|
||||
|
||||
## Home-Lab Icons
|
||||
|
||||
The [dashboard-icons](https://github.com/walkxcode/Dashboard-Icons) repo by [@WalkxCode](https://github.com/WalkxCode) provides a comprehensive collection of 360+ high-quality PNG icons for commonly self-hosted services. Dashy natively supports these icons, and you can use them just by specifying the icon name (without extension) preceded by `hl-`. See [here](https://github.com/walkxcode/Dashboard-Icons/tree/main/png) for a full list of all available icons. Note that these are fetched and cached strait from GitHub, so if you require offline access, the [Local Icons](#local-icons) method may be a better option for you.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
sections:
|
||||
- name: Home Lab Icons Example
|
||||
items:
|
||||
- title: AdGuard Home
|
||||
icon: hl-adguardhome
|
||||
- title: Long Horn
|
||||
icon: hl-longhorn
|
||||
- title: Nagios
|
||||
icon: hl-nagios
|
||||
- title: Whoogle Search
|
||||
icon: hl-whooglesearch
|
||||
```
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/PQzYHmD/homelab-icons-2.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Material Design Icons
|
||||
|
||||
Dashy also supports 5000+ [material-design-icons](https://github.com/Templarian/MaterialDesign). To use these, first find the name/ slug for your icon [here](https://dev.materialdesignicons.com/icons), and then prefix is with `mdi-`.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
sections:
|
||||
- name: Material Design Icons Example
|
||||
items:
|
||||
- title: Alien Icon
|
||||
icon: mdi-alien
|
||||
- title: Fire Icon
|
||||
icon: mdi-fire
|
||||
- title: Dino Icon
|
||||
icon: mdi-google-downasaur
|
||||
```
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/fC9B4mq/icons-mdi-example.png" />
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Icons by URL
|
||||
|
||||
You can also set an icon by passing in a valid URL pointing to the icons location. For example `icon: https://i.ibb.co/710B3Yc/space-invader-x256.png`, this can be in .png, .jpg or .svg format, and hosted anywhere (local or remote) - so long as it's accessible from where you are hosting Dashy. The icon will be automatically scaled to fit, however loading in a lot of large icons may have a negative impact on performance, especially if you visit Dashy from new devices often.
|
||||
|
||||
---
|
||||
|
||||
## Local Icons
|
||||
|
||||
You may also want to store your icons locally, bundled within Dashy so that there is no reliance on outside services. This can be done by putting the icons within Dashy's `./user-data/item-icons/` directory. If you are using Docker, then the easiest option is to map a volume from your host system, for example: `-v /local/image/directory:/app/user-data/item-icons/`. To reference an icon stored locally, just specify it's name and extension. For example, if my icon was stored in `/app/user-data/item-icons/maltrail.png`, then I would just set `icon: maltrail.png`.
|
||||
|
||||
You can also use sub-folders within the `item-icons` directory to keep things organized. You would then specify an icon with it's folder name slash image name. For example: `networking/monit.png`
|
||||
|
||||
---
|
||||
|
||||
## Default Icon
|
||||
|
||||
If you'd like to set a default icon, to be applied to any items which don't have an icon already set, then this can be done under `appConfig.defaultIcon`.
|
||||
|
||||
---
|
||||
|
||||
## No Icon
|
||||
|
||||
If you don't wish for a given item or section to have an icon, just leave out the `icon` attribute.
|
||||
|
||||
---
|
||||
|
||||
## Icon Collections and Resources
|
||||
|
||||
The following websites provide good-quality, free icon sets. To use any of these icons, either copy the link to the raw icon (it should end in `.svg` or `.png`) and paste it as your `icon`, or download and save the icons in `/user-data/item-icons` / mapped Docker volume. Full credit to the authors, please see the licenses for each service for usage and copyright information.
|
||||
|
||||
- [Icons for Self-Hosted Apps](https://thehomelab.wiki/books/helpful-tools-resources/page/icons-for-self-hosted-dashboards) - 350+ high-quality icons for commonly self-hosted services
|
||||
- [SVG Box](https://svgbox.net/iconsets/) - Cryptocurrency, social media apps and flag icons
|
||||
- [Simple Icons](https://simpleicons.org/) - Free SVG brand icons, with easy API access
|
||||
- [Material Design Icons](https://github.com/google/material-design-icons/) - Hundreds of Open source PNG + SVG icons by Google
|
||||
- [Icons8](https://icons8.com/icons) - Thousands of icons, all with free versions at 64x64
|
||||
- [Flat Icon](https://www.flaticon.com/) - Wide variety of icon sets, most of which are free to use
|
||||
- [SVG Repo](https://www.svgrepo.com/) - 300,000+ Vector Icons
|
||||
|
||||
If you are a student, then you can get free access to premium icons on [Icon Scout](https://education.github.com/pack/redeem/iconscout-student) or [Icons8](https://icons8.com/github-students) using the [GitHub Student Pack](https://education.github.com/pack).
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
If you are using icons from an external source, these will be fetched on initial page load automatically, if and when needed. But combining icons from multiple services may have a negative impact on performance.
|
||||
|
||||
You can improve load speeds, by downloading your required icons, and serving them locally. Scaling icons to the minimum required dimensions (e.g. 128x128 or 64x64) will also greatly improve application load times.
|
||||
|
||||
For icons from external sources, please see the Privacy Policies and Licenses for that provider.
|
||||
|
|
1619
docs/management.md
|
@ -12,18 +12,20 @@ Internationalization is the process of making an application available in other
|
|||
|
||||
By default, Dashy will attempt to use the language of your browser or system. If a translation for your language does not yet exist, it will fallback to English.
|
||||
|
||||
#### In the UI
|
||||
### In the UI
|
||||
|
||||
You can manually select your language in the UI. Under the Config Menu, click the Language button, and select your language from the dropdown menu. Your preference will be saved in local storage.
|
||||
|
||||
#### Config File
|
||||
### Config File
|
||||
|
||||
You can also set your language in the config file. Specify the ISO code of one of the supported languages, under `appConfig.lang`. For example:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
lang: de
|
||||
language: de
|
||||
```
|
||||
|
||||
#### Available Languages
|
||||
### Available Languages
|
||||
|
||||
At the time of writing the following languages are supported: `en`, `zh-CN`, `nl`, `fr`, `de`, `es`, `sl`, `it`, `pt`, `ru`, `ar`, `hi`, `ja`, but an up-to-date list of all implemented translations can be found in [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/languages.js). Languages are specified by their 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), or sometimes a 4-digit code if it's a regional dialect.
|
||||
|
||||
|
@ -35,13 +37,15 @@ Dashy is using [vue-i18n](https://vue-i18n.intlify.dev/guide/) to manage multi-l
|
|||
|
||||
Adding a new language is pretty straightforward, with just three steps:
|
||||
|
||||
##### 1. Create a new Language File
|
||||
Create a new JSON file in `./src/assets/locales` for your language.
|
||||
### 1. Create a new Language File
|
||||
|
||||
Create a new JSON file in `./src/assets/locales` for your language.
|
||||
|
||||
You should name it with the 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your locale (e.g. for German `de.json`, French `fr.json` or Spanish `es.json`) - You can find a list of all ISO codes at [iso.org](https://www.iso.org/obp/ui).
|
||||
If your language is a specific dialect or regional translation, then use the Posfix [CLDR](http://cldr.unicode.org/) format, where, e.g. `en-GB.json` (British English), `es-MX.json` (Spanish, in Mexico) or `zh-CN.json` (Chinese, simplified) - A list of which can be found [here](https://github.com/unicode-org/cldr-json/blob/master/cldr-json/cldr-core/availableLocales.json)
|
||||
|
||||
##### 2. Translate!
|
||||
### 2. Translate
|
||||
|
||||
Using [`en.json`](https://github.com/Lissy93/dashy/tree/master/src/assets/locales/en.json) as an example, translate the JSON values to your language, while leaving the keys as they are. It's fine to leave out certain items, as if they're missing they will fall-back to English. If you see any attribute which include curly braces (`{xxx}`), then leave the inner value of these braces as is, as this is for variables.
|
||||
|
||||
```json
|
||||
|
@ -58,7 +62,7 @@ Using [`en.json`](https://github.com/Lissy93/dashy/tree/master/src/assets/locale
|
|||
}
|
||||
```
|
||||
|
||||
##### 3. Add your file to the app
|
||||
### 3. Add your file to the app
|
||||
|
||||
In [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/tree/master/src/utils/languages.js), you need to do 2 small things:
|
||||
|
||||
|
@ -66,6 +70,7 @@ First import your new translation file, do this at the top of the page.
|
|||
E.g. `import de from '@/assets/locales/de.json';`
|
||||
|
||||
Second, add it to the array of languages, e.g:
|
||||
|
||||
```javascript
|
||||
export const languages = [
|
||||
{
|
||||
|
@ -82,9 +87,10 @@ export const languages = [
|
|||
},
|
||||
];
|
||||
```
|
||||
|
||||
You can also add your new language to the readme, under the [Language Switching](https://github.com/Lissy93/dashy#language-switching-) section and optionally include your name/ username if you'd like to be credited for your work. Done!
|
||||
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
|
||||
---
|
||||
|
||||
|
@ -92,7 +98,7 @@ If you are not comfortable with making pull requests, or do not want to modify t
|
|||
|
||||
If you're working on a new component, then any text that is displayed to the user should be extracted out of the component, and stored in the file. This also applies to any existing components, that might have been forgotten to be translated. Thankfully, everything is already setup, so this is a pretty easy job.
|
||||
|
||||
#### 1. Add Translated Text
|
||||
### 1. Add Translated Text
|
||||
|
||||
Firstly, go to [`./src/assets/locales/en.json`](https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json), and either find the appropriate section, or create a new section. Lets say you're new component is called `my-widget`, you could add `"my-widget": {}` to store all your text as key-value-pairs. E.g.
|
||||
|
||||
|
@ -104,7 +110,7 @@ Firstly, go to [`./src/assets/locales/en.json`](https://github.com/Lissy93/dashy
|
|||
|
||||
Note that you **must** add English translations for all text. Missing languages are not a problem, as they will always fallback to English, but if the English is missing, then nothing can be displayed.
|
||||
|
||||
#### 2. Use Text within Component
|
||||
### 2. Use Text within Component
|
||||
|
||||
Once your text is in the translation file, you can now use it within your component. There is a global `$t` function, with takes the key of your new translation, and returns the value. For example:
|
||||
|
||||
|
@ -121,6 +127,7 @@ For example: `alert(this.$t('my-widget.awesome-text'))`.
|
|||
You may also need to pass a variable to be displayed within a translation. Vue I18n supports [Interpolations](https://vue-i18n.intlify.dev/guide/essentials/syntax.html#interpolations) using mustache-like syntax.
|
||||
|
||||
For example, you would set your translation to:
|
||||
|
||||
```json
|
||||
{
|
||||
"welcome-message": "Hello {name}!"
|
||||
|
@ -128,22 +135,25 @@ For example, you would set your translation to:
|
|||
```
|
||||
|
||||
And then pass that variable (`name`) within a JSON object as the second parameter on `$t`, like:
|
||||
|
||||
```javascript
|
||||
$t('welcome-message', { name: 'Alicia' })
|
||||
```
|
||||
|
||||
Which will render:
|
||||
|
||||
```text
|
||||
Hello Alicia!
|
||||
```
|
||||
|
||||
There are many other advanced features, including Pluralization, Datetime & Number Formatting, Message Support and more, all of which are outlined in the [Vue-i18n Docs](https://vue-i18n.intlify.dev/guide/).
|
||||
|
||||
#### Basic Example
|
||||
### Basic Example
|
||||
|
||||
Using the search bar as an example, this would look something like:
|
||||
|
||||
In [`./src/components/Settings/SearchBar.vue`](https://github.com/Lissy93/dashy/blob/master/src/components/Settings/SearchBar.vue):
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<form>
|
||||
|
|
|
@ -0,0 +1,97 @@
|
|||
# Pages and Sections
|
||||
|
||||
## Multi-Page Support
|
||||
|
||||
You can have additional pages within your dashboard, with each having it's own config file. The config files for sub-pages can either be stored locally, or hosted separately. A link to each additional page will be displayed in the navigation bar.
|
||||
|
||||
You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next.
|
||||
|
||||
### Using Local Sub-Pages
|
||||
|
||||
To get started, create a new `.yml` config file for your sub-page, placing it within `/app/public`. Then within your primary `conf.yml`, choose a name, and specify the path to the new file.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Networking Services
|
||||
path: 'networking.yml'
|
||||
- name: Work Stuff
|
||||
path: 'work.yml'
|
||||
```
|
||||
|
||||
If you're sub-page is located within `/app/public`, then you only need to specify the filename, but if it's anywhere else, then the full path is required.
|
||||
|
||||
### Using Remote Sub-Pages
|
||||
|
||||
Config files don't need to be local, you can store them anywhere, and data will be imported as sub-pages on page load.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Getting Started
|
||||
path: 'https://snippet.host/tvcw/raw'
|
||||
- name: Homelab
|
||||
path: 'https://snippet.host/tetp/raw'
|
||||
- name: Browser Startpage
|
||||
path: 'https://snippet.host/zcom/raw'
|
||||
```
|
||||
|
||||
There are many options of how this can be used. You could store your config within a Git repository, in order to easily track and rollback changes. Or host your config on your NAS, to have it backed up with the rest of your files. Or use a hosted paste service, for example [snippet.host](https://snippet.host/), which supports never-expiring CORS-enabled pastes, which can also be edited later.
|
||||
|
||||
You will obviously not be able to write updates to remote configs directly through the UI editor, but you can still make and preview changes, then use the export menu to get a copy of the new config, which can then be pasted to the remote source manually.
|
||||
The config file must, of course be accessible from within Dashy. If your config contains sensitive info (like API keys, credentials, secret URLs, etc), take care not to expose it to the internet.
|
||||
|
||||
The following example shows creating a config, publishing it as a [Gist](https://gist.github.com/), copying the URL to the raw file, and using it within your dashboard.
|
||||
|
||||
<p align="center">
|
||||
<img width="700" alt="Public config in a gist demo"
|
||||
src="https://i.ibb.co/55jm3LG/how-to-use-remote-config-sub-page.gif"
|
||||
/>
|
||||
</p>
|
||||
|
||||
### Restrictions
|
||||
|
||||
Only top-level fields supported by sub-pages are `pageInfo` and `sections`. The `appConfig` and `pages` will always be inherited from your main `conf.yml` file. Other than that, sub-pages behave exactly the same as your default view, and can contain sections, items, widgets and page info like nav links, title and logo.
|
||||
|
||||
Note that since page paths are required by the router, they are set at build-time, not run-time, and so a rebuild (happens automatically) is required for changes to page paths to take effect (this only applies to changes to the `pages` array, rebuild isn't required for editing page content).
|
||||
|
||||
## Sub-Items
|
||||
|
||||
A normal section will contain zero or more items, for example:
|
||||
|
||||
```yaml
|
||||
- name: Coding
|
||||
icon: far fa-code
|
||||
items:
|
||||
- title: GitHub
|
||||
url: https://github.com/
|
||||
- title: StackOverflow
|
||||
url: http://stackoverflow.com/
|
||||
```
|
||||
|
||||
But items can also be grouped together, referred to as sub-items. This is useful for a group of less frequently used items, which you don't want to take up too much space, or for action buttons (_coming soon_).
|
||||
|
||||
Item groups may also have an optional title.
|
||||
|
||||
```yaml
|
||||
- name: Coding
|
||||
icon: far fa-code
|
||||
items:
|
||||
- title: Normal Item 1
|
||||
- title: Normal Item 2
|
||||
- subItems:
|
||||
- title: JavaScript
|
||||
url: https://developer.mozilla.org
|
||||
icon: si-javascript
|
||||
- title: TypeScript
|
||||
url: https://www.typescriptlang.org/docs
|
||||
icon: si-typescript
|
||||
- title: Svelt
|
||||
url: https://svelte.dev/docs
|
||||
icon: si-svelte
|
||||
- title: Go
|
||||
url: https://go.dev/doc
|
||||
icon: si-go
|
||||
```
|
435
docs/privacy.md
|
@ -1,140 +1,295 @@
|
|||
# Privacy & Security
|
||||
Dashy was built with privacy in mind. Self-hosting your own apps and services is a great way to protect yourself from the mass data collection employed by big tech companies, and Dashy was designed to keep your local services organized and accessible from a single place.
|
||||
|
||||
It's fully open source, and I've tried to keep to code as clear and thoroughly documented as possible, which will make it easy for you to understand exactly how it works, and what goes on behind the scenes.
|
||||
|
||||
For privacy and security tips, check out another project of mine: **[Personal Security Checklist](https://github.com/Lissy93/personal-security-checklist)**.
|
||||
|
||||
---
|
||||
|
||||
## External Requests
|
||||
By default, Dashy will not make any external requests, unless you configure it to. Some features (which are all off by default) do require internat access, and this section outlines those features, the services used, and links to their privacy policies.
|
||||
|
||||
### Font Awesome
|
||||
If either any of your sections or items are using font-awesome icons, then these will be fetched directly from font-awesome on page load. See the [Font Awesome Privacy Policy](https://fontawesome.com/privacy) for more info.
|
||||
|
||||
### Favicon Fetching
|
||||
If an item's icon is set to `favicon`, then it will be auto-fetched from the corresponding URL. Since not all websites have their icon located at `/favicon.ico`, and if they do, it's often very low resolution (like `16 x 16 px`). Therefore, the default behavior is for Dashy to check if the URL is public, and if so will use an API to fetch the favicon. For self-hosted services, the favion will be fetched from the default path, and no external requests will be made.
|
||||
|
||||
The default favicon API is [Favicon Kit](https://faviconkit.com/), but this can be changed by setting `appConfig.faviconApi` to an alternate source (`google`, `clearbit`, `webmasterapi` and `allesedv` are supported). If you do not want to use any API, then you can set this property to `local`, and the favicon will be fetched from the default path. For hosted services, this will still incur an external request.
|
||||
|
||||
### Generative Icons
|
||||
If an item has the icon set to `generative`, then an external request it made to [Dice Bear](https://dicebear.com/) to fetch the uniquely generated icon. The URL of a given service is used as the key for generating the icon, but it is first hashed and encoded for basic privacy. For more info, please reference the [Dicebear Privacy Policy](https://avatars.dicebear.com/legal/privacy-policy)
|
||||
|
||||
|
||||
### Other Icons
|
||||
Section icons, item icons and app icons are able to accept a URL to a raw image, if the image is hosted online then an external request will be made. To avoid the need to make external requests for icon assets, you can either use a self-hosted CDN, or store your images within `./public/item-icons` (which can be mounted as a volume if you're using Docker).
|
||||
|
||||
### Web Assets
|
||||
By default, all assets required by Dashy come bundled within the source, and so no external requests are made. If you add an additional font, which is imported from a CDN, then that will incur an external request. The same applies for other web assets, like external images, scripts or styles.
|
||||
|
||||
### Status Checking
|
||||
The status check util will ping your services directly, and does not rely on any third party. If you are checking the uptime status of a public/ hosted application, then please refer to that services privacy policy. For all self-hosted services, requests happen locally within your network, and are not external.
|
||||
|
||||
### Update Checks
|
||||
When the application loads, it checks for updates. The results of which are displayed in the config menu of the UI. This was implemented because using a very outdated version of Dashy may have unfixed issues. Your version is fetched from the source (local request), but the latest version is fetched from GitHub, which is an external request. This can be disabled by setting `appConfig.disableUpdateChecks: true`
|
||||
|
||||
### Anonymous Error Reporting
|
||||
Error reporting is disabled by default, and no data will ever be sent without your explicit consent. In fact, the error tracking method will not even be imported unless you have actively enabled it. [Sentry](https://github.com/getsentry/sentry) is used for this, it's an open source error tracking and performance monitoring tool, which is used to identify any issues which occur in the production app (if you enable it).
|
||||
|
||||
The crash report includes the file or line of code that triggered the error, and a 2-layer deep stack trace. Reoccurring errors will also include the following user information: OS type (Mac, Windows, Linux, Android or iOS) and browser type (Firefox, Chrome, IE, Safari). Data scrubbing is enabled. IP address will not be stored. If any potentially identifiable data ever finds its way into a crash report, it will be automatically and permanently erased. All statistics collected are anonomized and stored securely, and ae automatically deleted after 14 days. For more about privacy and security, see the [Sentry Docs](https://sentry.io/security/).
|
||||
|
||||
Enabling anonymous error reporting helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. Error reporting is activated by setting `appConfig.enableErrorReporting: true`.
|
||||
|
||||
If you need to monitor bugs yourself, then you can [self-host your own Sentry Server](https://develop.sentry.dev/self-hosted/), and use it by setting `appConfig.sentryDsn` to your Sentry instances [Data Source Name](https://docs.sentry.io/product/sentry-basics/dsn-explainer/), then just enable error reporting in Dashy.
|
||||
|
||||
---
|
||||
|
||||
## Local Storage
|
||||
In order for user preferences to be persisted between sessions, certain data needs to be stored in the browsers local storage. No personal info is kept here, none of this data can be accessed by other domains, and no data is ever sent to any server without your prior consent.
|
||||
You can view your browsers session storage by opening up the dev tools (F12) --> Application --> Storage.
|
||||
|
||||
The following section outlines all data that is stored in the browsers, as cookies or local storage.
|
||||
|
||||
#### Cookies
|
||||
- `AUTH_TOKEN` - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled
|
||||
|
||||
#### Local Storage
|
||||
- `LANGUAGE` - The locale to show app text in
|
||||
- `HIDE_WELCOME_BANNER` - Set to true once user dismissed welcome message, so that it's not shown again
|
||||
- `LAYOUT_ORIENTATION` - Preferred section layout, either horizontal, vertical or auto
|
||||
- `COLLAPSE_STATE` - Remembers which sections are collapsed
|
||||
- `ICON_SIZE` - Size of items, either small, medium or large
|
||||
- `THEME` - Users applied theme
|
||||
- `CUSTOM_COLORS` - Any color modifications made to a given theme
|
||||
- `BACKUP_ID` - If a backup has been made, the ID is stored here
|
||||
- `BACKUP_HASH` - A unique hash of the previous backups meta data
|
||||
- `HIDE_SETTINGS` - Lets user hide or show the settings menu
|
||||
- `USERNAME` - If user logged in, store username. Only used to show welcome message, not used for auth
|
||||
- `CONF_SECTIONS` - Array of sections, only used when user applies changes locally
|
||||
- `PAGE_INFO` - Config page info, only used when user applies changes locally
|
||||
- `APP_CONFIG` - App config, only used when user applies changes locally
|
||||
- `MOST_USED` - If smart sort is used to order items by most used, store open count
|
||||
- `LAST_USED` - If smart sort is used to order items by last used, store timestamps
|
||||
|
||||
---
|
||||
|
||||
## Dependencies
|
||||
As with most web projects, Dashy relies on several [dependencies](https://github.com/Lissy93/dashy/blob/master/docs/credits.md#dependencies-). For links to each, and a breakdown of their licenses, please see [Legal](https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md).
|
||||
|
||||
Dependencies can introduce security vulnerabilities, but since all these packages are open source any issues are usually very quickly spotted. Dashy is using Snyk for dependency security monitoring, and you can see [the latest report here](https://snyk.io/test/github/lissy93/dashy). If any issue is detected by Snyk, a note about it will appear at the top of the Reamde, and will usually be fixed within 48 hours.
|
||||
|
||||
Note that packages listed under `deDependencies` section are only used for building the project, and are not included in the production environment.
|
||||
|
||||
---
|
||||
|
||||
## Securing your Environment
|
||||
Running your self-hosted applications in individual, containerized environments (such as containers or VMs) helps keep them isolated, and prevent an exploit in one service effecting another.
|
||||
|
||||
There is very little complexity involved with Dashy, and therefore the attack surface is reasonably small, but it is still important to follow best practices and employ monitoring for all your self-hosted apps. A couple of things that you should look at include:
|
||||
- Use SSL for securing traffic in transit
|
||||
- Configure [authentication](/docs/authentication.md#alternative-authentication-methods) to prevent unauthorized access
|
||||
- Keep your system, software and Dashy up-to-date
|
||||
- Ensure your server is appropriately secured
|
||||
- Manage users and SSH correctly
|
||||
- Enable and configure firewall rules
|
||||
- Implement security, malware and traffic scanning
|
||||
- Setup malicious traffic detection
|
||||
- Understand the [Docker attack fronts](https://docs.docker.com/engine/security/), and follow [Docker Security Best Practices](https://snyk.io/blog/10-docker-image-security-best-practices/)
|
||||
|
||||
This is covered in more detail in [App Management](/docs/management.md).
|
||||
|
||||
---
|
||||
|
||||
## Security Features
|
||||
|
||||
#### Subresource Integrity
|
||||
[Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) or SRI is a security feature that enables browsers to verify that resources they fetch are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match. This prevents the app from loading any resources that have been manipulated, by verifying the files hashes. It safeguards against the risk of an attacker injecting arbitrary malicious content into any files served up via a CDN.
|
||||
|
||||
Dashy supports SRI, and it is recommended to enable this if you are hosting your dashboard via a public CDN. To enable SRI, set the `INTEGRITY` environmental variable to `true`.
|
||||
|
||||
#### Authentication
|
||||
Dashy supports both basic auth, as well as server-based SSO using Keycloak. Full details of which, along with alternate authentication methods can be found in the [Authentication Docs](/docs/authentication.md). If your dashboard is exposed to the internet and/ or contains any sensitive info it is strongly recommended to configure access control with Keycloak or another server-side method.
|
||||
|
||||
---
|
||||
|
||||
## Disabling Features
|
||||
You may wish to disable features that you don't want to use, if they involve storing data in the browser or making network requests.
|
||||
- To disable smart-sort (uses local storage), set `appConfig.disableSmartSort: true`
|
||||
- To disable update checks (makes external request to GH), set `appConfig.disableUpdateChecks: true`
|
||||
- To disable web search (redirect to external / internal content), set `appConfig.disableWebSearch: true`
|
||||
- To keep status checks disabled (external/ internal requests), set `appConfig.statusCheck: false`
|
||||
- To keep font-awesome icons disabled (external requests), set `appConfig.enableFontAwesome: false`
|
||||
- To keep error reporting disabled (external requests and data collection), set `appConfig.enableErrorReporting: false`
|
||||
- To keep the service worker disabled (stores cache of app in browser data), set `appConfig.enableServiceWorker: false`
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Security Issue
|
||||
If you think you've found a critical issue with Dashy, please send an email to `security@mail.alicia.omg.lol`. You can encrypt it, using [`0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7`](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7). You should receive a response within 48 hours.
|
||||
|
||||
All non-critical issues can be raised as a ticket.
|
||||
|
||||
Please include the following information:
|
||||
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
- Full paths of source file(s) related to the manifestation of the issue
|
||||
- The location of the affected source code (tag/branch/commit or direct URL)
|
||||
- Any special configuration required to reproduce the issue
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if possible)
|
||||
- Impact of the issue, including how an attacker might exploit the issue
|
||||
# Privacy & Security
|
||||
|
||||
Dashy was built with privacy in mind.
|
||||
Self-hosting your own apps and services is a great way to protect yourself from the mass data collection employed by big tech companies, and Dashy was designed to make self-hosting easier, by keeping your local services organized and accessible from a single place. The [management docs](https://github.com/Lissy93/dashy/blob/master/docs/management.md) contains a though guide on the steps you can take to secure your homelab.
|
||||
|
||||
Dashy operates on the premise, that no external data requests should ever be made, unless explicitly enabled by the user. In the interest of transparency, the code is 100% open source and clearly documented throughout.
|
||||
|
||||
| 🔐 For privacy and security tips, check out another project of mine: **[Personal Security Checklist](https://github.com/Lissy93/personal-security-checklist)** |
|
||||
|-|
|
||||
|
||||
## Contents
|
||||
|
||||
- [External Requests](#external-requests)
|
||||
- [Icons](#icons)
|
||||
- [Themes](#themes)
|
||||
- [Widgets](#widgets)
|
||||
- [Features](#features)
|
||||
- [Status Checking](#status-checking)
|
||||
- [Update Checks](#update-checks)
|
||||
- [Cloud Backup](#cloud-backup)
|
||||
- [Web Search](#web-search)
|
||||
- [Error Reporting](#anonymous-error-reporting)
|
||||
- [Browser Storage](#browser-storage)
|
||||
- [App Dependencies](#dependencies)
|
||||
- [Security Features](#security-features)
|
||||
- [Securing your Environment](#securing-your-environment)
|
||||
- [Reporting a Security Issue](#reporting-a-security-issue)
|
||||
|
||||
---
|
||||
|
||||
## External Requests
|
||||
|
||||
By default, Dashy will not make any external requests, unless you configure it to. Some features (which are off by default) do require internat access, and this section outlines those features, the services used, and links to their privacy policies.
|
||||
|
||||
The following section outlines all network requests that are made when certain features are enabled.
|
||||
|
||||
### Icons
|
||||
|
||||
#### Font Awesome
|
||||
|
||||
If either any of your sections, items or themes are using icons from font-awesome, then it will be automatically enabled. But you can also manually enable or disable it by setting `appConfig.enableFontAwesome` to `true` / `false`. Requests are made directly to Font-Awesome CDN, for more info, see the [Font Awesome Privacy Policy](https://fontawesome.com/privacy).
|
||||
|
||||
#### Material Design Icons
|
||||
|
||||
If either any of your sections, items or themes are mdi icons, then it will be automatically enabled. But you can also manually enable or disable it by setting `appConfig.enableMaterialDesignIcons` to `true` / `false`. Requests are made directly to Material-Design-Icons CDN, for more info, see the [Material Design Icons Website](https://materialdesignicons.com/).
|
||||
|
||||
#### Favicon Fetching
|
||||
|
||||
If an item's icon is set to `favicon`, then it will be auto-fetched from the corresponding URL. Since not all websites have their icon located at `/favicon.ico`, and if they do, it's often very low resolution (like `16 x 16 px`). Therefore, the default behavior is for Dashy to check if the URL is public, and if so will use an API to fetch the favicon. For self-hosted services, the favicon will be fetched from the default path, and no external requests will be made.
|
||||
|
||||
The default favicon API is [allesedv.com](https://favicon.allesedv.com/), but this can be changed by setting `appConfig.faviconApi` to an alternate source (`iconhorse`, `clearbit`, `faviconkit`, `besticon`, `duckduckgo`, `google` and `allesedv` are supported). If you do not want to use any API, then you can set this property to `local`, and the favicon will be fetched from the default path. For hosted services, this will still incur an external request.
|
||||
|
||||
#### Generative Icons
|
||||
|
||||
If an item has the icon set to `generative`, then an external request it made to [Dice Bear](https://dicebear.com/) to fetch the uniquely generated icon. The URL of a given service is used as the key for generating the icon, but it is first hashed and encoded for basic privacy. For more info, please reference the [Dicebear Privacy Policy](https://avatars.dicebear.com/legal/privacy-policy)
|
||||
|
||||
As a fallback, if Dicebear fails, then [Evatar](https://evatar.io/) is used.
|
||||
|
||||
#### Other Icons
|
||||
|
||||
Section icons, item icons and app icons are able to accept a URL to a raw image, if the image is hosted online then an external request will be made. To avoid the need to make external requests for icon assets, you can either use a self-hosted CDN, or store your images within `./public/item-icons` (which can be mounted as a volume if you're using Docker).
|
||||
|
||||
#### Web Assets
|
||||
|
||||
By default, all assets required by Dashy come bundled within the source, and so no external requests are made. If you add an additional font, which is imported from a CDN, then that will incur an external request. The same applies for other web assets, like external images, scripts or styles.
|
||||
|
||||
---
|
||||
|
||||
### Features
|
||||
|
||||
#### Status Checking
|
||||
|
||||
The status checking feature allows you to ping your apps/ services to check if they are currently operational.
|
||||
|
||||
Dashy will ping your services directly, and does not rely on any third party. If you are checking the uptime status of a public/ hosted application, then please refer to that services privacy policy. For all self-hosted services, requests happen locally within your network, and are not external.
|
||||
|
||||
#### Update Checks
|
||||
|
||||
When the application loads, it checks for updates. The results of which are displayed in the config menu of the UI. This was implemented because using a very outdated version of Dashy may have unfixed issues. Your version is fetched from the source (local request), but the latest version is fetched from GitHub, which is an external request. This can be disabled by setting `appConfig.disableUpdateChecks: true`
|
||||
|
||||
#### Cloud Backup
|
||||
|
||||
Dashy has an optional End-to-End encrypted [cloud backup feature](https://github.com/Lissy93/dashy/blob/master/docs/backup-restore.md). No data is ever transmitted unless you actively enable this feature through the UI.
|
||||
|
||||
All data is encrypted before being sent to the backend. This is done in [`CloudBackup.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js), using [crypto.js](https://github.com/brix/crypto-js)'s AES method, using the users chosen password as the key. The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) (a platform for running serverless functions), and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store.
|
||||
|
||||
Your selected password never leaves your device, and is hashed before being compared. It is only possible to restore a configuration if you have both the backup ID and decryption password. Because the data is encrypted on the client-side (before being sent to the cloud), it is not possible for a man-in-the-middle, government entity, website owner, or even Cloudflare to be able read any of your data.
|
||||
|
||||
#### Web Search
|
||||
|
||||
Dashy has a primitive [web search feature](https://github.com/Lissy93/dashy/blob/master/docs/searching.md#web-search). No external requests are made, instead you are redirected to your chosen search engine (defaults to DuckDuckGo), using your chosen opening method.
|
||||
|
||||
This feature can be disabled under appConfig, with `webSearch: { disableWebSearch: true }`
|
||||
|
||||
#### Anonymous Error Reporting
|
||||
|
||||
Error reporting is disabled by default, and no data will ever be sent without your explicit consent. In fact, the error tracking code isn't even imported unless you have actively enabled it. [Sentry](https://github.com/getsentry/sentry) is used for this, it's an open source error tracking and performance monitoring tool, used to identify any issues which occur in the production app (if you enable it).
|
||||
|
||||
The crash report includes the file or line of code that triggered the error, and a 2-layer deep stack trace. Reoccurring errors will also include the following user information: OS type (Mac, Windows, Linux, Android or iOS) and browser type (Firefox, Chrome, IE, Safari). Data scrubbing is enabled. IP address will not be stored. If any potentially identifiable data ever finds its way into a crash report, it will be automatically and permanently erased. All statistics collected are anonymized and stored securely, and ae automatically deleted after 14 days. For more about privacy and security, see the [Sentry Docs](https://sentry.io/security/).
|
||||
|
||||
Enabling anonymous error reporting helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. Error reporting is activated by setting `appConfig.enableErrorReporting: true`.
|
||||
|
||||
If you need to monitor bugs yourself, then you can [self-host your own Sentry Server](https://develop.sentry.dev/self-hosted/), and use it by setting `appConfig.sentryDsn` to your Sentry instances [Data Source Name](https://docs.sentry.io/product/sentry-basics/dsn-explainer/), then just enable error reporting in Dashy.
|
||||
|
||||
---
|
||||
|
||||
### Themes
|
||||
|
||||
Certain themes may use external assets (such as fonts or images). Currently, this only applies the Adventure theme.
|
||||
|
||||
---
|
||||
|
||||
### Widgets
|
||||
|
||||
Dashy supports [Widgets](/docs/widgets.md) for displaying dynamic content. Below is a list of all widgets that make external data requests, along with the endpoint they call and a link to the Privacy Policy of that service.
|
||||
|
||||
- **[Weather](/docs/widgets.md#weather)** and **[Weather Forecast](/docs/widgets.md#weather-forecast)**: `https://api.openweathermap.org`
|
||||
- [OWM Privacy Policy](https://openweather.co.uk/privacy-policy)
|
||||
- **[RSS Feed](/docs/widgets.md#rss-feed)**: `https://api.rss2json.com/v1/api.json`
|
||||
- [Rss2Json Privacy Policy](https://rss2json.com/privacy-policy)
|
||||
- **[IP Address](/docs/widgets.md#public-ip)**: `https://ipapi.co/json` or `http://ip-api.com/json`
|
||||
- [IPGeoLocation Privacy Policy](https://ipgeolocation.io/privacy.html)
|
||||
- [IP-API Privacy Policy](https://ip-api.com/docs/legal)
|
||||
- **[IP Blacklist](/docs/widgets.md#ip-blacklist)**: `https://api.blacklistchecker.com`
|
||||
- [Blacklist Checker Privacy Policy](https://blacklistchecker.com/privacy)
|
||||
- **[Domain Monitor](/docs/widgets.md#domain-monitor)**: `http://api.whoapi.com`
|
||||
- [WhoAPI Privacy Policy](https://whoapi.com/privacy-policy/)
|
||||
- **[Crypto Watch List](/docs/widgets.md#crypto-watch-list)** and **[Token Price History](/docs/widgets.md#crypto-token-price-history)**: `https://api.coingecko.com`
|
||||
- [CoinGecko Privacy Policy](https://www.coingecko.com/en/privacy)
|
||||
- **[Wallet Balance](/docs/widgets.md#wallet-balance)**: `https://api.blockcypher.com/`
|
||||
- [BlockCypher Privacy Policy](https://www.blockcypher.com/privacy.html)
|
||||
- **[Code::Stats](/docs/widgets.md#code-stats)**: `https://codestats.net`
|
||||
- [Code::Stats Privacy Policy](https://codestats.net/tos#privacy)
|
||||
- **[AnonAddy](/docs/widgets.md#anonaddy)**: `https://app.anonaddy.com`
|
||||
- [AnonAddy Privacy Policy](https://anonaddy.com/privacy/)
|
||||
- **[Vulnerability Feed](/docs/widgets.md#vulnerability-feed)**: `https://www.cvedetails.com`
|
||||
- [CVE Details Privacy Policy](https://www.cvedetails.com/privacy.php)
|
||||
- **[Exchange Rate](/docs/widgets.md#exchange-rates)**: `https://v6.exchangerate-api.com`
|
||||
- [ExchangeRateAPI Privacy Policy](https://www.exchangerate-api.com/terms)
|
||||
- **[Public Holidays](/docs/widgets.md#public-holidays)**: `https://kayaposoft.com`
|
||||
- [jurajmajer/enrico](https://github.com/jurajmajer/enrico)
|
||||
- **[Covid-19 Status](/docs/widgets.md#covid-19-status)**: `https://codestats.net`
|
||||
- [disease-sh/api](https://github.com/disease-sh/api)
|
||||
- **[Sports Scores](/docs/widgets.md#sports-scores)**: `https://thesportsdb.com`
|
||||
- No Policy Available
|
||||
- **[News Headlines](/docs/widgets.md#news-headlines)**: `https://api.currentsapi.services`
|
||||
- [CurrentsAPI Privacy Policy](https://currentsapi.services/privacy)
|
||||
- **[Mullvad Status](/docs/widgets.md#mullvad-status)**: `https://am.i.mullvad.net`
|
||||
- [Mullvad Privacy Policy](https://mullvad.net/en/help/privacy-policy/)
|
||||
- **[TFL Status](/docs/widgets.md#tfl-status)**: `https://api.tfl.gov.uk`
|
||||
- [TFL Privacy Policy](https://tfl.gov.uk/corporate/privacy-and-cookies/)
|
||||
- **[Stock Price History](/docs/widgets.md#stock-price-history)**: `https://alphavantage.co`
|
||||
- [AlphaVantage Privacy Policy](https://www.alphavantage.co/privacy/)
|
||||
- **[ETH Gas Prices](/docs/widgets.md#eth-gas-prices)**: `https://ethgas.watch`
|
||||
- [wslyvh/ethgaswatch](https://github.com/wslyvh/ethgaswatch)
|
||||
- **[Joke](/docs/widgets.md#joke)**: `https://v2.jokeapi.dev`
|
||||
- [SV443's Privacy Policy](https://sv443.net/privacypolicy/en)
|
||||
- **[Flight Data](/docs/widgets.md#flight-data)**: `https://aerodatabox.p.rapidapi.com`
|
||||
- [AeroDataBox Privacy Policy](https://www.aerodatabox.com/#h.p_CXtIYZWF_WQd)
|
||||
- **[Astronomy Picture of the Day](/docs/widgets.md#astronomy-picture-of-the-day)**: `https://apodapi.herokuapp.com`
|
||||
- [NASA's Privacy Policy](https://www.nasa.gov/about/highlights/HP_Privacy.html)
|
||||
- **[GitHub Trending](/docs/widgets.md#github-trending)** and **[GitHub Profile Stats](/docs/widgets.md#github-profile-stats)**: `https://api.github.com`
|
||||
- [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement)
|
||||
- **[Cron Monitoring (Health Checks)](/docs/widgets.md#cron-monitoring-health-checks)**: `https://healthchecks.io`
|
||||
- [Health-Checks Privacy Policy](https://healthchecks.io/privacy/)
|
||||
|
||||
---
|
||||
|
||||
## Browser Storage
|
||||
|
||||
In order for user preferences to be persisted between sessions, certain data needs to be stored in the browsers local storage. No personal info is kept here, none of this data can be accessed by other domains, and no data is ever sent to any server without your prior consent.
|
||||
|
||||
You can view and delete stored data by opening up the dev tools: <kbd>F12</kbd> --> `Application` --> `Storage`.
|
||||
|
||||
The following section outlines all data that is stored in the browsers, as cookies, session storage or local storage.
|
||||
|
||||
### Cookies
|
||||
|
||||
> [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) will expire after their pre-defined lifetime
|
||||
|
||||
- `AUTH_TOKEN` - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled.
|
||||
|
||||
### Session Storage
|
||||
|
||||
> [Session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) is deleted when the current session ends (tab / window is closed)
|
||||
|
||||
- `SW_STATUS` - The current status of any service workers
|
||||
- `ERROR_LOG` - List of recent errors
|
||||
|
||||
### Local Storage
|
||||
|
||||
> [Local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) is persisted between sessions, and only deleted when manually removed
|
||||
|
||||
- `LANGUAGE` - The locale to show app text in
|
||||
- `HIDE_INFO_NOTIFICATION` - Set to true once user dismissed welcome message, so that it's not shown again
|
||||
- `LAYOUT_ORIENTATION` - Preferred section layout, either horizontal, vertical or auto
|
||||
- `COLLAPSE_STATE` - Remembers which sections are collapsed
|
||||
- `ICON_SIZE` - Size of items, either small, medium or large
|
||||
- `THEME` - Users applied theme
|
||||
- `CUSTOM_COLORS` - Any color modifications made to a given theme
|
||||
- `BACKUP_ID` - If a backup has been made, the ID is stored here
|
||||
- `BACKUP_HASH` - A unique hash of the previous backups meta data
|
||||
- `HIDE_SETTINGS` - Lets user hide or show the settings menu
|
||||
- `USERNAME` - If user logged in, store username. Only used to show welcome message, not used for auth
|
||||
- `CONF_SECTIONS` - Array of sections, only used when user applies changes locally
|
||||
- `PAGE_INFO` - Config page info, only used when user applies changes locally
|
||||
- `APP_CONFIG` - App config, only used when user applies changes locally
|
||||
- `MOST_USED` - If smart sort is used to order items by most used, store open count
|
||||
- `LAST_USED` - If smart sort is used to order items by last used, store timestamps
|
||||
|
||||
### Deleting Stored Data
|
||||
|
||||
You can manually view and delete session storage, local storage and cookies at anytime. Fist [open](/docs/troubleshooting.md#how-to-open-browser-console) your browsers developer tools (usually <kbd>F12</kbd>), then under the Application tab select the storage category. Here you will see a list of stored data, and you can select any item and delete it.
|
||||
|
||||
---
|
||||
|
||||
## Dependencies
|
||||
|
||||
As with most web projects, Dashy relies on several [dependencies](https://github.com/Lissy93/dashy/blob/master/docs/credits.md#dependencies-). For links to each, and a breakdown of their licenses, please see [Legal](https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md).
|
||||
|
||||
Dependencies can introduce security vulnerabilities, but since all these packages are open source any issues are usually very quickly spotted. Dashy is using Snyk for dependency security monitoring, and you can see [the latest report here](https://snyk.io/test/github/lissy93/dashy). If any issue is detected by Snyk, a note about it will appear at the top of the Readme, and will usually be fixed within 48 hours.
|
||||
|
||||
Note that packages listed under `devDependencies` section are only used for building the project, and are not included in the production environment.
|
||||
|
||||
---
|
||||
|
||||
## Securing your Environment
|
||||
|
||||
Running your self-hosted applications in individual, containerized environments (such as containers or VMs) helps keep them isolated, and prevent an exploit in one service effecting another.
|
||||
|
||||
If you're running Dashy in a container, see [Management Docs --> Container Security](https://github.com/Lissy93/dashy/blob/master/docs/management.md#container-security) for step-by-step security guide.
|
||||
|
||||
There is very little complexity involved with Dashy, and therefore the attack surface is reasonably small, but it is still important to follow best practices and employ monitoring for all your self-hosted apps. A couple of things that you should look at include:
|
||||
|
||||
- Use SSL for securing traffic in transit
|
||||
- Configure [authentication](/docs/authentication.md#alternative-authentication-methods) to prevent unauthorized access
|
||||
- Keep your system, software and Dashy up-to-date
|
||||
- Ensure your server is appropriately secured
|
||||
- Manage users and SSH correctly
|
||||
- Enable and configure firewall rules
|
||||
- Implement security, malware and traffic scanning
|
||||
- Setup malicious traffic detection
|
||||
- Understand the [Docker attack fronts](https://docs.docker.com/engine/security/), and follow [Docker Security Best Practices](https://snyk.io/blog/10-docker-image-security-best-practices/)
|
||||
|
||||
This is covered in more detail in [App Management](/docs/management.md).
|
||||
|
||||
---
|
||||
|
||||
## Security Features
|
||||
|
||||
### Subresource Integrity
|
||||
|
||||
[Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) or SRI is a security feature that enables browsers to verify that resources they fetch are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match. This prevents the app from loading any resources that have been manipulated, by verifying the files hashes. It safeguards against the risk of an attacker injecting arbitrary malicious content into any files served up via a CDN.
|
||||
|
||||
Dashy supports SRI, and it is recommended to enable this if you are hosting your dashboard via a public CDN. To enable SRI, set the `INTEGRITY` environmental variable to `true`.
|
||||
|
||||
### SSL
|
||||
|
||||
Native SSL support is enabled, for setup instructions, see the [Management Docs](/docs/management.md#ssl-certificates)
|
||||
|
||||
### Authentication
|
||||
|
||||
Dashy supports both basic auth, as well as server-based SSO using Keycloak. Full details of which, along with alternate authentication methods can be found in the [Authentication Docs](/docs/authentication.md). If your dashboard is exposed to the internet and/ or contains any sensitive info it is strongly recommended to configure access control with Keycloak or another server-side method.
|
||||
|
||||
---
|
||||
|
||||
## Disabling Features
|
||||
|
||||
You may wish to disable features that you don't want to use, if they involve storing data in the browser or making network requests.
|
||||
|
||||
- To disable smart-sort (uses local storage), set `appConfig.disableSmartSort: true`
|
||||
- To disable update checks (makes external request to GH), set `appConfig.disableUpdateChecks: true`
|
||||
- To disable web search (redirect to external / internal content), set `appConfig.disableWebSearch: true`
|
||||
- To keep status checks disabled (external/ internal requests), set `appConfig.statusCheck: false`
|
||||
- To keep font-awesome icons disabled (external requests), set `appConfig.enableFontAwesome: false`
|
||||
- To keep error reporting disabled (external requests and data collection), set `appConfig.enableErrorReporting: false`
|
||||
- To keep the service worker disabled (stores cache of app in browser data), set `appConfig.enableServiceWorker: false`
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Security Issue
|
||||
|
||||
If you think you've found a critical issue with Dashy, please send an email to `security@mail.alicia.omg.lol`. You can encrypt it, using [`0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7`](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7). You should receive a response within 48 hours. For more information, see [SECURITY.md](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md).
|
||||
|
||||
All non-critical issues can be raised as a ticket.
|
||||
|
||||
Please include the following information:
|
||||
|
||||
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
- Full paths of source file(s) related to the manifestation of the issue
|
||||
- The location of the affected source code (tag/branch/commit or direct URL)
|
||||
- Any special configuration required to reproduce the issue
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if possible)
|
||||
- Impact of the issue, including how an attacker might exploit the issue
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Welcome to Dashy! So glad you're here 😊 In a couple of minutes, you'll have your new dashboard up and running 🚀
|
||||
|
||||
**TDLR;** Run `docker run -p 8080:80 lissy93/dashy`, then open `http://localhost:8080`
|
||||
**TLDR;** Run `docker run -p 8080:8080 lissy93/dashy`, then open `http://localhost:8080`
|
||||
|
||||
---
|
||||
|
||||
|
@ -16,10 +16,11 @@ If you don't want to use Docker, then you can use one of Dashy's other supported
|
|||
## 2. Installation
|
||||
|
||||
To pull the latest image, and build and start the app run:
|
||||
```
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 8080:80 \
|
||||
-v ~/my-conf.yml:/app/public/conf.yml \
|
||||
-p 8080:8080 \
|
||||
-v ~/my-conf.yml:/app/user-data/conf.yml \
|
||||
--name my-dashboard \
|
||||
--restart=always \
|
||||
lissy93/dashy:latest
|
||||
|
@ -31,15 +32,41 @@ Your dashboard should now be up and running at `http://localhost:8080` (or your
|
|||
|
||||
---
|
||||
|
||||
## 3. Configure
|
||||
## 3. User Data Directory
|
||||
|
||||
Your config file should be placed inside `user-data/` (in Docker, that's `/app/user-data/`).
|
||||
|
||||
This directory can also contain some optional assets you wish to use within your dashboard, like icons, fonts, styles, scripts, etc.
|
||||
|
||||
Any files placed here will be served up to the root of the domain, and override the contents of `public/`.
|
||||
For example, if you had `user-data/favicon.ico` this would be accessible at `http://my-dashy-instance.local/favicon.ico`
|
||||
|
||||
Example Files in `user-data`:
|
||||
- `conf.yml` - This is the only file that is compulsary, it's your main Dashy config
|
||||
- `**.yml` - Include more config files, if you'd like to have multiple pages, see [Multi-page support](/docs/pages-and-sections.md#multi-page-support) for docs
|
||||
- `favicon.ico` - The default favicon, shown in the browser's tab title
|
||||
- `initialization.html` - Static HTML page displayed before the app has finished compiling, see [`public/initialization.html`](https://github.com/Lissy93/dashy/blob/master/public/initialization.html)
|
||||
- `robots.txt` - Search engine crawl rules, override this if you want your dashboard to be indexable
|
||||
- `manifest.json` - PWA configuration file, for installing Dashy on mobile devices
|
||||
- `index.html` - The main index page which initializes the client-side app, copy it from [`/public/index.html`](https://github.com/Lissy93/dashy/blob/master/public/index.html)
|
||||
- `**.html` - Write your own HTML pages, and access them at `http://my-dashy-instance.local/my-page.html`
|
||||
- `fonts/` - Custom fonts (be sure to include the ones already in [`public/fonts`](https://github.com/Lissy93/dashy/tree/master/public/fonts)
|
||||
- `item-icons/` - To use your own icons for items on your dashboard, see [Icons --> Local Icons](/docs/icons.md#local-icons)
|
||||
- `web-icons/` - Override Dashy logo
|
||||
- `widget-resources/` - Fonts, icons and assets for custom widgets
|
||||
|
||||
---
|
||||
|
||||
## 4. Configure
|
||||
|
||||
Now that you've got Dashy running, you are going to want to set it up with your own content.
|
||||
Config is written in [YAML Format](https://yaml.org/), and saved in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml).
|
||||
Config is written in [YAML Format](https://yaml.org/), and saved in [`/user-data/conf.yml`](https://github.com/Lissy93/dashy/blob/master/user-data/conf.yml).
|
||||
The format on the config file is pretty straight forward. There are three root attributes:
|
||||
|
||||
- [`pageInfo`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#pageinfo) - Dashboard meta data, like title, description, nav bar links and footer text
|
||||
- [`appConfig`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#appconfig-optional) - Dashboard settings, like themes, authentication, language and customization
|
||||
- [`sections`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#section) - An array of sections, each including an array of items
|
||||
|
||||
- [`pages`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#pages-optional) - Have multiples pages in your dashboard
|
||||
|
||||
You can view a full list of all available config options in the [Configuring Docs](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md).
|
||||
|
||||
|
@ -69,21 +96,22 @@ sections: # An array of sections
|
|||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- You can use a Docker volume to pass a config file from your host system to the container
|
||||
- E.g. `-v ./host-system/my-local-conf.yml:/app/public/conf.yml`
|
||||
- E.g. `-v ./host-system/my-local-conf.yml:/app/user-data/conf.yml`
|
||||
- It's also possible to edit your config directly through the UI, and changes will be saved in this file
|
||||
- Check your config against Dashy's schema, with `docker exec -it [container-id] yarn validate-config`
|
||||
- You might find it helpful to look at some examples, a collection of which can be [found here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10)
|
||||
- After editing your config, the app will rebuild in the background, which may take a minute
|
||||
- It's also possible to load a remote config, e.g. from a GitHub Gist
|
||||
|
||||
---
|
||||
|
||||
## 4. Further Customisation
|
||||
## 5. Further Customisation
|
||||
|
||||
Once you've got Dashy setup, you'll want to ensure the container is properly healthy, secured, backed up and kept up-to-date. All this is covered in the [Management Docs](https://github.com/Lissy93/dashy/blob/master/docs/management.md).
|
||||
|
||||
|
||||
You might also want to check out the docs for specific features you'd like to use:
|
||||
|
||||
- [Authentication](/docs/authentication.md) - Setting up authentication to protect your dashboard
|
||||
- [Alternate Views](/docs/alternate-views.md) - Using the startpage and workspace view
|
||||
- [Backup & Restore](/docs/backup-restore.md) - Guide to Dashy's cloud sync feature
|
||||
|
@ -95,13 +123,13 @@ You might also want to check out the docs for specific features you'd like to us
|
|||
|
||||
---
|
||||
|
||||
## 5. Final Note
|
||||
## 6. Final Note
|
||||
|
||||
If you need any help or support in getting Dashy running, head over to the [Discussions](https://github.com/Lissy93/dashy/discussions) page. If you think you've found a bug, please do [raise it](https://github.com/Lissy93/dashy/issues/new/choose) so it can be fixed. For contact options, see the [Support Page](https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT.md).
|
||||
|
||||
If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the [Contributing Page](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md). Huge thanks to [everyone](https://github.com/Lissy93/dashy/blob/master/docs/credits.md) who has already helped out!
|
||||
|
||||
Enjoy your dashboard :)
|
||||
Enjoy your dashboard :)
|
||||
|
||||
---
|
||||
|
||||
|
@ -109,32 +137,36 @@ Enjoy your dashboard :)
|
|||
|
||||
You can also easily run the app on your system without Docker. For this [Git](https://git-scm.com/downloads), [Node.js](https://nodejs.org/), and [Yarn](https://yarnpkg.com/) are required.
|
||||
|
||||
```
|
||||
```bash
|
||||
git clone https://github.com/Lissy93/dashy.git && cd dashy
|
||||
yarn # Install dependencies
|
||||
yarn build # Build the app
|
||||
yarn start # Start the app
|
||||
```
|
||||
Then edit `./public/conf.yml` and rebuild the app with `yarn build`
|
||||
|
||||
Then edit `./user-data/conf.yml`
|
||||
|
||||
---
|
||||
|
||||
## Alternative Deployment Method 2 - Netlify
|
||||
|
||||
Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many [other cloud providers](./docs/deployment.md#deploy-to-cloud-service)). All you need it a GitHub account.
|
||||
|
||||
1. Fork Dashy's repository on GitHub
|
||||
2. [Log in](app.netlify.com/login/) to Netlify with GitHub
|
||||
3. Click "New site from Git" and select your forked repo, then click **Deploy**!
|
||||
4. You can then edit the config in `./public/conf.yml` in your repo, and Netlify will rebuild the app
|
||||
4. You can then edit the config in `./user-data/conf.yml` in your repo, and Netlify will rebuild the app
|
||||
|
||||
---
|
||||
|
||||
## Alternative Deployment Method 3 - Cloud Services
|
||||
|
||||
Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:
|
||||
|
||||
- [<img src="https://i.ibb.co/ZxtzrP3/netlify.png" width="18"/> Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
|
||||
- [<img src="https://i.ibb.co/d2P1WZ7/heroku.png" width="18"/> Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
|
||||
- [<img src="https://i.ibb.co/Ld2FZzb/vercel.png" width="18"/> Deploy to Vercel](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
|
||||
- [<img src="https://i.ibb.co/xCHtzgh/render.png" width="18"/> Deploy to Render](https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render)
|
||||
- [<img src="https://i.ibb.co/J7MGymY/googlecloud.png" width="18"/> Deploy to GCP](https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git)
|
||||
- [<img src="https://i.ibb.co/HVWVYF7/docker.png" width="18"/> Deploy to PWD](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
- [<img src="https://i.ibb.co/HVWVYF7/docker.png" width="18"/> Deploy to PWD](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
- [<img src="https://i.ibb.co/7NxnM2P/easypanel.png" width="18"/> Deploy to Easypanel](https://easypanel.io/docs/templates/dashy)
|
||||
|
|
|
@ -1,13 +1,15 @@
|
|||
![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)
|
||||
# ![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png)
|
||||
|
||||
### Running Dashy
|
||||
- [Quick Start](/docs/quick-start.md) - TDLR guide on getting Dashy up and running
|
||||
## Running Dashy
|
||||
|
||||
- [Quick Start](/docs/quick-start.md) - TLDR guide on getting Dashy up and running
|
||||
- [Deployment](/docs/deployment.md) - Full guide on deploying Dashy either locally or online
|
||||
- [Configuring](/docs/configuring.md) - Complete list of all available options in the config file
|
||||
- [App Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc
|
||||
- [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them
|
||||
|
||||
### Development and Contributing
|
||||
## Development and Contributing
|
||||
|
||||
- [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow
|
||||
- [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors
|
||||
- [Contributing](/docs/contributing.md) - How you can help keep Dashy alive
|
||||
|
@ -15,17 +17,21 @@
|
|||
- [Credits](/docs/credits.md) - List of people and projects that have made Dashy possible
|
||||
- [Release Workflow](/docs/release-workflow.md) - Info about releases, CI and automated tasks
|
||||
|
||||
### Feature Docs
|
||||
## Feature Docs
|
||||
|
||||
- [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard
|
||||
- [Alternate Views](/docs/alternate-views.md) - Outline of available pages / views and item opening methods
|
||||
- [Backup & Restore](/docs/backup-restore.md) - Guide to Dashy's cloud sync feature
|
||||
- [Icons](/docs/icons.md) - Outline of all available icon types for sections and items
|
||||
- [Backup & Restore](/docs/backup-restore.md) - Guide to backing up config with Dashy's cloud sync feature
|
||||
- [Icons](/docs/icons.md) - Outline of all available icon types for sections and items, with examples
|
||||
- [Language Switching](/docs/multi-language-support.md) - Details on how to switch language, or add a new locale
|
||||
- [Pages and Sections](/docs/pages-and-sections.md) - Multi-page support, sections, items and sub-items
|
||||
- [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
|
||||
- [Searching & Shortcuts](/docs/searching.md) - Finding and launching your apps, and using keyboard shortcuts
|
||||
- [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes and styles
|
||||
- [Searching & Shortcuts](/docs/searching.md) - Searching, launching methods + keyboard shortcuts
|
||||
- [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes + styles
|
||||
- [Widgets](/docs/widgets.md) - List of all dynamic content widgets, with usage guides and examples
|
||||
|
||||
## Misc
|
||||
|
||||
### Misc
|
||||
- [Privacy & Security](/docs/privacy.md) - List of requests, potential issues, and security resources
|
||||
- [License](/LICENSE) - Copy of the MIT License
|
||||
- [Legal](/.github/LEGAL.md) - Licenses of direct dependencies
|
||||
|
|
|
@ -21,17 +21,20 @@ For a full breakdown of each change, you can view the [Changelog](https://github
|
|||
All changes and new features are submitted as pull requests, which can then be tested, reviewed and (hopefully) merged into the master branch. Every time there is a change in the major version number, a new release is published. This usually happens every 2 weeks, on a Sunday.
|
||||
|
||||
When a PR is opened:
|
||||
|
||||
- The feature branch is built, and deployed as a Netlify instance. This can be accessed at: `https://deploy-preview-[pr-number]--dashy-dev.netlify.app`, and this URL as well as a link to the build logs are added as a comment on the PR by Netlify bot
|
||||
- Depending on what files were modified, the bot may also add a comment to remind the author of useful info
|
||||
- A series of checks will run on the new code, using GH Actions, and prevent merging if they fail. This includes: linting, testing, code quality and complexity checking, security scanning and a spell check
|
||||
- If a new dependency was added, liss-bot will comment with a summary of those changes, as well as the cost of the module, version, and any security concerns. If the bundle size has increased, this will also be added as a comment
|
||||
|
||||
After the PR is merged:
|
||||
- The app is build, and deployed to: https://dev.dashy.to
|
||||
|
||||
- The app is build, and deployed to: <https://dev.dashy.to>
|
||||
- A new tag in GitHub is created, using the apps version number (from the package.json)
|
||||
- The Docker container is built, and published under the `:latest` tag on DockerHub and GHCR
|
||||
|
||||
When a new major version is released:
|
||||
|
||||
- A new GitHub release is created and published, under new versions tag, with info from the changelog
|
||||
- The container is built and published under a new tag will be created on DockerHub, called `:release-[version]`
|
||||
- An announcement is opened in GitHub discussions, outlining the main changes, where users can comment and ask questions
|
||||
|
@ -43,19 +46,22 @@ When a new major version is released:
|
|||
## Git Strategy
|
||||
|
||||
### Git Flow
|
||||
|
||||
Like most Git repos, we are following the [Github Flow](https://guides.github.com/introduction/flow) standard.
|
||||
|
||||
1. Create a branch (or fork if you don'd have write acces)
|
||||
1. Create a branch (or fork if you don'd have write access)
|
||||
2. Code some awesome stuff, then add and commit your changes
|
||||
3. Create a Pull Request, complete the checklist and ensure the build succeeds
|
||||
4. Follow up with any reviews on your code
|
||||
5. Merge 🎉
|
||||
|
||||
### Git Branch Naming
|
||||
|
||||
The format of your branch name should be something similar to: `[TYPE]/[TICKET]_[TITLE]`
|
||||
For example, `FEATURE/420_Awesome-feature` or `FIX/690_login-server-error`
|
||||
|
||||
### Commit Emojis
|
||||
|
||||
Using a single emoji at the start of each commit message, to indicate the type task, makes the commit ledger easier to understand, plus it looks cool.
|
||||
|
||||
- 🎨 `:art:` - Improve structure / format of the code.
|
||||
|
@ -86,14 +92,17 @@ Using a single emoji at the start of each commit message, to indicate the type t
|
|||
For a full list of options, see [gitmoji.dev](https://gitmoji.dev/)
|
||||
|
||||
### PR Guidelines
|
||||
|
||||
Once you've made your changes, and pushed them to your fork or branch, you're ready to open a pull request!
|
||||
|
||||
For a pull request to be merged, it must:
|
||||
|
||||
- Must be backwards compatible
|
||||
- The build, lint and tests (run by GH actions) must pass
|
||||
- There must not be any merge conflicts
|
||||
|
||||
When you submit your PR, include the required info, by filling out the PR template. Including:
|
||||
|
||||
- A brief description of your changes
|
||||
- The issue, ticket or discussion number (if applicable)
|
||||
- For UI relate updates include a screenshot
|
||||
|
@ -104,8 +113,7 @@ When you submit your PR, include the required info, by filling out the PR templa
|
|||
|
||||
## Automated Workflows
|
||||
|
||||
Dashy makes heavy use of [GitHub Actions](https://github.com/features/actions) to fully automate the checking, testing, building, deploying of the project, as well as administration tasks like management of issues, tags, releases and documentation. The following section outlines each workflow, along with a link the the action file, current status and short description. A lot of these automations were made possible using community actions contributed to GH marketplace by some amazing people.
|
||||
|
||||
Dashy makes heavy use of [GitHub Actions](https://github.com/features/actions) to fully automate the checking, testing, building, deploying of the project, as well as administration tasks like management of issues, tags, releases and documentation. The following section outlines each workflow, along with a link the the action file, current status and short description. A lot of these automations were made possible using community actions contributed to GH marketplace by some amazing people.
|
||||
|
||||
### Code Processing
|
||||
|
||||
|
@ -155,4 +163,4 @@ Action | Description
|
|||
**Generate Credits** <br/>[![generate-credits.yml](https://github.com/Lissy93/dashy/actions/workflows/generate-credits.yml/badge.svg)](https://github.com/Lissy93/dashy/actions/workflows/generate-credits.yml) | Generates a report, including contributors, collaborators, sponsors, bots and helpful users. Will then insert a markdown table with thanks to these GitHub users and links to their profiles into the Credits page, as well as a summary of sponsors and top contributors into the main readme
|
||||
**Wiki Sync** <br/>[![wiki-sync.yml](https://github.com/Lissy93/dashy/actions/workflows/wiki-sync.yml/badge.svg)](https://github.com/Lissy93/dashy/actions/workflows/wiki-sync.yml) | Generates and publishes the repositories wiki page using the markdown files within the docs directory
|
||||
|
||||
---
|
||||
---
|
||||
|
|
|
@ -1,16 +1,20 @@
|
|||
# Keyboard Shortcuts
|
||||
|
||||
## Searching
|
||||
|
||||
One of the primary purposes of Dashy is to allow you to quickly find and launch a given app. To make this as quick as possible, there is no need to touch the mouse, or press a certain key to begin searching - just start typing. Results will be filtered in real-time. No need to worry about case, special characters or small typos, these are taken care of, and your results should appear.
|
||||
|
||||
## Navigating
|
||||
|
||||
You can navigate through your items or search results using the keyboard. You can use <kbd>Tab</kbd> to cycle through results, and <kbd>Shift</kbd> + <kbd>Tab</kbd> to go backwards. Or use the arrow keys, <kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd> and <kbd>←</kbd>.
|
||||
|
||||
## Launching Apps
|
||||
|
||||
You can launch a elected app by hitting <kbd>Enter</kbd>. This will open the app using your default opening method, specified in `target` (either `newtab`, `sametab`, `modal`, `top` or `workspace`). You can also use <kbd>Alt</kbd> + <kbd>Enter</kbd> to open the app in a pop-up modal, or <kbd>Ctrl</kbd> + <kbd>Enter</kbd> to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu.
|
||||
|
||||
## Tags
|
||||
By default, items are filtered by the `title` attribute, as well as the hostname (extracted from `url`), the `provider` and `description`. If you need to find results based on text which isn't included in these attributes, then you can add `tags` to a given item.
|
||||
|
||||
By default, items are filtered by the `title` attribute, as well as the hostname (extracted from `url`), the `provider` and `description`. If you need to find results based on text which isn't included in these attributes, then you can add `tags` to a given item.
|
||||
|
||||
```yaml
|
||||
items:
|
||||
|
@ -29,8 +33,8 @@ By default, items are filtered by the `title` attribute, as well as the hostname
|
|||
|
||||
In the above example, Plex will be visible when searching for 'movies', and FreshRSS with 'news'
|
||||
|
||||
|
||||
## Custom Hotkeys
|
||||
|
||||
For apps that you use regularly, you can set a custom keybinding. Use the `hotkey` parameter on a certain item to specify a numeric key, between `0 - 9`. You can then launch that app, by just pressing that key, which is much quicker than searching for it, if it's an app you use frequently.
|
||||
|
||||
```yaml
|
||||
|
@ -48,18 +52,23 @@ For apps that you use regularly, you can set a custom keybinding. Use the `hotke
|
|||
In the above example, pressing <kbd>2</kbd> will launch Bookstack. Or hitting <kbd>3</kbd> will open Git in the workspace view.
|
||||
|
||||
## Web Search
|
||||
|
||||
It's possible to search the web directly from Dashy, which might be useful if you're using Dashy as your start page. This can be done by typing your query as normal, and then pressing <kbd>⏎</kbd>. Web search options are configured under `appConfig.webSearch`.
|
||||
|
||||
### Setting Search Engine
|
||||
|
||||
Set your default search engine using the `webSearch.searchEngine` property. This defaults to DuckDuckGo. Search engine must be referenced by their key, the following providers are supported:
|
||||
|
||||
- [`duckduckgo`](https://duckduckgo.com), [`google`](https://google.com), [`whoogle`](https://whoogle.sdf.org), [`qwant`](https://www.qwant.com), [`startpage`](https://www.startpage.com), [`searx-bar`](https://searx.bar), [`searx-info`](https://searx.info)
|
||||
- [`searx-tiekoetter`](https://searx.tiekoetter.com), [`searx-bissisoft`](https://searx.bissisoft.com), [`ecosia`](https://www.ecosia.org), [`metager`](https://metager.org/meta), [`swisscows`](https://swisscows.com), [`mojeek`](https://www.mojeek.com)
|
||||
- [`wikipedia`](https://en.wikipedia.org), [`wolframalpha`](https://www.wolframalpha.com), [`stackoverflow`](https://stackoverflow.com), [`github`](https://github.com), [`reddit`](https://www.reddit.com), [`youtube`](https://youtube.com), [`bbc`](https://www.bbc.co.uk)
|
||||
|
||||
### Using Custom Search Engine
|
||||
|
||||
You can also use a custom search engine, that isn't included in the above list (like a self-hosted instance of [Whoogle](https://github.com/benbusby/whoogle-search) or [Searx](https://searx.github.io/searx/)). Set `searchEngine: custom`, and then specify the URL (plus query params) to you're search engine under `customSearchEngine`.
|
||||
|
||||
For example:
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
webSearch:
|
||||
|
@ -68,12 +77,14 @@ appConfig:
|
|||
```
|
||||
|
||||
### Setting Opening Method
|
||||
|
||||
In a similar way to opening apps, you can specify where you would like search results to be opened. This is done under the `openingMethod` attribute, and can be set to either `newtab`, `sametab` or `workspace`. By default results are opened in a new tab.
|
||||
|
||||
### Using Bangs
|
||||
|
||||
An insanely useful feature of DDG is [Bangs](https://duckduckgo.com/bang), where you type a specific character combination at the start of your search query, and it will be redirected the that website, such as '!w Docker' will display the Docker wikipedia page. Dashy has a similar feature, enabling you to define your own custom bangs to redirect search results to a specific app, website or search engine.
|
||||
|
||||
This is done under the `searchBangs` property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters.
|
||||
This is done under the `searchBangs` property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters.
|
||||
|
||||
For example:
|
||||
|
||||
|
@ -95,6 +106,7 @@ appConfig:
|
|||
Note that bangs begging with `!` or `:` must be surrounded them in quotes
|
||||
|
||||
### Disabling Web Search
|
||||
|
||||
Web search can be disabled, by setting `disableWebSearch`, for example:
|
||||
|
||||
```yaml
|
||||
|
@ -103,5 +115,6 @@ appConfig:
|
|||
```
|
||||
|
||||
## Clearing Search
|
||||
|
||||
You can clear your search term at any time, resting the UI to it's initial state, by pressing <kbd>Esc</kbd>.
|
||||
This can also be used to close any open pop-up modals.
|
||||
|
|
392
docs/showcase.md
|
@ -1,132 +1,260 @@
|
|||
# *Dashy Showcase* 🌟
|
||||
|
||||
| 💗 Do you use Dashy? Got a sweet dashboard? Submit it to the showcase! 👉 [See How](#submitting-your-dashboard) |
|
||||
|-|
|
||||
|
||||
### Home Lab 2.0
|
||||
|
||||
![screenshot-homelab](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png)
|
||||
|
||||
---
|
||||
|
||||
### Networking Services
|
||||
> By [@Lissy93](https://github.com/lissy93)
|
||||
|
||||
![screenshot-networking-services](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/2-networking-services-minimal-dark.png)
|
||||
|
||||
---
|
||||
|
||||
### Homelab & VPS dashboard
|
||||
> By [@shadowking001](https://github.com/shadowking001)
|
||||
|
||||
![screenshot-shadowking001-dashy](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/8-shadowking001s-dashy.png)
|
||||
|
||||
---
|
||||
|
||||
### EVO Dashboard
|
||||
|
||||
> By [@EVOTk](https://github.com/EVOTk)
|
||||
|
||||
![screenshot-evo-dashboard](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/12-evo-dashboard.png)
|
||||
|
||||
---
|
||||
|
||||
### NAS Home Dashboard
|
||||
> By [@cerealconyogurt](https://github.com/cerealconyogurt)
|
||||
|
||||
![screenshot-networking-services](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/6-nas-home-dashboard.png)
|
||||
|
||||
---
|
||||
|
||||
### Dashy Live
|
||||
> By [@Lissy93](https://github.com/lissy93)
|
||||
|
||||
> A dashboard I made to manage all project development links from one place. View demo at [live.dashy.to](https://live.dashy.to/).
|
||||
|
||||
![screenshot-dashy-live](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/10-dashy-live.png)
|
||||
|
||||
### CFT Toolbox
|
||||
|
||||
![screenshot-cft-toolbox](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/3-cft-toolbox.png)
|
||||
|
||||
---
|
||||
|
||||
### Bookmarks
|
||||
|
||||
![screenshot-bookmarks](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/4-bookmarks-colourful.png)
|
||||
|
||||
---
|
||||
|
||||
### Project Management
|
||||
|
||||
![screenshot-project-managment](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/5-project-managment.png)
|
||||
|
||||
---
|
||||
|
||||
### Dashy Example
|
||||
|
||||
> An example dashboard, by [@Lissy93](https://github.com/lissy93). View live at [demo.dashy.to](https://demo.dashy.to/).
|
||||
|
||||
![screenshot-dashy-example](https://i.ibb.co/YbzqPK7/demo-dashy.png)
|
||||
|
||||
---
|
||||
|
||||
### First Week of Self-Hosting
|
||||
> By [u//RickyCZ](https://www.reddit.com/user/RickyCZ)
|
||||
|
||||
![screenshot-week-of-self-hosting](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/11-ricky-cz.png)
|
||||
|
||||
---
|
||||
|
||||
### HomeLAb 3.0
|
||||
|
||||
> By [@skoogee](https://github.com/skoogee) (http://zhrn.cc)
|
||||
|
||||
> Dashy, is the most complete dashboard I ever tried, has all the features, and it sets itself apart from the rest. It is my default homepage now. I am thankful to the developer @Lissy93 for sharing such a wonderful creation.
|
||||
|
||||
[![screenshot-12-skoogee-homelab-3](https://i.ibb.co/F5yBTsT/12-skoogee-homelab-3.png)](https://ibb.co/album/ynSwzm)
|
||||
|
||||
---
|
||||
|
||||
### Ground Control
|
||||
> By [@dtctek](https://github.com/dtctek)
|
||||
|
||||
![screenshot-ground-control](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/7-ground-control-dtctek.png)
|
||||
|
||||
---
|
||||
|
||||
### Yet Another Homelab
|
||||
|
||||
![screenshot-yet-another-homelab](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/9-home-lab-oblivion.png)
|
||||
|
||||
---
|
||||
|
||||
## Submitting your Dashboard
|
||||
|
||||
#### How to Submit
|
||||
- [Open an Issue](https://git.io/JEtgM)
|
||||
- [Open a PR](https://github.com/Lissy93/dashy/compare)
|
||||
|
||||
#### What to Include
|
||||
Please include the following information:
|
||||
- A single high-quality screenshot of your Dashboard
|
||||
- A short title (it doesn't have to be particularly imaginative)
|
||||
- An optional description, you could include details on anything interesting or unique about your dashboard, or say how you use it, and why it's awesome
|
||||
- Optionally leave your name or username, with a link to your GitHub, Twitter or Website
|
||||
|
||||
#### Template
|
||||
|
||||
If you're submitting a pull request, please use a format similar to this:
|
||||
|
||||
```
|
||||
### [Dashboard Name] (required)
|
||||
|
||||
> Submitted by [@username](https://github.com/user) (optional)
|
||||
|
||||
![dashboard-screenshot](/docs/showcase/screenshot-name.jpg) (required)
|
||||
|
||||
[An optional text description, or any interesting details] (optional)
|
||||
|
||||
---
|
||||
|
||||
```
|
||||
# *Dashy Showcase* 🌟
|
||||
|
||||
| 💗 Got a sweet dashboard? Submit it to the showcase! 👉 [See How](#submitting-your-dashboard) |
|
||||
|-|
|
||||
|
||||
## MNDashboard
|
||||
|
||||
> By [@mahrnet](https://github.com/mahrnet) <sup>Re: [#1491](https://github.com/Lissy93/dashy/issues/1491)</sup>
|
||||
|
||||
![screenshot-MNDashboard](https://i.ibb.co/mCJRZgp/d2-At-QO4c-PT4u.png)
|
||||
|
||||
---
|
||||
|
||||
## Home Lab 2.0
|
||||
|
||||
![screenshot-homelab](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/1-home-lab-material.png)
|
||||
|
||||
---
|
||||
|
||||
## Dipan's Dash
|
||||
|
||||
> By [@Dipanghosh](https://github.com/dipanghosh) - [dipan.de](https://dipan.de/) <sup>Re: [#777](https://github.com/Lissy93/dashy/discussions/777)</sup>
|
||||
|
||||
> With the option of embedding iframes, it becomes possible to combine and conquer. I have set up Dashy to include graphs from grafana, and set them so that they update automatically. I also have uptime monitors from uptime Kuma, panels from homeassistant are also possible to be included.<br>
|
||||
> Dashy is awesome!
|
||||
|
||||
![screenshot-dipanghosh-dashboard](https://i.ibb.co/bPC6w2n/dipanghosh-dashboard.png)
|
||||
|
||||
---
|
||||
|
||||
## Ratty222
|
||||
|
||||
> By [@ratty222](https://github.com/ratty222) <sup>Re: [#384](https://github.com/Lissy93/dashy/discussions/384)</sup>
|
||||
|
||||
![screenshot-ratty222-dashy](https://user-images.githubusercontent.com/1862727/147582551-4c655d37-8bcc-4f95-ab41-164a9d0d6a07.png)
|
||||
|
||||
---
|
||||
|
||||
## Hugalafutro Dashy
|
||||
|
||||
> By [@hugalafutro](https://github.com/hugalafutro) <sup>Re: [#505](https://github.com/Lissy93/dashy/discussions/505)</sup>
|
||||
|
||||
[![hugalafutro-dashy-screenshot](https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif)](https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif)
|
||||
|
||||
---
|
||||
|
||||
## NAS Home Dashboard
|
||||
|
||||
> By [@cerealconyogurt](https://github.com/cerealconyogurt) <sup>Re: [#74](https://github.com/Lissy93/dashy/issues/74)</sup>
|
||||
|
||||
![screenshot-networking-services](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/6-nas-home-dashboard.png)
|
||||
|
||||
---
|
||||
|
||||
## Brewhack
|
||||
|
||||
> By [@brpeterso](https://github.com/brpeterso) <sup>Re: [#680](https://github.com/Lissy93/dashy/issues/680)</sup>
|
||||
|
||||
![screenshot-brewhack-dashboard](https://i.ibb.co/cNjzPT4/brewhack.png)
|
||||
|
||||
---
|
||||
|
||||
## The Dragons Lair
|
||||
|
||||
> By [dr460nf1r3](https://github.com/dr460nf1r3) <sup>via [#684](https://github.com/Lissy93/dashy/issues/684)</sup>
|
||||
|
||||
> My new startpage featuring the stuff I use most. And of course dragons!
|
||||
|
||||
![screenshot-dragons-lair](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png)
|
||||
|
||||
---
|
||||
|
||||
## Homelab & VPS dashboard
|
||||
|
||||
> By [@shadowking001](https://github.com/shadowking001) <sup>Re: [#86](https://github.com/Lissy93/dashy/issues/86)</sup>
|
||||
|
||||
![screenshot-shadowking001-dashy](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/8-shadowking001s-dashy.png)
|
||||
|
||||
---
|
||||
|
||||
## Raspberry PI Docker Dashboard
|
||||
|
||||
> By [@henkiewie](https://github.com/henkiewie) <sup>Re: [#622](https://github.com/Lissy93/dashy/issues/622)</sup>
|
||||
|
||||
> I use this dashboard every day. It now even includes a player for a radio stream which I configured with Logitech media server and icecast. I made an smaller version of the grafana dashboard to fit an iframe in kiosk mode, so it monitors the most important values of my RPI. The PI is in Argon m2 case and used as a NAS. The dashboard is a copy of the adventure theme with some changes saved in `/app/src/styles/user-defined-themes.scss`
|
||||
|
||||
![screenshot-henkiewie-dashy](https://i.ibb.co/jGzPm6b/henkiewie-dashy-showcase.png)
|
||||
|
||||
---
|
||||
|
||||
## First Week of Self-Hosting
|
||||
|
||||
> By [u//RickyCZ](https://www.reddit.com/user/RickyCZ) <sup>via [Reddit](https://www.reddit.com/r/selfhosted/comments/pose15/just_got_started_a_week_ago_selfhosting_is_very/)</sup>
|
||||
|
||||
![screenshot-week-of-self-hosting](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/11-ricky-cz.png)
|
||||
|
||||
---
|
||||
|
||||
## EVO Dashboard
|
||||
|
||||
> By [@EVOTk](https://github.com/EVOTk) <sup>Re: [#316](https://github.com/Lissy93/dashy/pull/316)</sup>
|
||||
|
||||
![screenshot-evo-dashboard](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/12-evo-dashboard.png)
|
||||
|
||||
---
|
||||
|
||||
## The Private Dashboard
|
||||
|
||||
> By [@DylanBeMe](https://github.com/DylanBeMe) <sup>Re: [#419](https://github.com/Lissy93/dashy/issues/419)</sup>
|
||||
|
||||
![screenshot-private-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png)
|
||||
|
||||
---
|
||||
|
||||
## Networking Services
|
||||
|
||||
> By [@Lissy93](https://github.com/lissy93)
|
||||
|
||||
![screenshot-networking-services](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/2-networking-services-minimal-dark.png)
|
||||
|
||||
---
|
||||
|
||||
## Dashy Live
|
||||
|
||||
> By [@Lissy93](https://github.com/lissy93)
|
||||
|
||||
> A dashboard I made to manage all project development links from one place. View demo at [live.dashy.to](https://live.dashy.to/).
|
||||
|
||||
![screenshot-dashy-live](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/10-dashy-live.png)
|
||||
|
||||
---
|
||||
|
||||
## System Monitor
|
||||
|
||||
> An aggregated board for monitoring system resource usage from a single view
|
||||
|
||||
![screenshot-monitor](https://i.ibb.co/xfK6BGb/system-monitor-board.png)
|
||||
|
||||
---
|
||||
|
||||
## Browser Startpage
|
||||
|
||||
![screenshot-startpage](https://i.ibb.co/rs07dS1/startpage.png)
|
||||
|
||||
---
|
||||
|
||||
## CFT Toolbox
|
||||
|
||||
![screenshot-cft-toolbox](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/3-cft-toolbox.png)
|
||||
|
||||
---
|
||||
|
||||
## Bookmarks
|
||||
|
||||
![screenshot-bookmarks](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/4-bookmarks-colourful.png)
|
||||
|
||||
---
|
||||
|
||||
## Project Management
|
||||
|
||||
![screenshot-project-management](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/5-project-management.png)
|
||||
|
||||
---
|
||||
|
||||
## Dashy Example
|
||||
|
||||
> An example dashboard, by [@Lissy93](https://github.com/lissy93). View live at [demo.dashy.to](https://demo.dashy.to/).
|
||||
|
||||
![screenshot-dashy-example](https://i.ibb.co/YbzqPK7/demo-dashy.png)
|
||||
|
||||
---
|
||||
|
||||
## HomeLAb 3.0
|
||||
|
||||
> By [@skoogee](https://github.com/skoogee) (<http://zhrn.cc>) <sup>[#279](https://github.com/Lissy93/dashy/issues/279)</sup>
|
||||
|
||||
> Dashy, is the most complete dashboard I ever tried, has all the features, and it sets itself apart from the rest. It is my default homepage now. I am thankful to the developer @Lissy93 for sharing such a wonderful creation.
|
||||
|
||||
[![screenshot-12-skoogee-homelab-3](https://i.ibb.co/F5yBTsT/12-skoogee-homelab-3.png?)](https://ibb.co/album/ynSwzm)
|
||||
|
||||
---
|
||||
|
||||
## Ground Control
|
||||
|
||||
> By [@dtctek](https://github.com/dtctek) <sup>Re: [#83](https://github.com/Lissy93/dashy/issues/83)</sup>
|
||||
|
||||
![screenshot-ground-control](https://user-images.githubusercontent.com/1862727/149821995-e9b41dab-186c-42e6-b5b3-e233259b241d.png)
|
||||
|
||||
---
|
||||
|
||||
## Croco_Grievous
|
||||
|
||||
> By [u/Croco_Grievous](https://www.reddit.com/user/Croco_Grievous/) <sup>via [reddit](https://www.reddit.com/r/selfhosted/comments/t4xk3z/everything_started_with_pihole_on_a_raspberry_pi/)</sup>
|
||||
|
||||
![screenshot-croco-grievous-dashy](https://i.ibb.co/59XR8KL/dashy-Croco-Grievous.png)
|
||||
|
||||
---
|
||||
|
||||
## Crypto Dash
|
||||
|
||||
> Example usage of widgets to monitor cryptocurrencies news, prices and data. Config is [available here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10#file-example-8-dashy-crypto-widgets-conf-yml)
|
||||
|
||||
![screenshot-crypto-dash](https://user-images.githubusercontent.com/1862727/147394584-352fe3bf-740d-4624-a01b-9003a97bc832.png)
|
||||
|
||||
---
|
||||
|
||||
## Stefantigro
|
||||
|
||||
> By [u/stefantigro](https://www.reddit.com/user/stefantigro/) <sup>via [reddit](https://www.reddit.com/r/selfhosted/comments/t5oril/been_selfhosting_close_to_half_a_year_now_all/)</sup>
|
||||
|
||||
![screenshot-stefantigro-dashy](https://i.ibb.co/1Kb43Yy/dashy-stefantigro.png)
|
||||
|
||||
---
|
||||
|
||||
## Morning Dashboard
|
||||
|
||||
> Displayed on my smart screen between 05:00 - 08:00, and includes all the info that I usually check before leaving for work
|
||||
|
||||
![screenshot-morning-dash](https://i.ibb.co/4Wx8zb7/morning-dashboard.png)
|
||||
|
||||
---
|
||||
|
||||
## Yet Another Homelab
|
||||
|
||||
![screenshot-yet-another-homelab](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/9-home-lab-oblivion.png)
|
||||
|
||||
---
|
||||
|
||||
## Submitting your Dashboard
|
||||
|
||||
### How to Submit
|
||||
|
||||
- [Open an Issue](https://git.io/JEtgM)
|
||||
- [Open a PR](https://github.com/Lissy93/dashy/compare)
|
||||
|
||||
### What to Include
|
||||
|
||||
Please include the following information:
|
||||
|
||||
- A single high-quality screenshot of your Dashboard
|
||||
- A short title (it doesn't have to be particularly imaginative)
|
||||
- An optional description, you could include details on anything interesting or unique about your dashboard, or say how you use it, and why it's awesome
|
||||
- Optionally leave your name or username, with a link to your GitHub, Twitter or Website
|
||||
|
||||
### Template
|
||||
|
||||
If you're submitting a pull request, please use a format similar to this:
|
||||
|
||||
```text
|
||||
### [Dashboard Name] (required)
|
||||
|
||||
> Submitted by [@username](https://github.com/user) (optional)
|
||||
|
||||
[An optional text description, or any interesting details] (optional)
|
||||
|
||||
![dashboard-screenshot](https://example.com/url-to-screenshot.png) (required)
|
||||
|
||||
---
|
||||
|
||||
```
|
||||
|
|
After Width: | Height: | Size: 269 KiB |
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
|
@ -1,21 +1,24 @@
|
|||
# Status Indicators
|
||||
|
||||
Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message
|
||||
Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message.
|
||||
|
||||
<p align="center">
|
||||
<img width="800" src="/docs/assets/status-check-demo.gif" />
|
||||
</p>
|
||||
|
||||
## Enabling Status Indicators
|
||||
By default, this feature is off. If you do not want this feature, just don't add the `statusCheck` to your conf.yml file, then no requests will be made.
|
||||
|
||||
By default, this feature is off. If you do not want this feature, just don't add the `statusCheck` to your conf.yml file, then no requests will be made.
|
||||
|
||||
To enable status checks, you can either turn it on for all items, by setting `appConfig.statusCheck: true`, like:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
statusCheck: true
|
||||
```
|
||||
|
||||
Or you can enable/ disable it on a per-item basis, with the `item[n].statusCheck` attribute
|
||||
|
||||
```yaml
|
||||
sections:
|
||||
- name: Firewall
|
||||
|
@ -38,49 +41,68 @@ sections:
|
|||
```
|
||||
|
||||
## Continuous Checking
|
||||
|
||||
By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the `statusCheckInterval` attribute. Here you define an interval as an integer in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower.
|
||||
|
||||
The following example, will instruct Dashy to continuously check the status of your services every 20 seconds
|
||||
The following example, will instruct Dashy to continuously check the status of your services every 20 seconds.
|
||||
|
||||
```
|
||||
```text
|
||||
appConfig:
|
||||
statusCheck: true
|
||||
statusCheckInterval: 20
|
||||
```
|
||||
|
||||
## Using a Different Endpoint
|
||||
By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring.
|
||||
|
||||
By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring.
|
||||
|
||||
You can set the `statusCheckUrl` property on any given item in order to do this. The status checker will then ping that endpoint, instead of the apps main `url` property.
|
||||
|
||||
## Setting Custom Headers
|
||||
|
||||
If your service is responding with an error, despite being up and running, it is most likely because custom headers for authentication, authorization or encoding are required. You can define these headers under the `statusCheckHeaders` property for any service. It should be defined as an object format, with the name of header as the key, and header content as the value.
|
||||
For example, `statusCheckHeaders: { 'X-Custom-Header': 'foobar' }`
|
||||
|
||||
## Disabling Security
|
||||
|
||||
By default, (if you're using HTTPS) any requests to insecure or non-HTTPS content will be blocked. This will cause the status check to fail. If you trust the endpoint (e.g. you're self-hosting it), then you can disable this security measure for an individual item. This is done by setting `statusCheckAllowInsecure: true`
|
||||
|
||||
## Allowing Alternative Status Codes
|
||||
|
||||
If you expect your service to return a status code that is not in the 2XX range, and still want the indicator to be green, then you can specify an expected status code under `statusCheckAcceptCodes` for a given item. For example, `statusCheckAcceptCodes: '403,418'`
|
||||
|
||||
## Troubleshooting Failing Status Checks
|
||||
If the status is always returning an error, despite the service being online, then it is most likely an issue with access control, and should be fixed with the correct headers. Hover over the failing status to see the error code and response, in order to know where to start with addressing it.
|
||||
If your service requires requests to include any authorization in the headers, then use the `statusCheckHeaders` property, as described above.
|
||||
|
||||
If you're using status checks, and despite a given service being online, the check is displaying an error, there are a couple of things you can look at:
|
||||
|
||||
If your service requires requests to include any authorization in the headers, then use the `statusCheckHeaders` property, as described [above](#setting-custom-headers).
|
||||
|
||||
If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a [CORS error](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), and can be fixed by setting the headers on your target app, to include:
|
||||
```
|
||||
Access-Control-Allow-Origin: https://[dashy-location]/
|
||||
|
||||
```text
|
||||
Access-Control-Allow-Origin: https://location-of-dashy/
|
||||
Vary: Origin
|
||||
```
|
||||
If the URL you are checking is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting `statusCheckAllowInsecure` to true for a given item.
|
||||
|
||||
If the URL you are checking has an unsigned certificate, or is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting `statusCheckAllowInsecure` to true for a given item.
|
||||
|
||||
If your service is online, but responds with a status code that is not in the 2xx range, then you can use `statusCheckAcceptCodes` to set an accepted status code.
|
||||
|
||||
If you get an error, like `Service Unavailable: Server resulted in a fatal error`, even when it's definitely online, this is most likely caused by missing the protocol. Don't forget to include `https://` (or whatever protocol) before the URL, and ensure that if needed, you've specified the port.
|
||||
|
||||
Running Dashy in HOST network mode, instead of BRIDGE will allow status check access to other services in HOST mode. For more info, see [#445](https://github.com/Lissy93/dashy/discussions/445).
|
||||
|
||||
If you have firewall rules configured, then ensure that they don't prevent Dashy from making requests to the other services you are trying to access.
|
||||
|
||||
Currently, the status check needs a page to be rendered, so if this URL in your browser does not return anything, then status checks will not work. This may be modified in the future, but in the meantime, a fix would be to make your own status service, which just checks if your app responds with whatever code you'd like, and then return a 200 plus renders an arbitrary message. Then just point `statusCheckUrl` to your custom page.
|
||||
|
||||
For further troubleshooting, use an application like [Postman](https://postman.com) to diagnose the issue. Set the parameter to `GET`, and then make a call to: `https://[url-of-dashy]/status-check/?&url=[service-url]`. Where the service URL must have first been encoded (e.g. with `encodeURIComponent()` or [urlencoder.io](https://www.urlencoder.io/))
|
||||
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
|
||||
## How it Works
|
||||
|
||||
When the app is loaded, if `appConfig.statusCheck: true` is set, or if any items have the `statusCheck: true` enabled, then Dashy will make a request, to `https://[your-host-name]/status-check?url=[address-or-servce]` (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request.
|
||||
When the app is loaded, if `appConfig.statusCheck: true` is set, or if any items have the `statusCheck: true` enabled, then Dashy will make a request, to `https://[your-host-name]/status-check?url=[address-or-servce]` (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request.
|
||||
|
||||
When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
## Theming
|
||||
# Theming
|
||||
|
||||
By default Dashy comes with 20 built in themes, which can be applied from the dropwodwn menu in the UI
|
||||
By default Dashy comes with 25+ built-in themes, which can be applied from the dropdown menu in the UI.
|
||||
|
||||
![Built-in Themes](https://i.ibb.co/GV3wRss/Dashy-Themes.png)
|
||||
|
||||
|
@ -10,8 +10,7 @@ You can customize Dashy by writing your own CSS, which can be loaded either as a
|
|||
|
||||
The following content requires that you have a basic understanding of CSS. If you're just beginning, you may find [this article](https://developer.mozilla.org/en-US/docs/Learn/CSS/First_steps) helpful.
|
||||
|
||||
|
||||
### How Theme-Switching Works
|
||||
## How Theme-Switching Works
|
||||
|
||||
The theme switching is done by simply changing the `data-theme` attribute on the root DOM element, which can then be targeted by CSS. First off, in order for the theme to show up in the theme switcher, it needs to be added to the config file, under `appConfig.cssThemes`, either as a string, or an array of strings for multiple themes. For example:
|
||||
|
||||
|
@ -33,7 +32,7 @@ Finally, from the UI use the theme dropdown menu to select your new theme, and y
|
|||
|
||||
You can also set `appConfig.theme` to pre-select a default theme, which will be applied immediately after deployment.
|
||||
|
||||
### Modifying Theme Colors
|
||||
## Modifying Theme Colors
|
||||
|
||||
Themes can be modified either through the UI, using the color picker menu (to the right of the theme dropdown), or directly in the config file, under `appConfig.customColors`. Here you can specify the value for any of the [available CSS variables](#css-variables).
|
||||
|
||||
|
@ -59,17 +58,27 @@ appConfig:
|
|||
primary: '#8be9fd'
|
||||
```
|
||||
|
||||
### Adding your own Theme
|
||||
## Adding your own Theme
|
||||
|
||||
User-defined styles and custom themes should be defined in `./src/styles/user-defined-themes.scss`. If you're using Docker, you can pass your own stylesheet in using the `--volume` flag. E.g. `v ./my-themes.scss:/app/src/styles/user-defined-themes.scss`. Don't forget to pass your theme name into `appConfig.cssThemes` so that it shows up on the theme-switcher dropdown.
|
||||
|
||||
### Setting Custom CSS in the UI
|
||||
## Setting Custom CSS in the UI
|
||||
|
||||
Custom CSS can be developed, tested and applied directly through the UI. Although you will need to make note of your changes to apply them across instances.
|
||||
|
||||
This can be done from the Config menu (spanner icon in the top-right), under the Custom Styles tab. This is then associated with `appConfig.customCss` in local storage. Styles can also be directly applied to this attribute in the config file, but this may get messy very quickly if you have a lot of CSS.
|
||||
|
||||
### Loading External Stylesheets
|
||||
## Page-Specific Styles
|
||||
|
||||
If you've got multiple pages within your dashboard, you can choose to target certain styles to specific pages. The top-most element within `<body>` will have a class name specific to the current sub-page. This is usually the page's name, all lowercase, with dashes instead of spaces, but you can easily check this yourself within the dev tools.
|
||||
|
||||
For example, if the pages name was "CFT Toolbox", and you wanted to target `.item`s, you would do:
|
||||
|
||||
```css
|
||||
.cft-toolbox .item { border: 4px solid yellow; }
|
||||
```
|
||||
|
||||
## Loading External Stylesheets
|
||||
|
||||
The URI of a stylesheet, either local or hosted on a remote CDN can be passed into the config file. The attribute `appConfig.externalStyleSheet` accepts either a string, or an array of strings. You can also pass custom font stylesheets here, they must be in a CSS format (for example, `https://fonts.googleapis.com/css2?family=Cutive+Mono`).
|
||||
This is handled in [`ThemeHelper.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/ThemeHelper.js).
|
||||
|
@ -85,14 +94,16 @@ appConfig:
|
|||
appConfig:
|
||||
externalStyleSheet: ['/themes/my-theme-1.css', '/themes/my-theme-2.css']
|
||||
```
|
||||
### Hard-Coding Section or Item Colors
|
||||
|
||||
## Hard-Coding Section or Item Colors
|
||||
|
||||
Some UI components have a color option, that can be set in the config file, to force the color of a given item or section no matter what theme is selected. These colors should be expressed as hex codes (e.g. `#fff`) or HTML colors (e.g. `red`). The following attributes are supported:
|
||||
|
||||
- `section.color` - Custom color for a given section
|
||||
- `item.color` - Font and icon color for a given item
|
||||
- `item.backgroundColor` - Background color for a given icon
|
||||
|
||||
### Typography
|
||||
## Typography
|
||||
|
||||
Essential fonts bundled within the app are located within `./src/assets/fonts/`. All optional fonts that are used by themes are stored in `./public/fonts/`, if you want to add your own font, this is where you should put it. As with assets, if you're using Docker then using a volume to link a directory on your host system with this path within the container will make management much easier.
|
||||
|
||||
|
@ -100,7 +111,7 @@ Fonts which are not being used by the current theme are **not** fetched on page
|
|||
|
||||
Full credit to the typographers behind each of the included fonts. Specifically: Matt McInerney, Christian Robertson, Haley Fiege, Peter Hull, Cyreal and the legendary Vernon Adams
|
||||
|
||||
### CSS Variables
|
||||
## CSS Variables
|
||||
|
||||
All colors as well as other variable values (such as borders, border-radius, shadows) are specified as CSS variables. This makes theming the application easy, as you only need to change a given color or value in one place. You can find all variables in [`color-palette.scss`](https://github.com/Lissy93/dashy/blob/master/src/styles/color-palette.scss) and the themes which make use of these color variables are specified in [`color-themes.scss`](https://github.com/Lissy93/dashy/blob/master/src/styles/color-themes.scss)
|
||||
|
||||
|
@ -108,7 +119,8 @@ CSS variables are simple to use. You define them like: `--background: #fff;` and
|
|||
|
||||
You can determine the variable used by any given element, and visualize changes using the browser developer tools (Usually opened with `F12`, or Options --> More --> Developer Tools). Under the elements tab, click the Element Selector icon (usually top-left corner), you will then be able to select any DOM element on the page by hovering and clicking it. In the CSS panel you will see all styles assigned to that given element, including CSS variables. Click a variable to see it's parent value, and for color attributes, click the color square to modify the color. For more information, see this [getting started guide](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools), and these articles on [selecting elements](https://developer.mozilla.org/en-US/docs/Tools/Page_Inspector/How_to/Select_an_element) and [inspecting and modifying colors](https://developer.mozilla.org/en-US/docs/Tools/Page_Inspector/How_to/Inspect_and_select_colors).
|
||||
|
||||
#### Top-Level Variables
|
||||
### Top-Level Variables
|
||||
|
||||
These are all that are required to create a theme. All other variables inherit their values from these variables, and can optionally be overridden.
|
||||
|
||||
- `--primary` - Application primary color. Used for title, text, accents, and other features
|
||||
|
@ -117,15 +129,15 @@ These are all that are required to create a theme. All other variables inherit t
|
|||
- `--curve-factor` - The border radius used globally throughout the application. Specified in `px`, defaults to `5px`
|
||||
- `--dimming-factor` - Inactive elements have slight transparency. This can be between `0` (invisible) and `1` (normal), defaults to `0.7`
|
||||
|
||||
### Targeted Color Variables
|
||||
|
||||
#### Targeted Color Variables
|
||||
You can target specific elements on the UI with these variables. All are optional, since by default, they inherit their values from above
|
||||
|
||||
- `--heading-text-color` - Text color for web page heading and sub-heading. Defaults to `--primary`
|
||||
- `--nav-link-text-color` - The text color for links displayed in the navigation bar. Defaults to `--primary`
|
||||
- `--nav-link-background-color` - The background color for links displayed in the navigation bar
|
||||
- `--nav-link-text-color-hover` - The text color when a navigation bar link is hovered over. Defaults to `--primary`
|
||||
- `--nav-link-background-color-hover` - The background color for nav bar links when hovered over
|
||||
- `--nav-link-background-color-hover` - The background color for nav bar links when hovered over
|
||||
- `--nav-link-border-color` - The border color for nav bar links. Defaults to `transparent`
|
||||
- `--nav-link-border-color-hover` - The border color for nav bar links when hovered over. Defaults to `--primary`
|
||||
- `--search-container-background` - Background for the container containing the search bar. Defaults to `--background-darker`
|
||||
|
@ -161,7 +173,8 @@ You can target specific elements on the UI with these variables. All are optiona
|
|||
- `--context-menu-background` - Background color of right-click context menu. Defaults to `--background`
|
||||
- `--context-menu-secondary-color` - Border and outline color for context menu. Defaults to `--background-darker`
|
||||
|
||||
#### Non-Color Variables
|
||||
### Non-Color Variables
|
||||
|
||||
- `--outline-color` - Used to outline focused or selected elements
|
||||
- `--curve-factor-navbar` - The border radius of the navbar. Usually this is greater than `--curve-factor`
|
||||
- `--scroll-bar-width` - Width of horizontal and vertical scroll bars. E.g. `8px`
|
||||
|
@ -173,7 +186,8 @@ You can target specific elements on the UI with these variables. All are optiona
|
|||
- `--item-group-shadow` - The shadow for an item group/ section. Defaults to `--item-shadow`
|
||||
- `--settings-container-shadow` - A shadow property for the settings container. E.g. `none`
|
||||
|
||||
#### Action Colors
|
||||
### Action Colors
|
||||
|
||||
These colors represent intent, and so are not often changed, but you can do so if you wish
|
||||
|
||||
- `--info` - Information color, usually blue / `#04e4f4`
|
||||
|
@ -183,5 +197,3 @@ These colors represent intent, and so are not often changed, but you can do so i
|
|||
- `--neutral` - Neutral color, usually grey / `#272f4d`
|
||||
- `--white` - Just white / `#fff`
|
||||
- `--black` - Just black / `#000`
|
||||
|
||||
|
||||
|
|
|
@ -1,25 +1,97 @@
|
|||
# Troubleshooting
|
||||
|
||||
This document contains common problems and their solutions.
|
||||
> _**This document contains common problems and their solutions.**_<br>
|
||||
> Please ensure your issue isn't listed here, before opening a new ticket.
|
||||
>
|
||||
> _Found something not listed here? Consider adding it, to help other users._
|
||||
|
||||
## Contents
|
||||
|
||||
- [Config not saving](#config-not-saving)
|
||||
- [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
|
||||
- [404 On Static Hosting](#404-on-static-hosting)
|
||||
- [404 from Mobile Home Screen](#404-after-launch-from-mobile-home-screen)
|
||||
- [Yarn Build or Run Error](#yarn-error)
|
||||
- [Remote Config Not Loading](#remote-config-not-loading)
|
||||
- [Heap limit Allocation failed](#ineffective-mark-compacts-near-heap-limit-allocation-failed)
|
||||
- [Command failed with signal "SIGKILL"](#command-failed-with-signal-sigkill)
|
||||
- [Auth Validation Error: "should be object"](#auth-validation-error-should-be-object)
|
||||
- [App Not Starting After Update to 2.0.4](#app-not-starting-after-update-to-204)
|
||||
- [Keycloak Redirect Error](#keycloak-redirect-error)
|
||||
- [Docker Directory Error](#docker-directory)
|
||||
- [Config not Saving on Vercel / Netlify / CDN](#user-content-config-not-saving-on-vercel--netlify--cdn)
|
||||
- [Config Not Updating](#config-not-updating)
|
||||
- [Config Still not Updating](#config-still-not-updating)
|
||||
- [Styles and Assets not Updating](#styles-and-assets-not-updating)
|
||||
- [DockerHub toomanyrequests](#dockerhub-toomanyrequests)
|
||||
- [Config Validation Errors](#config-validation-errors)
|
||||
- [Node Sass unsupported environment](#node-sass-does-not-yet-support-your-current-environment)
|
||||
- [Unreachable Code Error](#unreachable-code-error)
|
||||
- [Cannot find module './_baseValues'](#error-cannot-find-module-_basevalues)
|
||||
- [Ngrok Invalid Host Headers](#invalid-host-header-while-running-through-ngrok)
|
||||
- [Warnings in the Console during deploy](#warnings-in-the-console-during-deploy)
|
||||
- [Docker Login Fails on Ubuntu](#docker-login-fails-on-ubuntu)
|
||||
- [Status Checks Failing](#status-checks-failing)
|
||||
- [Diagnosing Widget Errors](#widget-errors)
|
||||
- [Fixing Widget CORS Errors](#widget-cors-errors)
|
||||
- [Widget Shows Error Incorrectly](#widget-shows-error-incorrectly)
|
||||
- [Weather Forecast Widget 401](#weather-forecast-widget-401)
|
||||
- [Widget Displaying Inaccurate Data](#widget-displaying-inaccurate-data)
|
||||
- [Font Awesome Icons not Displaying](#font-awesome-icons-not-displaying)
|
||||
- [Copy to Clipboard not Working](#copy-to-clipboard-not-working)
|
||||
- [Unsupported Digital Envelope Routines](#unsupported-digital-envelope-routines)
|
||||
- [How to Reset Local Settings](#how-to-reset-local-settings)
|
||||
- [How to make a bug report](#how-to-make-a-bug-report)
|
||||
- [How-To Open Browser Console](#how-to-open-browser-console)
|
||||
- [Git Contributions not Displaying](#git-contributions-not-displaying)
|
||||
|
||||
---
|
||||
|
||||
## Config not saving
|
||||
|
||||
### Possible Issue 1: Unable to call save endpoint from CDN/static server
|
||||
If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.
|
||||
You'll instead need to copy the YAML after making your changes, and paste that into your `conf.yml` directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes.
|
||||
Look here for more information: [https://dashy.to/docs/deployment#deploy-to-cloud-service](https://dashy.to/docs/deployment#deploy-to-cloud-service)
|
||||
|
||||
If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected.
|
||||
|
||||
See also [#1465](https://github.com/Lissy93/dashy/issues/1465)
|
||||
|
||||
### Possible Issue 2: Unable to save
|
||||
In Docker, double check that the file isn't read-only, and that the container actually has permissions to modify it. You shouldn't really be running it as a root user, and I'm not sure if it will work if you do-
|
||||
|
||||
### Possible Issue 3: Saved but not updating
|
||||
After saving, the frontend will recompile, which may take a couple seconds (or a bit longer on a Pi or low-powered device). If it doesn't recompile, you can manually trigger a re-build.
|
||||
|
||||
---
|
||||
|
||||
## `Refused to Connect` in Modal or Workspace View
|
||||
|
||||
This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements. It can be fixed by setting the [`X-Frame-Options`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) HTTP header set to `ALLOW [path to Dashy]` or `SAMEORIGIN`, as defined in [RFC-7034](https://datatracker.ietf.org/doc/html/rfc7034). These settings are usually set in the config file for the web server that's hosting the target application, here are some examples of how to enable cross-origin access with common web servers:
|
||||
This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements.
|
||||
|
||||
As defined in [RFC-7034](https://datatracker.ietf.org/doc/html/rfc7034), for any web content to be accessed through an embedded element, it must have the [`X-Frame-Options`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) HTTP header set to `ALLOW`. If you are getting a `Refused to Connect` error then this header is set to `DENY` (or `SAMEORIGIN` and it's on a different host). Thankfully, for self-hosted services, it is easy to set these headers.
|
||||
|
||||
These settings are usually set in the config file for the web server that's hosting the target application, here are some examples of how to enable cross-origin access with common web servers:
|
||||
|
||||
### NGINX
|
||||
|
||||
In NGINX, you can use the [`add_header`](https://nginx.org/en/docs/http/ngx_http_headers_module.html) module within the app block.
|
||||
```
|
||||
|
||||
```text
|
||||
server {
|
||||
...
|
||||
add_header X-Frame-Options SAMEORIGIN always;
|
||||
}
|
||||
```
|
||||
|
||||
Then reload with `service nginx reload`
|
||||
|
||||
### Caddy
|
||||
|
||||
In Caddy, you can use the [`header`](https://caddyserver.com/docs/caddyfile/directives/header) directive.
|
||||
|
||||
```yaml
|
||||
```text
|
||||
header {
|
||||
X-Frame-Options SAMEORIGIN
|
||||
}
|
||||
|
@ -29,12 +101,45 @@ header {
|
|||
|
||||
In Apache, you can use the [`mod_headers`](https://httpd.apache.org/docs/current/mod/mod_headers.html) module to set the `X-Frame-Options` in your config file. This file is usually located somewhere like `/etc/apache2/httpd.conf
|
||||
|
||||
```text
|
||||
Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"
|
||||
```
|
||||
Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"
|
||||
|
||||
### LightHttpd
|
||||
|
||||
```text
|
||||
Content-Security-Policy: frame-ancestors 'self' https://[dashy-location]/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 404 On Static Hosting
|
||||
|
||||
If you're seeing Dashy's 404 page on initial load/ refresh, and then the main app when you go back to Home, then this is likely caused by the Vue router, and if so can be fixed in one of two ways.
|
||||
|
||||
The first solution is to switch the routing mode, from HTML5 `history` mode to `hash` mode, by setting `appConfig.routingMode` to `hash`.
|
||||
|
||||
If this works, but you wish to continue using HTML5 history mode, then a bit of extra [server configuration](/docs/management.md#web-server-configuration) is required. This is explained in more detaail in the [Vue Docs](https://router.vuejs.org/guide/essentials/history-mode.html). Once completed, you can then use `routingMode: history` again, for neater URLs.
|
||||
|
||||
---
|
||||
|
||||
## 404 after Launch from Mobile Home Screen
|
||||
|
||||
Similar to the above issue, if you get a 404 after using iOS and Android's "Add to Home Screen" feature, then this is caused by Vue router.
|
||||
It can be fixed by setting `appConfig.routingMode` to `hash`
|
||||
|
||||
See also: [#628](https://github.com/Lissy93/dashy/issues/628), [#762](https://github.com/Lissy93/dashy/issues/762)
|
||||
|
||||
---
|
||||
|
||||
## 404 On Multi-Page Apps
|
||||
|
||||
Similar to above, if you get a 404 error when visiting a page directly on multi-page apps, then this can be fixed under `appConfig`, by setting `routingMode` to `hash`. Then rebuilding, and refreshing the page.
|
||||
|
||||
See also: [#670](https://github.com/Lissy93/dashy/issues/670), [#763](https://github.com/Lissy93/dashy/issues/763)
|
||||
|
||||
---
|
||||
|
||||
## Yarn Error
|
||||
|
||||
For more info, see [Issue #1](https://github.com/Lissy93/dashy/issues/1)
|
||||
|
@ -42,14 +147,59 @@ For more info, see [Issue #1](https://github.com/Lissy93/dashy/issues/1)
|
|||
First of all, check that you've got yarn installed correctly - see the [yarn installation docs](https://classic.yarnpkg.com/en/docs/install) for more info.
|
||||
|
||||
If you're getting an error about scenarios, then you've likely installed the wrong yarn... (you're [not](https://github.com/yarnpkg/yarn/issues/2821) the only one!). You can fix it by uninstalling, adding the correct repo, and reinstalling, for example, in Debian:
|
||||
|
||||
- `sudo apt remove yarn`
|
||||
- `curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -`
|
||||
- `echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list`
|
||||
- `sudo apt update && sudo apt install yarn`
|
||||
|
||||
Alternatively, as a workaround, you have several options:
|
||||
|
||||
- Try using [NPM](https://www.npmjs.com/get-npm) instead: So clone, cd, then run `npm install`, `npm run build` and `npm start`
|
||||
- Try using [Docker](https://www.docker.com/get-started) instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run `docker build -t lissy93/dashy .` to build, and then use docker start to run the project, e.g: `docker run -it -p 8080:80 lissy93/dashy` (see the [deploying docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#deploy-with-docker) for more info)
|
||||
- Try using [Docker](https://www.docker.com/get-started) instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run `docker build -t lissy93/dashy .` to build, and then use docker start to run the project, e.g: `docker run -it -p 8080:8080 lissy93/dashy` (see the [deploying docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#deploy-with-docker) for more info)
|
||||
|
||||
---
|
||||
|
||||
## Remote Config Not Loading
|
||||
|
||||
If you've got a multi-page dashboard, and are hosting the additional config files yourself, then CORS rules will apply. A CORS error will look something like:
|
||||
|
||||
```text
|
||||
Access to XMLHttpRequest at 'https://example.com/raw/my-config.yml' from origin 'http://dashy.local' has been blocked by CORS policy:
|
||||
No 'Access-Control-Allow-Origin' header is present on the requested resource.
|
||||
```
|
||||
|
||||
The solution is to add the appropriate headers onto the target server, to allow it to accept requests from the origin where you're running Dashy.
|
||||
|
||||
If it is a remote service, that you do not have admin access to, then another option is to proxy the request. Either host your own, or use a publicly accessible service, like [allorigins.win](https://allorigins.win), e.g: `https://api.allorigins.win/raw?url=https://pastebin.com/raw/4tZpaJV5`. For git-based services specifically, there's [raw.githack.com](https://raw.githack.com/)
|
||||
|
||||
---
|
||||
|
||||
## Ineffective mark-compacts near heap limit Allocation failed
|
||||
|
||||
If you see an error message, similar to:
|
||||
|
||||
```text
|
||||
<--- Last few GCs --->
|
||||
|
||||
[61:0x74533040] 229060 ms: Mark-sweep (reduce) 127.1 (236.9) -> 127.1 (137.4) MB, 5560.7 / 0.3 ms (average mu = 0.286, current mu = 0.011) allocation failure scavenge might not succeed
|
||||
|
||||
<--- JS stacktrace --->
|
||||
|
||||
FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
|
||||
```
|
||||
|
||||
This is likely caused by insufficient memory allocation to the container. When the container first starts up, or has to rebuild, the memory usage spikes, and if there isn't enough memory, it may terminate. This can be specified with, for example: `--memory=1024m`. For more info, see [Docker: Runtime options with Memory, CPUs, and GPUs](https://docs.docker.com/config/containers/resource_constraints/).
|
||||
|
||||
See also: [#380](https://github.com/Lissy93/dashy/issues/380), [#350](https://github.com/Lissy93/dashy/issues/350), [#297](https://github.com/Lissy93/dashy/issues/297), [#349](https://github.com/Lissy93/dashy/issues/349), [#510](https://github.com/Lissy93/dashy/issues/510), [#511](https://github.com/Lissy93/dashy/issues/511) and [#834](https://github.com/Lissy93/dashy/issues/834)
|
||||
|
||||
---
|
||||
|
||||
## Command failed with signal "SIGKILL"
|
||||
|
||||
In Docker, this can be caused by not enough memory. When the container first starts up, or has to rebuild, the memory usage spikes, and so a larger allocation may be required. This can be specified with, for example: `--memory=1024m`. For more info, see [Docker: Runtime options with Memory, CPUs, and GPUs](https://docs.docker.com/config/containers/resource_constraints/)
|
||||
|
||||
See also [#624](https://github.com/Lissy93/dashy/issues/624)
|
||||
|
||||
---
|
||||
|
||||
|
@ -78,6 +228,71 @@ auth:
|
|||
|
||||
---
|
||||
|
||||
## App Not Starting After Update to 2.0.4
|
||||
|
||||
Version 2.0.4 introduced changes to how the config is read, and the app is build. If you were previously mounting `/public` as a volume, then this will over-write the build app, preventing it from starting. The solution is to just pass in the file(s) / sub-directories that you need. For example:
|
||||
|
||||
```yaml
|
||||
volumes:
|
||||
- /srv/dashy/conf.yml:/app/user-data/conf.yml
|
||||
- /srv/dashy/item-icons:/app/public/item-icons
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Keycloak Redirect Error
|
||||
|
||||
Check the [browser's console output](#how-to-open-browser-console), if you've not set any headers, you will likely see a CORS error here, which would be the source of the issue.
|
||||
|
||||
You need to allow Dashy to make requests to Keycloak, and Keycloak to redirect to Dashy. The way you do this depends on how you're hosting these applications / which proxy you are using, and examples can be found in the [Management Docs](/docs/management.md#setting-headers).
|
||||
|
||||
For example, add the access control header to Keycloak, like:
|
||||
|
||||
`Access-Control-Allow-Origin [URL-of Dashy]`
|
||||
|
||||
Note that for requests that transport sensitive info like credentials, setting the accept header to a wildcard (`*`) is not allowed - see [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#requests_with_credentials), so you will need to specify the actual URL.
|
||||
|
||||
You should also ensure that Keycloak is correctly configured, with a user, realm and application, and be sure that you have set a valid redirect URL in Keycloak ([screenshot](https://user-images.githubusercontent.com/1862727/148599768-db4ee4f8-72c5-402d-8f00-051d999e6267.png)).
|
||||
|
||||
For more details on how to set headers, see the [Example Headers](/docs/management.md#setting-headers) in the management docs, or reference the documentation for your proxy.
|
||||
|
||||
If you're running in Kubernetes, you will need to enable CORS ingress rules, see [docs](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#enable-cors), e.g:
|
||||
|
||||
```text
|
||||
nginx.ingress.kubernetes.io/cors-allow-origin: "https://dashy.example.com"
|
||||
nginx.ingress.kubernetes.io/enable-cors: "true"
|
||||
```
|
||||
|
||||
See also: #479, #409, #507, #491, #341, #520
|
||||
|
||||
---
|
||||
|
||||
## Docker Directory
|
||||
|
||||
```text
|
||||
Error response from daemon: OCI runtime create failed: container_linux.go:380:
|
||||
starting container process caused: process_linux.go:545: container init caused:
|
||||
rootfs_linux.go:76: mounting "/home/ubuntu/my-conf.yml" to rootfs at
|
||||
"/app/user-data/conf.yml" caused: mount through procfd: not a directory:
|
||||
unknown: Are you trying to mount a directory onto a file (or vice-versa)?
|
||||
Check if the specified host path exists and is the expected type.
|
||||
```
|
||||
|
||||
If you get an error similar to the one above, you are mounting a directory to the config file's location, when a plain file is expected. Create a YAML file, (`touch my-conf.yml`), populate it with a sample config, then pass it as a volume: `-v ./my-local-conf.yml:/app/user-data/conf.yml`
|
||||
|
||||
---
|
||||
|
||||
## Config not Saving on Vercel / Netlify / CDN
|
||||
|
||||
If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.
|
||||
You'll instead need to copy the YAML after making your changes, and paste that into your `conf.yml` directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes.
|
||||
|
||||
If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected.
|
||||
|
||||
See also [#1465](https://github.com/Lissy93/dashy/issues/1465)
|
||||
|
||||
---
|
||||
|
||||
## Config Not Updating
|
||||
|
||||
Dashy has the option to save settings and config locally, in browser storage. Anything here will take precedence over whatever is in your config file, sometimes with unintended consequences. If you've updated the config file manually, and are not seeing changes reflected in the UI, then try visiting the site in Incognito mode. If that works, then the solution is just to clear local storage. This can be done from the config menu, under "Clear Local Settings".
|
||||
|
@ -100,23 +315,27 @@ If you find that your styles and other visual assets work when visiting `ip:port
|
|||
|
||||
This situation relates to error messages similar to one of the following, returned when pulling, updating or running the Docker container from Docker Hub.
|
||||
|
||||
```
|
||||
Continuing execution. Pulling image lissy93/dashy:release-1.6.0
|
||||
```text
|
||||
Continuing execution. Pulling image lissy93/dashy:release-1.6.0
|
||||
error pulling image configuration: toomanyrequests
|
||||
```
|
||||
|
||||
or
|
||||
```
|
||||
|
||||
```text
|
||||
You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit
|
||||
```
|
||||
|
||||
When DockerHub returns one of these errors, or a `429` status, that means you've hit your rate limit. This was [introduced](https://www.docker.com/blog/scaling-docker-to-serve-millions-more-developers-network-egress/) last year, and prevents unauthenticated or free users from running docker pull more than 100 times per 6 hours.
|
||||
You can [check your rate limit status](https://www.docker.com/blog/checking-your-current-docker-pull-rate-limits-and-status/) by looking for the `ratelimit-remaining` header in any DockerHub responses.
|
||||
You can [check your rate limit status](https://www.docker.com/blog/checking-your-current-docker-pull-rate-limits-and-status/) by looking for the `ratelimit-remaining` header in any DockerHub responses.
|
||||
|
||||
#### Solution 1 - Use an alternate container registry
|
||||
- Dashy is also availible through GHCR, which at present does not have any hard limits. Just use `docker pull ghcr.io/lissy93/dashy:latest` to fetch the image
|
||||
### Solution 1 - Use an alternate container registry
|
||||
|
||||
- Dashy is also available through GHCR, which at present does not have any hard limits. Just use `docker pull ghcr.io/lissy93/dashy:latest` to fetch the image
|
||||
- You can also build the image from source, by cloning the repo, and running `docker build -t dashy .` or use the pre-made docker compose
|
||||
|
||||
#### Solution 2 - Increase your rate limits
|
||||
### Solution 2 - Increase your rate limits
|
||||
|
||||
- Logging in to DockerHub will increase your rate limit from 100 requests to 200 requests per 6 hour period
|
||||
- Upgrading to a Pro for $5/month will increase your image requests to 5,000 per day, and any plans above have no rate limits
|
||||
- Since rate limits are counted based on your IP address, proxying your requests, or using a VPN may work
|
||||
|
@ -124,6 +343,7 @@ You can [check your rate limit status](https://www.docker.com/blog/checking-your
|
|||
---
|
||||
|
||||
## Config Validation Errors
|
||||
|
||||
The configuration file is validated against [Dashy's Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json) using AJV.
|
||||
|
||||
First, check that your syntax is valid, using [YAML Validator](https://codebeautify.org/yaml-validator/) or [JSON Validator](https://codebeautify.org/jsonvalidator). If the issue persists, then take a look at the [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json), and verify that the field you are trying to add/ modify matches the required format. You can also use [this tool](https://www.jsonschemavalidator.net/s/JFUj7X9J) to validate your JSON config against the schema, or run `yarn validate-config`.
|
||||
|
@ -135,23 +355,37 @@ If the issue still persists, you should raise an issue.
|
|||
---
|
||||
|
||||
## Node Sass does not yet support your current environment
|
||||
|
||||
Caused by node-sass's binaries being built for a for a different architecture
|
||||
To fix this, just run: `yarn rebuild node-sass`
|
||||
|
||||
---
|
||||
|
||||
## Unreachable Code Error
|
||||
|
||||
An error similar to: `Fatal error in , line 0. Unreachable code, FailureMessage Object: 0xffe6c8ac. Illegal instruction (core dumped)`
|
||||
Is related to a bug in a downstream package, see [nodejs/docker-node#1477](https://github.com/nodejs/docker-node/issues/1477).
|
||||
Usually, updating your system and packages will resolve the issue.
|
||||
|
||||
See also: [#776](https://github.com/Lissy93/dashy/issues/776)
|
||||
|
||||
---
|
||||
|
||||
## Error: Cannot find module './_baseValues'
|
||||
|
||||
Clearing the cache should fix this: `yarn cache clean`
|
||||
If the issue persists, remove (`rm -rf node_modules\ yarn.lock`) and reinstall (`yarn`) node_modules
|
||||
|
||||
---
|
||||
|
||||
## Invalid Host Header while running through ngrok
|
||||
|
||||
Just add the [-host-header](https://ngrok.com/docs#http-host-header) flag, e.g. `ngrok http 8080 -host-header="localhost:8080"`
|
||||
|
||||
---
|
||||
|
||||
## Warnings in the Console during deploy
|
||||
|
||||
Please acknowledge the difference between errors and warnings before raising an issue about messages in the console. It's not unusual to see warnings about a new version of a certain package being available, an asset bundle bing oversized or a service worker not yet having a cache. These shouldn't have any impact on the running application, so please don't raise issues about these unless it directly relates to a bug or issue you're experiencing. Errors on the other hand should not appear in the console, and they are worth looking into further.
|
||||
|
||||
---
|
||||
|
@ -163,21 +397,265 @@ Run `sudo apt install gnupg2 pass && gpg2 -k`
|
|||
---
|
||||
|
||||
## Status Checks Failing
|
||||
|
||||
If you're using status checks, and despite a given service being online, the check is displaying an error, there are a couple of things you can look at:
|
||||
|
||||
If your service requires requests to include any authorization in the headers, then use the `statusCheckHeaders` property, as described in the [docs](/docs/status-indicators.md#setting-custom-headers).
|
||||
|
||||
If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a [CORS error](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), and can be fixed by setting the headers on your target app, to include:
|
||||
```
|
||||
|
||||
```text
|
||||
Access-Control-Allow-Origin: https://location-of-dashy/
|
||||
Vary: Origin
|
||||
```
|
||||
|
||||
If the URL you are checking has an unsigned certificate, or is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting `statusCheckAllowInsecure` to true for a given item.
|
||||
|
||||
If your service is online, but responds with a status code that is not in the 2xx range, then you can use `statusCheckAcceptCodes` to set an accepted status code.
|
||||
|
||||
If you get an error, like `Service Unavailable: Server resulted in a fatal error`, even when it's definitely online, this is most likely caused by missing the protocol. Don't forget to include `https://` (or whatever protocol) before the URL, and ensure that if needed, you've specified the port.
|
||||
|
||||
Running Dashy in HOST network mode, instead of BRIDGE will allow status check access to other services in HOST mode. For more info, see [#445](https://github.com/Lissy93/dashy/discussions/445).
|
||||
|
||||
If you have firewall rules configured, then ensure that they don't prevent Dashy from making requests to the other services you are trying to access.
|
||||
|
||||
Currently, the status check needs a page to be rendered, so if this URL in your browser does not return anything, then status checks will not work. This may be modified in the future, but in the meantime, a fix would be to make your own status service, which just checks if your app responds with whatever code you'd like, and then return a 200 plus renders an arbitrary message. Then just point `statusCheckUrl` to your custom page.
|
||||
|
||||
For further troubleshooting, use an application like [Postman](https://postman.com) to diagnose the issue. Set the parameter to `GET`, and then make a call to: `https://[url-of-dashy]/status-check/?&url=[service-url]`. Where the service URL must have first been encoded (e.g. with `encodeURIComponent()` or [urlencoder.io](https://www.urlencoder.io/))
|
||||
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
|
||||
---
|
||||
|
||||
## Widget Errors
|
||||
|
||||
### Find Error Message
|
||||
|
||||
If an error occurs when fetching or rendering results, you will see a short message in the UI. If that message doesn't adequately explain the problem, then you can [open the browser console](/docs/troubleshooting.md#how-to-open-browser-console) to see more details.
|
||||
|
||||
### Check Config
|
||||
|
||||
Before proceeding, ensure that if the widget requires auth your API is correct, and for custom widgets, double check that the URL and protocol is correct.
|
||||
|
||||
### Timeout Error
|
||||
|
||||
If the error message in the console includes: `Error: timeout of 500ms exceeded`, then your Glances endpoint is slower to respond than expected. You can fix this by [setting timeout](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md#setting-timeout) to a larger value. This is done on each widget, with the `timeout` attribute, and is specified in ms. E.g. `timeout: 5000` would only fail if no response is returned within 5 seconds.
|
||||
|
||||
### CORS error
|
||||
|
||||
If the console message mentions to corss-origin blocking, then this is a CORS error, see: [Fixing Widget CORS Errors](#widget-cors-errors)
|
||||
|
||||
### More Info
|
||||
|
||||
If you're able to, you can find more information about why the request may be failing in the Dev Tools under the Network tab, and you can ensure your endpoint is correct and working using a tool like Postman.
|
||||
|
||||
---
|
||||
|
||||
## Widget CORS Errors
|
||||
|
||||
The most common widget issue is a CORS error. This is a browser security mechanism which prevents the client-side app (Dashy) from from accessing resources on a remote origin, without that server's explicit permission (e.g. with headers like Access-Control-Allow-Origin). See the MDN Docs for more info: [Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).
|
||||
|
||||
There are several ways to fix a CORS error:
|
||||
|
||||
### Option 1 - Ensure Correct Protocol
|
||||
|
||||
You will get a CORS error if you try and access a http service from a https source. So ensure that the URL you are requesting has the right protocol, and is correctly formatted.
|
||||
|
||||
### Option 2 - Set Headers
|
||||
|
||||
If you have control over the destination (e.g. for a self-hosted service), then you can simply apply the correct headers.
|
||||
Add the `Access-Control-Allow-Origin` header, with the value of either `*` to allow requests from anywhere, or more securely, the host of where Dashy is served from. For example:
|
||||
|
||||
```text
|
||||
Access-Control-Allow-Origin: https://url-of-dashy.local
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```text
|
||||
Access-Control-Allow-Origin: *
|
||||
```
|
||||
|
||||
For more info on how to set headers, see: [Setting Headers](/docs/management.md#setting-headers) in the management docs
|
||||
|
||||
### Option 3 - Proxying Request
|
||||
|
||||
You can route requests through Dashy's built-in CORS proxy. Instructions and more details can be found [here](/docs/widgets.md#proxying-requests). If you don't have control over the target origin, and you are running Dashy either through Docker, with the Node server or on Netlify, then this solution will work for you.
|
||||
|
||||
Just add the `useProxy: true` option to the failing widget.
|
||||
|
||||
### Option 4 - Use a plugin
|
||||
|
||||
For testing purposes, you can use an addon, which will disable the CORS checks. You can get the Allow-CORS extension for [Chrome](https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf?hl=en-US) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/access-control-allow-origin/), more details [here](https://mybrowseraddon.com/access-control-allow-origin.html)
|
||||
|
||||
---
|
||||
|
||||
## Widget Shows Error Incorrectly
|
||||
|
||||
When there's an error fetching or displaying a widgets data, then it will be highlighted in yellow, and a message displayed on the UI.
|
||||
|
||||
In some instances, this is a false positive, and the widget is actually functioning correctly.
|
||||
If this is the case, you can disable the UI error message of a given widget by setting: `ignoreErrors: true`
|
||||
|
||||
---
|
||||
|
||||
## Weather Forecast Widget 401
|
||||
|
||||
A 401 error means your API key is invalid, it is not an issue with Dashy.
|
||||
|
||||
Usually this happens due to an error in your config. If you're unsure, copy and paste the [example](/docs/widgets.md#weather) config, replacing the API key with your own.
|
||||
|
||||
Check that `apiKey` is correctly specified, and nested within `options`. Ensure your input city is valid.
|
||||
|
||||
To test your API key, try making a request to `https://api.openweathermap.org/data/2.5/weather?q=London&appid=[your-api-key]`
|
||||
|
||||
If [Weather widget](/docs/widgets.md#weather-forecast) is working fine, but you are getting a `401` for the [Weather Forecast widget](/docs/widgets.md#weather-forecast), then this is also an OWM API key issue.
|
||||
Since the forecasting API requires an upgraded plan. ULPT: You can get a free, premium API key by filling in [this form](https://home.openweathermap.org/students). It's a student plan, but there's no verification to check that you are still a student.
|
||||
|
||||
A future update will be pushed out, to use a free weather forecasting API.
|
||||
|
||||
See also: [#803](https://github.com/Lissy93/dashy/issues/803), [#789](https://github.com/Lissy93/dashy/issues/789), [#577](https://github.com/Lissy93/dashy/issues/577), [#621](https://github.com/Lissy93/dashy/issues/621), [#578](https://github.com/Lissy93/dashy/issues/578), [#806](https://github.com/Lissy93/dashy/discussions/806)
|
||||
|
||||
---
|
||||
|
||||
## Widget Displaying Inaccurate Data
|
||||
|
||||
If any widget is not displaying the data you expect, first confirm that your config is correct, then try manually calling the API endpoint.
|
||||
|
||||
If the raw API output is correct, yet the widget is rendering incorrect results, then it is likely a bug, and a ticket should be raised. You can start to debug the issue, by looking at the widget's code ([here](https://github.com/Lissy93/dashy/tree/master/src/components/Widgets)), and the browser console + networking tab.
|
||||
|
||||
If the API itself is returning incorrect, incomplete or inaccurate data then an issue needs to be raised **with the API provider** (not Dashy!). You can find the API provider included within the widget docs, or for a full list see the [Privacy Docs](https://github.com/Lissy93/dashy/blob/master/docs/privacy.md#widgets).
|
||||
|
||||
See also: [#807](https://github.com/Lissy93/dashy/issues/807) (re, domain monitor)
|
||||
|
||||
---
|
||||
|
||||
## Font Awesome Icons not Displaying
|
||||
|
||||
Usually, Font Awesome will be automatically enabled if one or more of your icons are using Font-Awesome. If this is not happening, then you can always manually enable (or disable) Font Awesome by setting: [`appConfig`](/docs/configuring.md#appconfig-optional).`enableFontAwesome` to `true`.
|
||||
|
||||
If you are trying to use a premium icon, then you must have a [Pro License](https://fontawesome.com/plans). You'll then need to specify your Pro plan API key under `appConfig.fontAwesomeKey`. You can find this key, by logging into your FA account, navigate to Account → [Kits](https://fontawesome.com/kits) → New Kit → Copy Kit Code. The code is a 10-digit alpha-numeric code, and is also visible within the new kit's URL, for example: `81e48ce079`.
|
||||
|
||||
<p align="center"><img src="https://i.ibb.co/hZ0D9vs/where-do-i-find-my-font-awesome-key.png" width="600" /></p>
|
||||
|
||||
Be sure that you're specifying the icon category and name correctly. You're icon should look be `[category] fa-[icon-name]`. The following categories are supported: `far` _(regular)_, `fas` _(solid)_, `fal`_(light)_, `fad` _(duo-tone)_ and `fab`_(brands)_. With the exception of brands, you'll usually want all your icons to be in from same category, so they look uniform.
|
||||
|
||||
Ensure the icon you are trying to use, is available within [FontAwesome Version 5](https://fontawesome.com/v5/search) (we've not yet upgraded to V6, as it works a little differently).
|
||||
|
||||
Examples: `fab fa-raspberry-pi`, `fas fa-database`, `fas fa-server`, `fas fa-ethernet`
|
||||
|
||||
Finally, check the [browser console](#how-to-open-browser-console) for any error messages, and raise a ticket if the issue persists.
|
||||
|
||||
---
|
||||
|
||||
## Copy to Clipboard not Working
|
||||
|
||||
If the copy to clipboard feature (either under Config --> Export, or Item --> Copy URL) isn't functioning as expected, first check the browser console. If you see `TypeError: Cannot read properties of undefined (reading 'writeText')` then this feature is not supported by your browser.
|
||||
The most common reason for this, is if you not running the app over HTTPS. Copying to the clipboard requires the app to be running in a secure origin / aka have valid HTTPS cert. You can read more about this [here](https://stackoverflow.com/a/71876238/979052).
|
||||
|
||||
As a workaround, you could either:
|
||||
|
||||
- Highlight the text and copy / <kbd>Ctrl</kbd> + <kbd>C</kbd>
|
||||
- Or setup SSL - [here's a guide](https://github.com/Lissy93/dashy/blob/master/docs/management.md#ssl-certificates) on doing so
|
||||
|
||||
---
|
||||
|
||||
## Unsupported Digital Envelope Routines
|
||||
|
||||
If you're running on GitHub Codespaces, and seeing: `Error: error:0308010C:digital envelope routines::unsupported` when using Node 17+, it can be resolved by adding the `--openssl-legacy-provider` flag to your `NODE_OPTIONS` environmental variable.
|
||||
For example:
|
||||
|
||||
```
|
||||
export NODE_OPTIONS=--openssl-legacy-provider
|
||||
```
|
||||
|
||||
This will be fixed once [webpack/webpack#17659](https://github.com/webpack/webpack/pull/17659) is merged.
|
||||
|
||||
---
|
||||
|
||||
## How to Reset Local Settings
|
||||
|
||||
Some settings are stored locally, in the browser's storage.
|
||||
|
||||
In some instances cached assets can prevent your settings from being updated, in which case you may wish to reset local data.
|
||||
|
||||
To clear all local data from the UI, head to the Config Menu, then click "Reset Local Settings", and Confirm when prompted.
|
||||
This will not affect your config file. But be sure that you keep a backup of your config, if you've not written changes it to disk.
|
||||
|
||||
You can also view any and all data that Dashy is storing, using the developer tools. Open your browser's dev tools (usually <kbd>F12</kbd>), in Chromium head to the Application tab, or in Firefox go to the Storage tab. Select Local Storage, then scroll down the the URL Dashy is running on. You should now see all data being stored, and you can select and delete any fields you wish.
|
||||
|
||||
For a full list of all data that may be cached, see the [Privacy Docs](/docs/privacy.md#browser-storage).
|
||||
|
||||
---
|
||||
|
||||
## How to make a bug report
|
||||
|
||||
### Step 1 - Where to open issues
|
||||
|
||||
You will need a GitHub account in order to raise a ticket. You can then [click here](https://github.com/Lissy93/dashy/issues/new?assignees=lissy93&labels=%F0%9F%90%9B+Bug&template=bug.yml&title=%5BBUG%5D+%3Ctitle%3E) to open a new bug report.
|
||||
|
||||
### Step 2 - Checking it's not already covered
|
||||
|
||||
Before submitting, please check that:
|
||||
|
||||
- A similar ticket has not previously been opened
|
||||
- The issue is not covered in the [troubleshooting guide](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md) or [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme)
|
||||
|
||||
### Step 3 - Describe the Issue
|
||||
|
||||
Your ticket will likely be dealt with more effectively if you can explain the issue clearly, and provide all relevant supporting material.
|
||||
|
||||
Complete the fields, asking for your environment info and version of Dashy.
|
||||
Then describe the issue, briefly explaining the steps to reproduce, expected outcome and actual outcome.
|
||||
|
||||
### Step 4 - Provide Supporting Info
|
||||
|
||||
Where relevant please also include:
|
||||
|
||||
- A screenshot of the issue
|
||||
- The relevant parts of your config file
|
||||
- Logs
|
||||
- If client-side issue, then include the browser logs ([see how](#how-to-open-browser-console))
|
||||
- If server-side / during deployment, include the terminal output
|
||||
|
||||
_Take care to redact any personal info, (like IP addresses, auth hashes or API keys)._
|
||||
|
||||
### Step 5 - Fix Released
|
||||
|
||||
A maintainer will aim to respond within 48 hours.
|
||||
The timeframe for resolving your issue, will vary depending on severity of the bug and the complexity of the fix.
|
||||
You will be notified on your ticket, when a fix has been released.
|
||||
|
||||
Finally, be sure to remain respectful to other users and project maintainers, in line with the [Contributor Covenant Code of Conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
|
||||
|
||||
---
|
||||
|
||||
## How-To Open Browser Console
|
||||
|
||||
When raising a bug, one crucial piece of info needed is the browser's console output. This will help the developer diagnose and fix the issue.
|
||||
|
||||
If you've been asked for this info, but are unsure where to find it, then it is under the "Console" tab, in the browsers developer tools, which can be opened with <kbd>F12</kbd>. You can right-click the console, and select Save As to download the log.
|
||||
|
||||
To open dev tools, and jump straight to the console:
|
||||
|
||||
- Win / Linux: <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>J</kbd>
|
||||
- MacOS: <kbd>Cmd</kbd> + <kbd>Option</kbd> + <kbd>J</kbd>
|
||||
|
||||
For more detailed walk through, see [this article](https://support.shortpoint.com/support/solutions/articles/1000222881-save-browser-console-file).
|
||||
|
||||
---
|
||||
|
||||
## Git Contributions not Displaying
|
||||
|
||||
If you've contributed to Dashy (or any other project), but your contributions are not showing up on your GH profile, or in Dashy's [Credits Page](https://github.com/Lissy93/dashy/blob/master/docs/credits.md), then this is likely a git config issue.
|
||||
|
||||
These statistics are generated using the username / email associated with commits. This info needs to be setup on your local machine using [`git config`](https://git-scm.com/docs/git-config).
|
||||
|
||||
Run the following commands (replacing name + email with your info):
|
||||
|
||||
- `git config --global user.name "John Doe"`
|
||||
- `git config --global user.email johndoe@example.com`
|
||||
|
||||
For more info, see [Git First Time Setup Docs](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup).
|
||||
|
||||
Note that only contributions to the master / main branch or a project are counted
|
||||
|
|
89
netlify.toml
|
@ -1,42 +1,47 @@
|
|||
# Enables you to easily deploy a fork of Dashy to Netlify
|
||||
# without the need to configure anything in admin UI
|
||||
# Docs: https://www.netlify.com/docs/netlify-toml-reference/
|
||||
|
||||
# Essential site config
|
||||
[build]
|
||||
base = "/"
|
||||
command = "yarn build"
|
||||
publish = "dist"
|
||||
functions = "services/serverless-functions"
|
||||
|
||||
# Site info, used for the 1-Click deploy page
|
||||
[template.environment]
|
||||
STATUSKIT_PAGE_TITLE = "Dashy"
|
||||
STATUSKIT_COMPANY_LOGO = "https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/logo.png"
|
||||
STATUSKIT_SUPPORT_CONTACT_LINK = "https://github.com/lissy93/dashy"
|
||||
STATUSKIT_RESOURCES_LINK = "https://dashy.to/docs"
|
||||
|
||||
# Redirect the Node endpoints to serverless functions
|
||||
[[redirects]]
|
||||
from = "/status-check"
|
||||
to = "/.netlify/functions/cloud-status-check"
|
||||
status = 301
|
||||
force = true
|
||||
[[redirects]]
|
||||
from = "/config-manager/*"
|
||||
to = "/.netlify/functions/not-supported"
|
||||
status = 301
|
||||
force = true
|
||||
|
||||
# For router history mode, ensure pages land on index
|
||||
[[redirects]]
|
||||
from = "/*"
|
||||
to = "/index.html"
|
||||
status = 200
|
||||
|
||||
# Set any security headers here
|
||||
[[headers]]
|
||||
for = "/*"
|
||||
[headers.values]
|
||||
# Uncomment to enable Netlify user control. You must have a paid plan.
|
||||
# Basic-Auth = "someuser:somepassword anotheruser:anotherpassword"
|
||||
# Enables you to easily deploy a fork of Dashy to Netlify
|
||||
# without the need to configure anything in admin UI
|
||||
# Docs: https://www.netlify.com/docs/netlify-toml-reference/
|
||||
|
||||
# Essential site config
|
||||
[build]
|
||||
base = "/"
|
||||
command = "yarn build"
|
||||
publish = "dist"
|
||||
functions = "services/serverless-functions"
|
||||
|
||||
# Environmental variables for build command
|
||||
[build.environment]
|
||||
NODE_VERSION = "20.11.1"
|
||||
NODE_OPTIONS = "--openssl-legacy-provider"
|
||||
YARN_FLAGS = "--ignore-engines"
|
||||
|
||||
# Redirect the Node endpoints to serverless functions
|
||||
[[redirects]]
|
||||
from = "/status-check"
|
||||
to = "/.netlify/functions/cloud-status-check"
|
||||
status = 301
|
||||
force = true
|
||||
[[redirects]]
|
||||
from = "/config-manager/*"
|
||||
to = "/.netlify/functions/not-supported"
|
||||
status = 301
|
||||
force = true
|
||||
[[redirects]]
|
||||
from = "/cors-proxy"
|
||||
to = "/.netlify/functions/netlify-cors"
|
||||
status = 301
|
||||
force = true
|
||||
|
||||
# For router history mode, ensure pages land on index
|
||||
[[redirects]]
|
||||
from = "/*"
|
||||
to = "/index.html"
|
||||
status = 200
|
||||
|
||||
# Set any security headers here
|
||||
[[headers]]
|
||||
for = "/*"
|
||||
[headers.values]
|
||||
# Uncomment to enable Netlify user control. Requires premium plan.
|
||||
# Basic-Auth = "someuser:somepassword anotheruser:anotherpassword"
|
||||
|
||||
|
|
78
package.json
|
@ -1,70 +1,76 @@
|
|||
{
|
||||
"name": "Dashy",
|
||||
"version": "1.9.3",
|
||||
"name": "dashy",
|
||||
"version": "3.0.1",
|
||||
"license": "MIT",
|
||||
"main": "server",
|
||||
"author": "Alicia Sykes <alicia@omg.lol> (https://aliciasykes.com)",
|
||||
"scripts": {
|
||||
"start": "node server",
|
||||
"dev": "vue-cli-service serve",
|
||||
"build": "vue-cli-service build",
|
||||
"dev": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service serve",
|
||||
"build": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service build",
|
||||
"lint": "vue-cli-service lint",
|
||||
"pm2-start": "npx pm2 start server.js",
|
||||
"build-watch": "vue-cli-service build --watch --mode production",
|
||||
"build-and-start": "npm-run-all --parallel build-watch start",
|
||||
"build-and-start": "NODE_OPTIONS=--openssl-legacy-provider npm-run-all --parallel build start",
|
||||
"validate-config": "node services/config-validator",
|
||||
"health-check": "node services/healthcheck",
|
||||
"dependency-audit": "npx improved-yarn-audit --ignore-dev-deps"
|
||||
},
|
||||
"dependencies": {
|
||||
"@formschema/native": "^2.0.0-beta.5",
|
||||
"@sentry/tracing": "^6.13.1",
|
||||
"@sentry/vue": "^6.13.1",
|
||||
"ajv": "^8.6.3",
|
||||
"axios": "^0.24.0",
|
||||
"@babel/core": "^7.0.0",
|
||||
"@formschema/native": "^2.0.0-beta.6",
|
||||
"@sentry/tracing": "^7.102.1",
|
||||
"@sentry/vue": "^7.102.1",
|
||||
"ajv": "^8.10.0",
|
||||
"axios": "^1.6.0",
|
||||
"connect-history-api-fallback": "^1.6.0",
|
||||
"crypto-js": "^4.1.1",
|
||||
"express": "^4.17.1",
|
||||
"crypto-js": "^4.2.0",
|
||||
"express": "^4.17.2",
|
||||
"express-basic-auth": "^1.2.1",
|
||||
"frappe-charts": "^1.6.2",
|
||||
"js-yaml": "^4.1.0",
|
||||
"keycloak-js": "^15.0.2",
|
||||
"register-service-worker": "^1.6.2",
|
||||
"keycloak-js": "^20.0.3",
|
||||
"register-service-worker": "^1.7.2",
|
||||
"remedial": "^1.0.8",
|
||||
"rsup-progress": "^2.0.4",
|
||||
"simple-icons": "^5.19.0",
|
||||
"v-jsoneditor": "^1.4.2",
|
||||
"rss-parser": "3.13.0",
|
||||
"simple-icons": "^10.4.0",
|
||||
"rsup-progress": "^3.2.0",
|
||||
"v-jsoneditor": "^1.4.5",
|
||||
"v-tooltip": "^2.1.3",
|
||||
"vue": "^2.6.10",
|
||||
"vue-i18n": "^8.25.1",
|
||||
"vue-js-modal": "^2.0.0-rc.6",
|
||||
"vue": "^2.7.0",
|
||||
"vue-i18n": "^8.27.2",
|
||||
"vue-js-modal": "^2.0.1",
|
||||
"vue-json-tree-view": "^2.1.6",
|
||||
"vue-material-tabs": "0.1.5",
|
||||
"vue-router": "^3.0.3",
|
||||
"vue-select": "^3.15.0",
|
||||
"vue-router": "^3.5.3",
|
||||
"vue-select": "^3.20.2",
|
||||
"vue-swatches": "^2.1.1",
|
||||
"vue-toasted": "^1.1.28",
|
||||
"vuex": "^3.6.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@architect/sandbox": "^3.7.4",
|
||||
"@vue/cli-plugin-babel": "^4.5.12",
|
||||
"@vue/cli-plugin-eslint": "^4.5.12",
|
||||
"@vue/cli-plugin-pwa": "^4.5.12",
|
||||
"@vue/cli-service": "^4.5.12",
|
||||
"@babel/preset-env": "^7.17.10",
|
||||
"@vue/cli-plugin-babel": "^4.5.15",
|
||||
"@vue/cli-plugin-eslint": "^4.5.15",
|
||||
"@vue/cli-plugin-pwa": "^4.5.15",
|
||||
"@vue/cli-plugin-typescript": "^5.0.8",
|
||||
"@vue/cli-service": "^4.5.19",
|
||||
"@vue/eslint-config-standard": "^4.0.0",
|
||||
"babel-eslint": "^10.0.1",
|
||||
"eslint": "^7.24.0",
|
||||
"copy-webpack-plugin": "6.4.0",
|
||||
"eslint": "^6.8.0",
|
||||
"eslint-config-airbnb": "^18.0.1",
|
||||
"eslint-plugin-vue": "^7.9.0",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"progress-bar-webpack-plugin": "^2.1.0",
|
||||
"sass": "^1.38.0",
|
||||
"sass-loader": "^7.1.0",
|
||||
"typescript": "^5.4.4",
|
||||
"vue-cli-plugin-yaml": "^1.0.2",
|
||||
"vue-svg-loader": "^0.16.0",
|
||||
"vue-template-compiler": "^2.6.10"
|
||||
"vue-template-compiler": "^2.7.0"
|
||||
},
|
||||
"gitHooks": {
|
||||
"pre-commit": "yarn lint"
|
||||
"engines": {
|
||||
"node": ">=16.0.0 <21.6.2"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"root": true,
|
||||
|
@ -86,6 +92,12 @@
|
|||
"parser": "babel-eslint"
|
||||
}
|
||||
},
|
||||
"babel": {
|
||||
"presets": [
|
||||
"@vue/app",
|
||||
"@babel/preset-env"
|
||||
]
|
||||
},
|
||||
"postcss": {
|
||||
"plugins": {
|
||||
"autoprefixer": {}
|
||||
|
@ -95,4 +107,4 @@
|
|||
"> 1%",
|
||||
"last 2 versions"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
Before Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 827 B |
|
@ -5,11 +5,11 @@
|
|||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1.0">
|
||||
<!-- Favicon + App Icon -->
|
||||
<!-- Favicon, App Icon -->
|
||||
<link rel="icon" type="image/png" sizes="64x64" href="<%= BASE_URL %>/web-icons/favicon-64x64.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="web-icons/favicon-32x32.png">
|
||||
<link rel="icon" href="/favicon.ico" />
|
||||
<link rel="icon" type="image/png" href="<%= BASE_URL %>favicon.ico" />
|
||||
<link rel="icon" type="image/png" href="/favicon.ico" />
|
||||
<link rel="stylesheet" type="text/css" href="/loading-screen.css" />
|
||||
<!-- Default Page Title -->
|
||||
<title>Dashy</title>
|
||||
</head>
|
||||
|
@ -18,46 +18,35 @@
|
|||
<!-- built files will be auto injected -->
|
||||
<div id="app">
|
||||
<!-- Loading screen, will be replaced when app loaded -->
|
||||
<div class="loading-placeholder" id="loader"><h1>Dashy</h1><p>Loading...</p></div>
|
||||
<div class="loading-placeholder" id="loader">
|
||||
<h1>Dashy</h1>
|
||||
<p class="loading">Loading... </p>
|
||||
<!-- Error message, only visible if app not mounted within 5 secs -->
|
||||
<div class="catastrophic-error" id="err-wrap" style="display:none;">
|
||||
<p class="err-l1">It looks like something's gone wrong...</p>
|
||||
<p class="err-l2">
|
||||
This is likely caused by the app source not being found at the current domain
|
||||
</p>
|
||||
<p class="err-l2">
|
||||
If you need additional support, check the browser console then
|
||||
<a href="https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT.md">
|
||||
raise a ticket
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<!-- Devices without JS enabled -->
|
||||
<noscript>
|
||||
<strong>Sorry, JavaScript needs to be enabled to run Dashy 😥</strong>
|
||||
</noscript>
|
||||
<!-- Styles for loading screen -->
|
||||
<style type="text/css">
|
||||
body { margin: 0; }
|
||||
#app .loading-placeholder {
|
||||
position: absolute;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
cursor: progress;
|
||||
background: #121212;
|
||||
}
|
||||
#app .loading-placeholder h1 {
|
||||
font-size: 20vh;
|
||||
font-family: Tahoma, monospace;
|
||||
cursor: progress;
|
||||
color: #0c0c0c;
|
||||
text-shadow: 0px 4px 4px #090909, 0 0 0 #000, 0px 2px 2px #000000;
|
||||
}
|
||||
@media (max-width: 780px) {
|
||||
.loading-placeholder h1 { font-size: 12vh !important; }
|
||||
}
|
||||
#app .loading-placeholder p {
|
||||
font-size: 2rem;
|
||||
font-family: monospace;
|
||||
cursor: progress;
|
||||
color: #0c0c0c;
|
||||
text-shadow: 0 1px 1px #090909, 0 0 0 #000, 0 1px 1px #000000;
|
||||
}
|
||||
::selection { background-color: #db78fc; color: #121212; }
|
||||
</style>
|
||||
|
||||
<!-- Show error message if app not mounted within reasonable time frame -->
|
||||
<script>
|
||||
setTimeout(() => {
|
||||
const loaderElem = document.getElementById('loader');
|
||||
if (loaderElem) loaderElem.classList.add('still-not-loaded');
|
||||
}, 7500);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
<!doctype html>
|
||||
<!-- Dashy: Licensed under MIT, (C) 2021 Alicia Sykes <https://aliciasykes.com> -->
|
||||
<!-- Dashy: Licensed under MIT, (C) 2024 Alicia Sykes <https://aliciasykes.com> -->
|
||||
<!-- This is the default page, displayed while the app is still building -->
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
@ -50,6 +50,14 @@
|
|||
|
||||
<p class="time-note" id="note">This may take a minute or two</p>
|
||||
|
||||
<div class="why-am-i-seeing-this">
|
||||
<h3>Why are you seeing this screen?</h3>
|
||||
<p>
|
||||
The app's built files aren't yet present in the /dist directory,
|
||||
so this page is displayed while we compile the source.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<style lang="css">
|
||||
/* Page Layout Styles */
|
||||
body,
|
||||
|
@ -60,7 +68,7 @@
|
|||
}
|
||||
|
||||
body {
|
||||
background: #141b33;
|
||||
background: #0d1220;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
|
@ -194,15 +202,34 @@
|
|||
}
|
||||
|
||||
.hide { display: none; }
|
||||
|
||||
.why-am-i-seeing-this {
|
||||
color: #808080a6;
|
||||
font-family: Tahoma, 'Trebuchet MS', sans-serif;
|
||||
max-width: 25rem;
|
||||
border: 2px solid #808080a6;
|
||||
border-radius: 6px;
|
||||
padding: 0.5rem;
|
||||
position: absolute;
|
||||
bottom: 1rem;
|
||||
background: #8080800d;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
.why-am-i-seeing-this h3 {
|
||||
margin: 0 0 0.5rem 0;
|
||||
}
|
||||
.why-am-i-seeing-this p {
|
||||
margin: 0;
|
||||
}
|
||||
</style>
|
||||
|
||||
<script>
|
||||
const refreshRate = 8000;
|
||||
// Refresh at interval
|
||||
// Refresh the page every 10 seconds
|
||||
const refreshRate = 10000;
|
||||
setTimeout(() => { location.reload(); }, refreshRate);
|
||||
|
||||
// Get current stage
|
||||
let initStage = parseInt(sessionStorage.getItem('initStage') || 0);
|
||||
// Get current stage
|
||||
let initStage = parseInt(sessionStorage.getItem('initStage') || 0);
|
||||
|
||||
// Check if stage in session storage is old, and if so, reset it
|
||||
const now = Math.round(Date.now()/1000);
|
||||
|
@ -262,4 +289,4 @@
|
|||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
</html>
|
||||
|
|
|
@ -0,0 +1,63 @@
|
|||
/* Styles applied to index.html for the loading screen, prior to the app being injected */
|
||||
/* Dashy - Licensed under MIT, (C) Alicia Sykes 2024 */
|
||||
|
||||
body { margin: 0; }
|
||||
#app .loading-placeholder {
|
||||
position: absolute;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
cursor: progress;
|
||||
background: #121212;
|
||||
}
|
||||
#app .loading-placeholder h1 {
|
||||
font-size: 20vh;
|
||||
margin: 1rem auto;
|
||||
font-family: Tahoma, monospace;
|
||||
cursor: progress;
|
||||
color: #0c0c0c;
|
||||
text-shadow: 0px 4px 4px #090909, 0 0 0 #000, 0px 2px 2px #000000;
|
||||
}
|
||||
#app .loading-placeholder p.loading {
|
||||
font-size: 2rem;
|
||||
opacity: 0.75;
|
||||
font-family: monospace;
|
||||
cursor: progress;
|
||||
color: #0c0c0c;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
text-shadow: 0 1px 1px #090909, 0 0 0 #000, 0 1px 1px #000000;
|
||||
}
|
||||
#app .loading-placeholder .catastrophic-error p {
|
||||
color: #e11a4bfc;
|
||||
margin: 0.5rem 0;
|
||||
font-weight: bold;
|
||||
font-size: 4vh;
|
||||
text-align: center;
|
||||
font-family: monospace;
|
||||
text-shadow: 1px 2px 1px #090909, 0 0 0 #000, 0 1px 1px #000000
|
||||
}
|
||||
#app .loading-placeholder .catastrophic-error p.err-l2 {
|
||||
opacity: 0.75;
|
||||
font-size: 2vh;
|
||||
font-weight: normal;
|
||||
padding: 0 1rem;
|
||||
}
|
||||
#app .loading-placeholder .catastrophic-error p.err-l2 a {
|
||||
color: #e11a4bfc;
|
||||
}
|
||||
#app .loading-placeholder.still-not-loaded { cursor: default; }
|
||||
#app .loading-placeholder.still-not-loaded p.loading { display: none; }
|
||||
#app .loading-placeholder.still-not-loaded .catastrophic-error { display: block !important; }
|
||||
@media (max-width: 780px) {
|
||||
.loading-placeholder h1 { font-size: 12vh !important; }
|
||||
#app .loading-placeholder .catastrophic-error p { font-size: 2.5vh !important; }
|
||||
#app .loading-placeholder .catastrophic-error p.err-l2 { font-size: 1.2vh !important; }
|
||||
}
|
||||
::selection { background-color: #e11a4bfc; color: #121212; }
|
|
@ -3,7 +3,7 @@
|
|||
"short_name": "Dashy",
|
||||
"description": "A Dashboard for your Homelab",
|
||||
"scope": "/",
|
||||
"start_url": "./index.html",
|
||||
"start_url": "./",
|
||||
"display": "standalone",
|
||||
"background_color": "#0b1021",
|
||||
"theme_color": "#4DBA87",
|
||||
|
@ -11,546 +11,28 @@
|
|||
"orientation": "portrait-primary",
|
||||
"icons": [
|
||||
{
|
||||
"src": "./web-icons/windows10/SmallTile.scale-100.png",
|
||||
"sizes": "71x71"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SmallTile.scale-125.png",
|
||||
"sizes": "89x89"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SmallTile.scale-150.png",
|
||||
"sizes": "107x107"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SmallTile.scale-200.png",
|
||||
"sizes": "142x142"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SmallTile.scale-400.png",
|
||||
"sizes": "284x284"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square150x150Logo.scale-100.png",
|
||||
"sizes": "150x150"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square150x150Logo.scale-125.png",
|
||||
"sizes": "188x188"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square150x150Logo.scale-150.png",
|
||||
"sizes": "225x225"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square150x150Logo.scale-200.png",
|
||||
"sizes": "300x300"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square150x150Logo.scale-400.png",
|
||||
"sizes": "600x600"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Wide310x150Logo.scale-100.png",
|
||||
"sizes": "310x150"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Wide310x150Logo.scale-125.png",
|
||||
"sizes": "388x188"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Wide310x150Logo.scale-150.png",
|
||||
"sizes": "465x225"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Wide310x150Logo.scale-200.png",
|
||||
"sizes": "620x300"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Wide310x150Logo.scale-400.png",
|
||||
"sizes": "1240x600"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/LargeTile.scale-100.png",
|
||||
"sizes": "310x310"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/LargeTile.scale-125.png",
|
||||
"sizes": "388x388"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/LargeTile.scale-150.png",
|
||||
"sizes": "465x465"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/LargeTile.scale-200.png",
|
||||
"sizes": "620x620"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/LargeTile.scale-400.png",
|
||||
"sizes": "1240x1240"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.scale-100.png",
|
||||
"sizes": "44x44"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.scale-125.png",
|
||||
"sizes": "55x55"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.scale-150.png",
|
||||
"sizes": "66x66"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.scale-200.png",
|
||||
"sizes": "88x88"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.scale-400.png",
|
||||
"sizes": "176x176"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/StoreLogo.scale-100.png",
|
||||
"sizes": "50x50"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/StoreLogo.scale-125.png",
|
||||
"sizes": "63x63"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/StoreLogo.scale-150.png",
|
||||
"sizes": "75x75"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/StoreLogo.scale-200.png",
|
||||
"sizes": "100x100"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/StoreLogo.scale-400.png",
|
||||
"sizes": "200x200"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SplashScreen.scale-100.png",
|
||||
"sizes": "620x300"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SplashScreen.scale-125.png",
|
||||
"sizes": "775x375"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SplashScreen.scale-150.png",
|
||||
"sizes": "930x450"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SplashScreen.scale-200.png",
|
||||
"sizes": "1240x600"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/SplashScreen.scale-400.png",
|
||||
"sizes": "2480x1200"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-16.png",
|
||||
"sizes": "16x16"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-20.png",
|
||||
"sizes": "20x20"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-24.png",
|
||||
"sizes": "24x24"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-30.png",
|
||||
"sizes": "30x30"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-32.png",
|
||||
"sizes": "32x32"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-36.png",
|
||||
"sizes": "36x36"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-40.png",
|
||||
"sizes": "40x40"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-44.png",
|
||||
"sizes": "44x44"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-48.png",
|
||||
"sizes": "48x48"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-60.png",
|
||||
"sizes": "60x60"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-64.png",
|
||||
"sizes": "64x64"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-72.png",
|
||||
"sizes": "72x72"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-80.png",
|
||||
"sizes": "80x80"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-96.png",
|
||||
"sizes": "96x96"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.targetsize-256.png",
|
||||
"sizes": "256x256"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-16.png",
|
||||
"sizes": "16x16"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-20.png",
|
||||
"sizes": "20x20"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-24.png",
|
||||
"sizes": "24x24"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-30.png",
|
||||
"sizes": "30x30"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-32.png",
|
||||
"sizes": "32x32"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-36.png",
|
||||
"sizes": "36x36"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-40.png",
|
||||
"sizes": "40x40"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-44.png",
|
||||
"sizes": "44x44"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-48.png",
|
||||
"sizes": "48x48"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-60.png",
|
||||
"sizes": "60x60"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-64.png",
|
||||
"sizes": "64x64"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-72.png",
|
||||
"sizes": "72x72"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-80.png",
|
||||
"sizes": "80x80"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-96.png",
|
||||
"sizes": "96x96"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-unplated_targetsize-256.png",
|
||||
"sizes": "256x256"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-16.png",
|
||||
"sizes": "16x16"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-20.png",
|
||||
"sizes": "20x20"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-24.png",
|
||||
"sizes": "24x24"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-30.png",
|
||||
"sizes": "30x30"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-32.png",
|
||||
"sizes": "32x32"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-36.png",
|
||||
"sizes": "36x36"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-40.png",
|
||||
"sizes": "40x40"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-44.png",
|
||||
"sizes": "44x44"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-48.png",
|
||||
"sizes": "48x48"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-60.png",
|
||||
"sizes": "60x60"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-64.png",
|
||||
"sizes": "64x64"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-72.png",
|
||||
"sizes": "72x72"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-80.png",
|
||||
"sizes": "80x80"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-96.png",
|
||||
"sizes": "96x96"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows10/Square44x44Logo.altform-lightunplated_targetsize-256.png",
|
||||
"sizes": "256x256"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-smallsquare-24-24.png",
|
||||
"sizes": "24x24"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-smallsquare-30-30.png",
|
||||
"sizes": "30x30"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-smallsquare-42-42.png",
|
||||
"sizes": "42x42"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-smallsquare-54-54.png",
|
||||
"sizes": "54x54"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-splashscreen-1116-540.png",
|
||||
"sizes": "1116x540"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-splashscreen-868-420.png",
|
||||
"sizes": "868x420"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-splashscreen-620-300.png",
|
||||
"sizes": "620x300"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-squarelogo-270-270.png",
|
||||
"sizes": "270x270"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-squarelogo-210-210.png",
|
||||
"sizes": "210x210"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-squarelogo-150-150.png",
|
||||
"sizes": "150x150"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-squarelogo-120-120.png",
|
||||
"sizes": "120x120"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-storelogo-90-90.png",
|
||||
"sizes": "90x90"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-storelogo-70-70.png",
|
||||
"sizes": "70x70"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windows-storelogo-50-50.png",
|
||||
"sizes": "50x50"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-appicon-106-106.png",
|
||||
"sizes": "106x106"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-appicon-62-62.png",
|
||||
"sizes": "62x62"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-appicon-44-44.png",
|
||||
"sizes": "44x44"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-mediumtile-360-360.png",
|
||||
"sizes": "360x360"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-mediumtile-210-210.png",
|
||||
"sizes": "210x210"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-mediumtile-150-150.png",
|
||||
"sizes": "150x150"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-smalltile-170-170.png",
|
||||
"sizes": "170x170"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-smalltile-99-99.png",
|
||||
"sizes": "99x99"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-smalltile-71-71.png",
|
||||
"sizes": "71x71"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-storelogo-120-120.png",
|
||||
"sizes": "120x120"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-storelogo-70-70.png",
|
||||
"sizes": "70x70"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/windows/windowsphone-storelogo-50-50.png",
|
||||
"sizes": "50x50"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/msteams/msteams-192-192.png",
|
||||
"sizes": "192x192"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/msteams/msteams-silhouette-32-32.png",
|
||||
"sizes": "32x32"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/android/android-launchericon-512-512.png",
|
||||
"src": "./web-icons/dashy-pwa_512x512.png",
|
||||
"sizes": "512x512"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/android/android-launchericon-192-192.png",
|
||||
"src": "./web-icons/dashy-pwa_192x192.png",
|
||||
"sizes": "192x192"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/android/android-launchericon-144-144.png",
|
||||
"src": "./web-icons/dashy-pwa_144x144.png",
|
||||
"sizes": "144x144"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/android/android-launchericon-96-96.png",
|
||||
"src": "./web-icons/dashy-pwa_96x96.png",
|
||||
"sizes": "96x96"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/android/android-launchericon-72-72.png",
|
||||
"src": "./web-icons/dashy-pwa_72x72.png",
|
||||
"sizes": "72x72"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/android/android-launchericon-48-48.png",
|
||||
"src": "./web-icons/dashy-pwa_48x48.png",
|
||||
"sizes": "48x48"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/chrome/chrome-extensionmanagementpage-48-48.png",
|
||||
"sizes": "48x48"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/chrome/chrome-favicon-16-16.png",
|
||||
"sizes": "16x16"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/chrome/chrome-installprocess-128-128.png",
|
||||
"sizes": "128x128"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-marketplace-512-512.png",
|
||||
"sizes": "512x512"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-marketplace-128-128.png",
|
||||
"sizes": "128x128"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-256-256.png",
|
||||
"sizes": "256x256"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-128-128.png",
|
||||
"sizes": "128x128"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-90-90.png",
|
||||
"sizes": "90x90"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-64-64.png",
|
||||
"sizes": "64x64"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-48-48.png",
|
||||
"sizes": "48x48"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-32-32.png",
|
||||
"sizes": "32x32"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/firefox/firefox-general-16-16.png",
|
||||
"sizes": "16x16"
|
||||
}
|
||||
],
|
||||
"screenshots": [
|
||||
{
|
||||
"src": "./web-icons/screenshots/dashy-scrsht-1.png",
|
||||
"sizes": "1523x1347",
|
||||
"type": "image/png",
|
||||
"label": "Dashy example homelab with Callisto theme"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/screenshots/dashy-scrsht-2.png",
|
||||
"sizes": "1264x861",
|
||||
"type": "image/png",
|
||||
"label": "Example, Networking services with Minimal Dark theme and a Horizontal layout"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/screenshots/dashy-scrsht-3.png",
|
||||
"sizes": "1303x864",
|
||||
"type": "image/png",
|
||||
"label": "Dashy example homelab with Material theme and auto-fetched favicons"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/screenshots/dashy-scrsht-4.png",
|
||||
"sizes": "1273x865",
|
||||
"type": "image/png",
|
||||
"label": "Dashy CFT Toolbox using Matrix theme"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/screenshots/dashy-scrsht-5.png",
|
||||
"sizes": "1146x851",
|
||||
"type": "image/png",
|
||||
"label": "Dashy as a Bookmark Manager, with Dracula theme and Font-Awesome icons"
|
||||
},
|
||||
{
|
||||
"src": "./web-icons/screenshots/dashy-scrsht-6.png",
|
||||
"sizes": "1147x872",
|
||||
"type": "image/png",
|
||||
"label": "Dashy example homelab with Nord theme"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
Before Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 565 B |
Before Width: | Height: | Size: 9.0 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |