From c6501a3dda3d8c69fbc901fa222291ccc8ba77c7 Mon Sep 17 00:00:00 2001 From: Kevin Krumm Date: Thu, 7 Dec 2017 08:08:31 -0600 Subject: [PATCH] docs: Update World Map doc (#7858) * docs: Update World Map Doc Updated Doc and removed old Globe Map info. * image for world map settings * Update mkdocs.yml --- doc/Extensions/Globe-Frontpage.md | 56 -------------------------- doc/Extensions/World-Map.md | 50 +++++++++++++++++++++++ doc/img/world-map-widget-settings.png | Bin 0 -> 8270 bytes mkdocs.yml | 2 +- 4 files changed, 51 insertions(+), 57 deletions(-) delete mode 100644 doc/Extensions/Globe-Frontpage.md create mode 100644 doc/Extensions/World-Map.md create mode 100644 doc/img/world-map-widget-settings.png diff --git a/doc/Extensions/Globe-Frontpage.md b/doc/Extensions/Globe-Frontpage.md deleted file mode 100644 index 74b29df279..0000000000 --- a/doc/Extensions/Globe-Frontpage.md +++ /dev/null @@ -1,56 +0,0 @@ -source: Extensions/Globe-Frontpage.md -# Globe Frontpage Configuration - -LibreNMS comes with a configurable geochart based widget to visualize where your equipment is located geographically. - -### World Map - -An new map is available, this requires you to have properly formatted addresses in sysLocation or sysLocation override. As part of the standard poller these addresses will be Geocoded by Google and stored in the database. To enable this please set the following config: - -```php -$config['geoloc']['latlng'] = true; -$config['geoloc']['engine'] = "google";//Only one available at present -``` - -Location resolution happens as follows (when `$config['geoloc']['latlng'] == true;`): - 1. If `device['location']` contains `[lat, lng]` (note the square brackets), that is used - 1. If there is a location overide for the device in the WebUI and it contains `[lat, lng]` (note the square brackets), that is used. - 1. Attempt to resolve lat, lng using `$config['geoloc']['engine']` - -We have two current mapping engines available: - -- Leaflet (default) -- Jquery-Mapael - - -### Leaflet config - -This is a simple engine to use yet is quite powerful, here you can see how to enable this engine and zoom to a default place. - -```php -$config['map']['engine'] = "leaflet"; -$config['leaflet']['default_lat'] = "50.898482"; -$config['leaflet']['default_lng'] = "-3.401402"; -$config['leaflet']['default_zoom'] = 8; -``` - -If you can't access OpenStreet map directly you can run a local [tile server](http://wiki.openstreetmap.org/wiki/Tile_servers). To specify a different url you can set: - -```php -$config['leaflet']['tile_url'] = 'localhost.com'; -``` - -### Jquery-Mapael config -Further custom options are available to load different maps of the world, set default coordinates of where the map will zoom and the zoom level by default. An example of -this is: - -```php -$config['map']['engine'] = "jquery-mapael"; -$config['mapael']['default_map'] = 'mapael-maps/united_kingdom/united_kingdom.js'; -$config['mapael']['map_width'] = 400; -$config['mapael']['default_lat'] = '50.898482'; -$config['mapael']['default_lng'] = '-3.401402'; -$config['mapael']['default_zoom'] = 20; -``` - -A list of maps can be found in html/js/maps/ or html/js/mapael-maps/. diff --git a/doc/Extensions/World-Map.md b/doc/Extensions/World-Map.md new file mode 100644 index 0000000000..175d0f3608 --- /dev/null +++ b/doc/Extensions/World-Map.md @@ -0,0 +1,50 @@ +source: Extensions/World-Map.md +# World Map Configuration + +LibreNMS comes with a configurable Geo Map based on World Map Widget to visualize where your equipment is located geographically. + +### World Map Widget + +World Map Widget, requires you to have properly formatted addresses in sysLocation or sysLocation override. As part of the standard poller these addresses will be Geocoded by Google and stored in the database. + +Location resolution happens as follows + 1. If `device['location']` contains `[lat, lng]` (note the square brackets), that is used + 1. If there is a location overide for the device in the WebUI and it contains `[lat, lng]` (note the square brackets), that is used. + 1. Attempt to resolve lat, lng using `$config['geoloc']['engine']` + 1. Properly formatted addresses in sysLocation or sysLocation override, under device settings. + + +We have two current mapping engines available: + +- Leaflet (default) +- Jquery-Mapael + + +### World Map Widget Settings + +Example Settings: + +![Example World Map Settings](/img/world-map-widget-settings.png) + + +### Offline OpenStreet Map +If you can't access OpenStreet map directly you can run a local [tile server](http://wiki.openstreetmap.org/wiki/Tile_servers). To specify a different url you can set: + +```php +$config['leaflet']['tile_url'] = 'localhost.com'; +``` + +### Jquery-Mapael config +Further custom options are available to load different maps of the world, set default coordinates of where the map will zoom and the zoom level by default. An example of +this is: + +```php +$config['map']['engine'] = "jquery-mapael"; +$config['mapael']['default_map'] = 'mapael-maps/united_kingdom/united_kingdom.js'; +$config['mapael']['map_width'] = 400; +$config['mapael']['default_lat'] = '50.898482'; +$config['mapael']['default_lng'] = '-3.401402'; +$config['mapael']['default_zoom'] = 20; +``` + +A list of maps can be found in ```html/js/maps/``` or ```html/js/mapael-maps/```. diff --git a/doc/img/world-map-widget-settings.png b/doc/img/world-map-widget-settings.png new file mode 100644 index 0000000000000000000000000000000000000000..39780ab2cfae28cc3063e4042d1e76ca7323dd8c GIT binary patch literal 8270 zcmeHNdpMM9yMIe*t>v_0m4v3kD3TDvGDsyk424J}Y7oX~C}&1lg`AB;jA+RrI5Fes)PM9zkTg}UHh+nUEd!rp68wCe(v|4=f3aX@Artf zVxlkb)8U^W2of;3e9;Vob}vEDuDl<1gBdGhi^t&CE-y3v^H5Q{#5XY5V(Q51$KRuh?P}HwJ%ZfSd7t^sR!$80GNa2@HX0R!*_9nZv&7*| zmQ~$)kHa9=2pChp9(>lE`3p^RuA0DyqWT%X>|Wj9An^9W@LIdikpEPn?KNr!etS(Z z=$jE(Rjh_U)N#s+1&oI0D6sX9VHtk8)DGk#y#%&?CEDi%@aU_(!Q*Vb*Cs>38#8X7 zi*l@3ESN3>(oD>J$tvQ9tu^a&Jz8E~_L^wlT1cteY_Y0UMk*~hcW7_aZF7b37J|u}V-`Mlg=Oltmy5d)52T#EFHCG76@B?0 zZZU-(pTqBL>_N3vbNbyBu%7;fQSX0qgqK;Uh&fXZcg#qrsti@5b_X@f`b!|Lskyni zRd@{7`Yo~|6>HUz?BJd4J39-S_?>S%D=V1>!<#9w_|2Vm>dvy_PS#+nUxBT0gMfrO zEyfmSl7UPm!qloopB%I{R6jw05zE(y;eJRs@HS37l(J&i?_dp=^&9cJlyYj zpGlGWgHNsJ{;&VLrUlggR2G5jz4(60(-mDAOa`c+)&M!4-^O(BOf%KYI)V}JtScc!I zfZd$OZzx+G;%>Ru@O<{`(V2?j?V*)gD;lYrOe;|ewq%@ZqT&`qVVg%`JDEG16Svk{ zthk3{z1!nWa7S)!^y{7OxnX|OxpUyS);}~ih)-xf8deF7|8(VQf_!^#an22V_ajc3 zg?v&vi9${dNMe(w<7jj=|NW!7i!&bhD(agzZ;ER;{i3z=k4*zdMMO{AHaoO=Ec?JV zt|ztaTwi;$v&oMAykfpHb4zC>)@Rcv*Hc#naqs6Gl`N`DWLsMshsTol0qXLW^lj?a zelZKi#e-<;_CW_mH{W<-L9B$6a%kThfm;@Xc!3vuO)-+K*Rr(d?&xgvbz}t0Ryuq- z2n*t5Zg!Y%qqZ_oTib0r+g13L6xh}TrAsqzDuTRA`;6E4o}W7!&QyC$;7wmkyEF*Q zKirR~FXE=tKjbD963l%HeT+m{KQDJ2$wc~jKJyRHrhj^=uV`1TE}_HdJ>54_so^#? z@WtEHX7q{1+S{A&?|)lgp2F|3ckxVZYve?1IGyytdS4eBeG(+AW6U7qnC;IseddO0 z_SFlI?IyNPQ>m9uS5g{%bd6$({FYW$R+g56lD{TixqLd?Xj1$Y^4f}TjD$wQxi_@Q z2(`@A{xhx=k}9@5m$8V+V^2? zabht(AkB0i6r0pK&0;x$z1WX(!-;ZFo`(K*o+K5Dyu_ENX6>9*ZpwR=;21b-$rKsT zOr62u3GA_Q9AU55oJI#L@mDQ^MvmRD1b2DCM}eISQjPbZ`p&W2Re8+Zv=>y(2x39L zxb)QxbXd88SmppG;C6tl`(Fmk=TuY_u&!q?TIPJ}cNYw*z`K86J7CHfo1Y({sP=Ja zFWk+j6UkxEzYNhZv3XC$bwkO!o?Y_55or9bLFjvRhTcCT1~RUP9{vnx(ke^ju>Ftd zFb&V_v|KGB`!S#BWR8lpyvET6f%>x?OGY;TWF&FjTqic^7u6$8C?{9;s_0WU>zTOe zS13|}yP2G(t93y^LAF|X#+T$CK_x^g#oLlMNikm6i8M1p36sb6qsNvwmQp-|Kj3)I zL~Hp>@cPSOq1UL{hAUnyEwvN-#$M^wzNsQx{}Yn999Jt1rJkv z>U86A=^7hx<(h_=M=%_lj!8vIuIpx~}?RN&MxTBd8W;9cTVZ-)0W?M??k5?wxkzt|E~A?jz{S`UZj0x8$tNRF)mh zlgmb32%l!#N@+J#g5_8ll5@!hjy%&i@bQH&WP=OH(W(qKLYMi+p|Hy~Ds~L&15w#9 z)xLxiEKW7OzYktYhJ$!q0!6g@)oGslcq9I|`$e1DUv$h}kNMCds zK(dM-HQD}|$a#NtZp>lsXZzy)h%@m`LzTPit-$hdaIT(^A4Y_Whq(Or!-B%X!D_#* zJRbXeZWgPhFh+cJM|lsvt*s4STNs}dhmxha<-v<4dAgRbMG!oS6S4_@rY;1MLV2UX zQ3Q65VO!-rv&v@rNyIppKgYDw`S%&!V~;lW^z_(NU+e0xhY_Hl}B=LD>RUGD-JFNG**Fthbn=ZjYJurjOlwZ2(j8@3r89c{bk zN$akFFP%(yDDWgHDd|F(prlUlW^bX5LD)L4oN13%hLnDcbeNkmpYq+s9gzd**= zTf4h~x4m0Od_6aXtusrGdnjKUVyTe*mtBucC7!zb$qQ_BLxj1L=A~lYYZs4A*THLx zlJnN?LmL*_tDw79{=nZf?O@)35&0HGxb^d(S6aX6k*Hn8>b_VRDQ<%=D%A3>mm5>;(>%CN~N) z;dAcQ4$+J1)q|<@&%4(NQ~g>y;V=n{wbe*skV8i!O0c3vwNvdR)60kovuB`f2}>wO zy)GQfiL5znZ=EP|EW4nb z)pKDW8|~Qs+VNAcqVJUAFP{Zfi%|WQCyA8+UMx=*M$gU#|9K_D9n}RN7;tmet0BE23m0Z9C z3|6;9h{(FKefQbR<4SHx{Hcj}`$~@q7uzouwIP*cPKf`Y?w>~YAi}R96|3jZ^TnrY zr@*ZVU2kqKOxx->vKmEi70{Yr4AoO^{B##M3~K8xzD86Ig?#?COaBY%Ri=iGo0NF% zLW?|rei9zyUW#XvySxk!c02Trh${27~@wolgPBBP4_6@Zos)eD5DqgmdE5!^Oeb44B~c}%mG=YK-BA(5t@Dif-5KgwVF6i_ z^jG4tw8U3yYDMLThSk9$C%4D+wr+=jh(eMw9|@zLks5jIuds68D+@U)-lqX}BL7)v^7fYCOm&aI_i(PJNA-V?dHWe|Hlw z7w)0p#u!inrs*a@=<{I5gtQJ-$Hm!z%~Onz4jl9>7xMC_CY~g z3*)Uli28>KLc!YGAh%O^IBz$1jKDj3y0pe(Cm!;^VS$b%w*n!Y*GzvIvnh50r=HR0 zP0~XvLf^H)SAr9 zwWdxR4cfX4pBvAA|IKr(IeyO#lx2SD8om2TY&dbcE5qIAet+dByI0AM+E*W}&X1(g z@x%U&>0b=x^DajJu7TeU)b=!8{04n}=b1XlV9;fJ)a^e0f-^^%_jm$7O7$KX>s?yD zNGvEZ9FPrtMbmIcjV+x;4gNv9Q-eK-3F2Wo7P^p31CpW!%0G?~l3^#G@BrW`I-n(q zVBUUJ4$dbUHE15uFRNLKqLMrV!{9cBMMd!2%2?v($lgbo1PXhKm2a5InZ_K$C}x%h zZ12|z8Ew8% zk|np#zax+Q$Ze<7m70i;^1y-sKpWO)vF#aJ0qaZOM!pXE6x&vMPJekf;Y?kG_I+$s zth4=0NuZ2Gh<(Q;r7>dq#y2MZc+4k;!C=zWaamMopLx;4Bvr@RgcAVqnEHV%TO8$8 z|JvV1tQ=6|;;^a%2vDB)^oQL2v_)Yhs(`4A3TJu--K zLOkT1tx!dc^iu#J%&92tdH~ZF-G8aS69FdLnNFJ(wKgB6@4M!v|N3AOV7js+As`ka z)=TXIkSXA17rDq1*uDrt2-@|3Geo<)122f$l8{jn_k3242{!QwBi@Dp`rewNXf+JI zm9C_-ZWE1W@3C)Q0hsn}NZ^+RO2c=$A$ywmB?af@r_*IMQh7N)0d@;CC(VHh%rl#qABWIQoV z%v4Q7iJ%`NK`Zg7U2_tk$}fJgE1K2N3sUIewNCai%R`fDY-?)h654_4u`9P?Yq=-^ zR+(2_{A2ygapkJY%2W`U>K6b8aq_l-4~8-_SFZ{m5VJlgHdYYUi0b@3>sV~xF~Uk0 zOP7Hely>W1_g7=WWqaWiHc#K{88I<5YUskyIpirUKt^`OHdBlE_xvPd#*$oS>E>l6 z3Fz(F$}h7Zh^M<1qQ}m=J-(5g>iVdebR$kgUXz3goXCX_2wKBZY1XQ*aBB1t8;_#y zM+wW;8WK@M4(RkojhZ2JKxMhJ_*h@LpZ6Ot=Z#O5ft|B!`kPR)BFNic5GO;DrE>hU z%Fd%KBfH58&(yJ`7lV!Yg(P3laqB*XUUt>&;wA|<&Ej>K6Wd=qjNKlqS-Tw%E&an+ zH=}U6*&&kXZO9v+DwnV^pcPK6L{U9nqDeBB`4XG$u^kw*;nRANM2-{bRGw{(ziKE_ zbx5HVz>2@DYKbD^wVws`c-?YrQP(siy*OxLd{I+g>8e=#^33N412>aTy)nNL-mUHz zuY1HT$eY^&yU>ny$2H7s#$^`Hr_zm84NJwDVLH&h^-g*1HTLqb{>An&GBaR3{*KIp+JOM3tn5>p0 zd5~=Z+iMez0`*-#BhKvi`5Tq`YdJ6c_`eXV=STG8Tih5_#e=%rt#MZIgp_naq$~E}Z;x`=b^6M~9<_X2fQBIaZ)w~kusm*J@n_V=QKno} z6hXAC;DJH*k;#JhFmt9xYJo_Jd(S0>A{sk789AT^tGhpB9OTv;j5r}bwUp*Er_dkJ zoCc(tIBtFoJr)1++21JYG!ko)sT~Ap!-&1NFK4=M#2$gJn9!#d?|rLSy}8gzk-@;j zC?YC=Ln}Kn&|6X_H1oa^s<^l~fS7l~ppEmV6E1wF)3@T_+#U);_#q!mTHKJ%97E2h+$iS$k6q}aU&k_8oLyX{6%iU<7)8kvqW3XbzYVvx}EJ~ica+oVIfe$RjE zy~2n>7iF=MiHi872QB3b-K&hB()=6C-HlR#fN32UdAYr9eGlqQx@#I64vD;qG{e*^ zaLId711d=${h?P=X6B`Kd70;tg9x!w*9iYXH9r@m}xpStb$9GDG z*WS-ALrm}zx3B+B785mye1c2Fh$B#zF+R^!hGhFuY2f<}MZ(=YpCwt(uTK?MbPc2( zjuf{ytYl#V`ncr(c@s+eje>2$VJ;8Zs~?$wOxjy0SKeYC8(iLF;6L6FA>xi>P32o6 z#U{2&HP89c$v06X-@w^&E3uG>?+5|@`k0~o6E<3=nSyrY-)9rG5`l}iP-|<8z2Gci za||1zbs4~dgHMU>GEzqd&q9E6{as^d?rIW%G`W!FU)MWQdAau@3zaDtlGEa-COQCG zF>`MO0RBLV9B)l|;{jby;CA&k86WcM=@XiO6P(k=tT~J#xiENIBn5R!1`DrR*BQtA zK`(TwV2J!^fHrid@qG7u#;;|t$`3#vGeH$8D=Twp$sH?OcuLs?-TOKd%t*&~){&PR za`AeQeTVSh?_mB(J=G2&uK}$YNWQ@wf>8AqXMiGN6F3(zyg^0ODoG&IfmoZC&tw5@ zmLgiW+PH+0beew&+j>Q{i2zqLSIwJHu5cWoK`cg}d&%)WWpS+ougynA_?l@@vSzp{ zaO$tvQSsr`OERsieEGN~bS?G^*^37{HOUiBOo&|CxUQbAZCsNA^PYmeNE<=&TRW`U{ z1zj#vD}ckb84E$2(EF`mi&S7W+j&S70j|uSgEIE(!fe$JjM_by_hH5`9{djgWT0nq KvFN=0qyGSE`To!V literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml index 11ad263dbf..6b31ae00c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,7 +46,7 @@ pages: - Check_MK Setup: Extensions/Agent-Setup.md - Extensions/Billing-Module.md - Extensions/Dell-OpenManage.md - - Extensions/Globe-Frontpage.md + - Extensions/World-Map.md - Extensions/Interface-Description-Parsing.md - Extensions/Network-Map.md - Extensions/Syslog.md