@basemaps/landing 6.46.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/README.md +2 -4
  2. package/build/__tests__/config.debug.test.d.ts +0 -1
  3. package/build/__tests__/config.debug.test.js +11 -10
  4. package/build/__tests__/config.debug.test.js.map +1 -1
  5. package/build/__tests__/config.test.d.ts +0 -1
  6. package/build/__tests__/config.test.js +5 -4
  7. package/build/__tests__/config.test.js.map +1 -1
  8. package/build/__tests__/geojson.test.d.ts +0 -1
  9. package/build/__tests__/geojson.test.js +6 -5
  10. package/build/__tests__/geojson.test.js.map +1 -1
  11. package/build/__tests__/map.config.test.d.ts +0 -1
  12. package/build/__tests__/map.config.test.js +66 -65
  13. package/build/__tests__/map.config.test.js.map +1 -1
  14. package/build/__tests__/tile.matrix.test.d.ts +0 -1
  15. package/build/__tests__/tile.matrix.test.js +11 -10
  16. package/build/__tests__/tile.matrix.test.js.map +1 -1
  17. package/build/attribution.d.ts +8 -11
  18. package/build/attribution.js +145 -66
  19. package/build/attribution.js.map +1 -1
  20. package/build/components/copyable.d.ts +1 -2
  21. package/build/components/copyable.js +27 -18
  22. package/build/components/copyable.js.map +1 -1
  23. package/build/components/daterange.d.ts +0 -1
  24. package/build/components/daterange.js +11 -7
  25. package/build/components/daterange.js.map +1 -1
  26. package/build/components/debug.d.ts +13 -2
  27. package/build/components/debug.js +273 -78
  28. package/build/components/debug.js.map +1 -1
  29. package/build/components/layer.switcher.dropdown.d.ts +1 -2
  30. package/build/components/layer.switcher.dropdown.js +43 -29
  31. package/build/components/layer.switcher.dropdown.js.map +1 -1
  32. package/build/components/layout.footer.d.ts +0 -1
  33. package/build/components/layout.footer.js +7 -2
  34. package/build/components/layout.footer.js.map +1 -1
  35. package/build/components/layout.header.d.ts +1 -2
  36. package/build/components/layout.header.js +44 -23
  37. package/build/components/layout.header.js.map +1 -1
  38. package/build/components/link.d.ts +0 -1
  39. package/build/components/link.js +1 -1
  40. package/build/components/link.js.map +1 -1
  41. package/build/components/map.d.ts +14 -4
  42. package/build/components/map.js +221 -84
  43. package/build/components/map.js.map +1 -1
  44. package/build/components/map.switcher.d.ts +1 -2
  45. package/build/components/map.switcher.js +80 -31
  46. package/build/components/map.switcher.js.map +1 -1
  47. package/build/config.d.ts +0 -1
  48. package/build/config.debug.d.ts +6 -1
  49. package/build/config.debug.js +6 -0
  50. package/build/config.debug.js.map +1 -1
  51. package/build/config.js +4 -8
  52. package/build/config.js.map +1 -1
  53. package/build/config.layer.d.ts +31 -2
  54. package/build/config.layer.js +14 -6
  55. package/build/config.layer.js.map +1 -1
  56. package/build/config.map.d.ts +6 -6
  57. package/build/config.map.js +95 -29
  58. package/build/config.map.js.map +1 -1
  59. package/build/debug.map.d.ts +2 -3
  60. package/build/debug.map.js +57 -23
  61. package/build/debug.map.js.map +1 -1
  62. package/build/global.d.ts +3 -3
  63. package/build/index.d.ts +0 -1
  64. package/build/index.js.map +1 -1
  65. package/build/tile.matrix.d.ts +0 -1
  66. package/build/tile.matrix.js +12 -0
  67. package/build/tile.matrix.js.map +1 -1
  68. package/build/url.d.ts +4 -1
  69. package/build/url.js +10 -8
  70. package/build/url.js.map +1 -1
  71. package/build/webp.d.ts +0 -1
  72. package/build/webp.js.map +1 -1
  73. package/dist/docs/404.html +849 -0
  74. package/dist/docs/assets/images/favicon.png +0 -0
  75. package/dist/docs/assets/javascripts/bundle.6c14ae12.min.js +29 -0
  76. package/dist/docs/assets/javascripts/bundle.6c14ae12.min.js.map +7 -0
  77. package/dist/docs/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  78. package/dist/docs/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  79. package/dist/docs/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  80. package/dist/docs/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  81. package/dist/docs/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
  82. package/dist/docs/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  83. package/dist/docs/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  84. package/dist/docs/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  85. package/dist/docs/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
  86. package/dist/docs/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
  87. package/dist/docs/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  88. package/dist/docs/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
  89. package/dist/docs/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  90. package/dist/docs/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  91. package/dist/docs/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  92. package/dist/docs/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
  93. package/dist/docs/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
  94. package/dist/docs/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  95. package/dist/docs/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  96. package/dist/docs/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  97. package/dist/docs/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  98. package/dist/docs/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  99. package/dist/docs/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  100. package/dist/docs/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
  101. package/dist/docs/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  102. package/dist/docs/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  103. package/dist/docs/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
  104. package/dist/docs/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
  105. package/dist/docs/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
  106. package/dist/docs/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  107. package/dist/docs/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  108. package/dist/docs/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
  109. package/dist/docs/assets/javascripts/lunr/tinyseg.js +206 -0
  110. package/dist/docs/assets/javascripts/lunr/wordcut.js +6708 -0
  111. package/dist/docs/assets/javascripts/swagger-initializer.js +20 -0
  112. package/dist/docs/assets/javascripts/swagger-ui-bundle.js +3 -0
  113. package/dist/docs/assets/javascripts/swagger-ui-bundle.js.map +1 -0
  114. package/dist/docs/assets/javascripts/swagger-ui-es-bundle-core.js +3 -0
  115. package/dist/docs/assets/javascripts/swagger-ui-es-bundle-core.js.map +1 -0
  116. package/dist/docs/assets/javascripts/swagger-ui-es-bundle.js +3 -0
  117. package/dist/docs/assets/javascripts/swagger-ui-es-bundle.js.map +1 -0
  118. package/dist/docs/assets/javascripts/swagger-ui-standalone-preset.js +3 -0
  119. package/dist/docs/assets/javascripts/swagger-ui-standalone-preset.js.map +1 -0
  120. package/dist/docs/assets/javascripts/workers/search.f886a092.min.js +42 -0
  121. package/dist/docs/assets/javascripts/workers/search.f886a092.min.js.map +7 -0
  122. package/dist/docs/assets/stylesheets/main.fad675c6.min.css +1 -0
  123. package/dist/docs/assets/stylesheets/main.fad675c6.min.css.map +1 -0
  124. package/dist/docs/assets/stylesheets/palette.356b1318.min.css +1 -0
  125. package/dist/docs/assets/stylesheets/palette.356b1318.min.css.map +1 -0
  126. package/dist/docs/assets/stylesheets/swagger-ui-dark.css +833 -0
  127. package/dist/docs/assets/stylesheets/swagger-ui.css +3 -0
  128. package/dist/docs/assets/stylesheets/swagger-ui.css.map +1 -0
  129. package/dist/docs/assets/stylesheets/swagger-ui.js +2 -0
  130. package/dist/docs/assets/stylesheets/swagger-ui.js.map +1 -0
  131. package/dist/docs/assets/swagger-ui/oauth2-redirect.html +79 -0
  132. package/dist/docs/configuration/index.html +503 -0
  133. package/dist/docs/deployment/index.html +457 -0
  134. package/dist/docs/developer-guide/index.html +434 -0
  135. package/dist/docs/examples/_overview/index.html +413 -0
  136. package/dist/docs/examples/index.leaflet.xyz.3857.html +38 -0
  137. package/dist/docs/examples/index.maplibre.opacity.3857.html +215 -0
  138. package/dist/docs/examples/index.maplibre.vector.3857.html +45 -0
  139. package/dist/docs/examples/leaflet.xyz.3857/index.html +448 -0
  140. package/dist/docs/examples/maplibre.opacity.3857/index.html +625 -0
  141. package/dist/docs/examples/maplibre.vector.3857/index.html +455 -0
  142. package/dist/docs/index.css +3 -0
  143. package/dist/docs/index.html +623 -0
  144. package/dist/docs/linz-motif.svg +124 -0
  145. package/dist/docs/operator-guide/cog-quality/index.html +608 -0
  146. package/dist/docs/operator-guide/empty-tiles/index.html +513 -0
  147. package/dist/docs/operator-guide/gebco/index.html +479 -0
  148. package/dist/docs/operator-guide/index.html +413 -0
  149. package/dist/docs/operator-guide/quick-start/index.html +611 -0
  150. package/dist/docs/operator-guide/relief-shade/index.html +490 -0
  151. package/dist/docs/operator-guide/static/2023-06-26-gisborne-2023.png +0 -0
  152. package/dist/docs/operator-guide/static/quality__005_006_0_bilinear.webp +0 -0
  153. package/dist/docs/operator-guide/static/quality__005_006_0_lanczos.webp +0 -0
  154. package/dist/docs/operator-guide/static/quality__i6.bilinear.webp +0 -0
  155. package/dist/docs/operator-guide/static/quality__i6.cubic.webp +0 -0
  156. package/dist/docs/operator-guide/static/quality__i6.lanczos.webp +0 -0
  157. package/dist/docs/operator-guide/static/quality__resampling-overview.webp +0 -0
  158. package/dist/docs/operator-guide/static/quick-start__layers.png +0 -0
  159. package/dist/docs/operator-guide/static/relief__aerial.webp +0 -0
  160. package/dist/docs/operator-guide/static/relief__base.webp +0 -0
  161. package/dist/docs/operator-guide/static/relief__darken.webp +0 -0
  162. package/dist/docs/operator-guide/static/relief__lighten.webp +0 -0
  163. package/dist/docs/operator-guide/texture-shade/index.html +537 -0
  164. package/dist/docs/quick-start/index.html +419 -0
  165. package/dist/docs/sitemap.xml +98 -0
  166. package/dist/docs/sitemap.xml.gz +0 -0
  167. package/dist/docs/static/basemaps-service.png +0 -0
  168. package/dist/docs/static/tile-resize.png +0 -0
  169. package/dist/docs/static/workflow-run.png +0 -0
  170. package/dist/docs/user-guide/_get-started/index.html +602 -0
  171. package/dist/docs/user-guide/api-documentation/index.html +409 -0
  172. package/dist/docs/user-guide/api-documentation/swagger-c1884237.html +120 -0
  173. package/dist/docs/user-guide/swagger-api.json +393 -0
  174. package/dist/docs/user-guide/technical-documentation/index.html +930 -0
  175. package/package.json +17 -17
  176. package/CHANGELOG.md +0 -1374
  177. package/build/__tests__/config.debug.test.d.ts.map +0 -1
  178. package/build/__tests__/config.test.d.ts.map +0 -1
  179. package/build/__tests__/geojson.test.d.ts.map +0 -1
  180. package/build/__tests__/map.config.test.d.ts.map +0 -1
  181. package/build/__tests__/tile.matrix.test.d.ts.map +0 -1
  182. package/build/attribution.d.ts.map +0 -1
  183. package/build/components/copyable.d.ts.map +0 -1
  184. package/build/components/daterange.d.ts.map +0 -1
  185. package/build/components/debug.d.ts.map +0 -1
  186. package/build/components/layer.switcher.dropdown.d.ts.map +0 -1
  187. package/build/components/layout.footer.d.ts.map +0 -1
  188. package/build/components/layout.header.d.ts.map +0 -1
  189. package/build/components/link.d.ts.map +0 -1
  190. package/build/components/map.d.ts.map +0 -1
  191. package/build/components/map.switcher.d.ts.map +0 -1
  192. package/build/config.d.ts.map +0 -1
  193. package/build/config.debug.d.ts.map +0 -1
  194. package/build/config.layer.d.ts.map +0 -1
  195. package/build/config.map.d.ts.map +0 -1
  196. package/build/debug.map.d.ts.map +0 -1
  197. package/build/global.d.ts.map +0 -1
  198. package/build/index.d.ts.map +0 -1
  199. package/build/tile.matrix.d.ts.map +0 -1
  200. package/build/url.d.ts.map +0 -1
  201. package/build/webp.d.ts.map +0 -1
package/dist/docs/operator-guide/quick-start/index.html ADDED
@@ -0,0 +1,611 @@
1
+
2
+ <!DOCTYPE html>
3
+
4
+ <html class="no-js" lang="en">
5
+ <head>
6
+ <meta charset="utf-8"/>
7
+ <meta content="width=device-width,initial-scale=1" name="viewport"/>
8
+ <link href="http://localhost:8000/docs/operator-guide/quick-start/" rel="canonical"/>
9
+ <link href="../gebco/" rel="prev"/>
10
+ <link href="../relief-shade/" rel="next"/>
11
+ <link href="../../assets/images/favicon.png" rel="icon"/>
12
+ <meta content="mkdocs-1.5.3, mkdocs-material-9.4.10" name="generator"/>
13
+ <title>Running LINZ Basemaps - Quick Start - LINZ Basemaps</title>
14
+ <link href="../../assets/stylesheets/main.fad675c6.min.css" rel="stylesheet"/>
15
+ <link href="../../assets/stylesheets/palette.356b1318.min.css" rel="stylesheet"/>
16
+ <link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>
17
+ <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i%7COpen+Sans+Mono:400,400i,700,700i&amp;display=fallback" rel="stylesheet"/>
18
+ <style>:root{--md-text-font:"Open Sans";--md-code-font:"Open Sans Mono"}</style>
19
+ <link href="../../index.css" rel="stylesheet"/>
20
+ <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
21
+ <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config",""),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
22
+ <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
23
+ </head>
24
+ <body data-md-color-accent="indigo" data-md-color-primary="indigo" data-md-color-scheme="default" dir="ltr">
25
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
26
+ <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
27
+ <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
28
+ <label class="md-overlay" for="__drawer"></label>
29
+ <div data-md-component="skip">
30
+ <a class="md-skip" href="#running-linz-basemaps-quick-start">
31
+ Skip to content
32
+ </a>
33
+ </div>
34
+ <div data-md-component="announce">
35
+ </div>
36
+ <header class="md-header md-header--shadow" data-md-component="header">
37
+ <nav aria-label="Header" class="md-header__inner md-grid">
38
+ <a aria-label="LINZ Basemaps" class="md-header__button md-logo" data-md-component="logo" href="../.." title="LINZ Basemaps">
39
+ <img alt="logo" src="../../linz-motif.svg"/>
40
+ </a>
41
+ <label class="md-header__button md-icon" for="__drawer">
42
+ <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"></path></svg>
43
+ </label>
44
+ <div class="md-header__title" data-md-component="header-title">
45
+ <div class="md-header__ellipsis">
46
+ <div class="md-header__topic">
47
+ <span class="md-ellipsis">
48
+ LINZ Basemaps
49
+ </span>
50
+ </div>
51
+ <div class="md-header__topic" data-md-component="header-topic">
52
+ <span class="md-ellipsis">
53
+
54
+ Running LINZ Basemaps - Quick Start
55
+
56
+ </span>
57
+ </div>
58
+ </div>
59
+ </div>
60
+ <form class="md-header__option" data-md-component="palette">
61
+ <input aria-label="Switch to dark mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: light)" data-md-color-primary="indigo" data-md-color-scheme="default" id="__palette_1" name="__palette" type="radio"/>
62
+ <label class="md-header__button md-icon" for="__palette_2" hidden="" title="Switch to dark mode">
63
+ <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"></path></svg>
64
+ </label>
65
+ <input aria-label="Switch to light mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-primary="indigo" data-md-color-scheme="slate" id="__palette_2" name="__palette" type="radio"/>
66
+ <label class="md-header__button md-icon" for="__palette_1" hidden="" title="Switch to light mode">
67
+ <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"></path></svg>
68
+ </label>
69
+ </form>
70
+ <div class="md-header__source">
71
+ <a class="md-source" data-md-component="source" href="https://github.com/linz/basemaps" title="Go to repository">
72
+ <div class="md-source__icon md-icon">
73
+ <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"></path></svg>
74
+ </div>
75
+ <div class="md-source__repository">
76
+ GitHub
77
+ </div>
78
+ </a>
79
+ </div>
80
+ </nav>
81
+ </header>
82
+ <div class="md-container" data-md-component="container">
83
+ <main class="md-main" data-md-component="main">
84
+ <div class="md-main__inner md-grid">
85
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">
86
+ <div class="md-sidebar__scrollwrap">
87
+ <div class="md-sidebar__inner">
88
+ <nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0">
89
+ <label class="md-nav__title" for="__drawer">
90
+ <a aria-label="LINZ Basemaps" class="md-nav__button md-logo" data-md-component="logo" href="../.." title="LINZ Basemaps">
91
+ <img alt="logo" src="../../linz-motif.svg"/>
92
+ </a>
93
+ LINZ Basemaps
94
+ </label>
95
+ <div class="md-nav__source">
96
+ <a class="md-source" data-md-component="source" href="https://github.com/linz/basemaps" title="Go to repository">
97
+ <div class="md-source__icon md-icon">
98
+ <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"></path></svg>
99
+ </div>
100
+ <div class="md-source__repository">
101
+ GitHub
102
+ </div>
103
+ </a>
104
+ </div>
105
+ <ul class="md-nav__list" data-md-scrollfix="">
106
+ <li class="md-nav__item">
107
+ <a class="md-nav__link" href="../..">
108
+ <span class="md-ellipsis">
109
+ LINZ Basemaps
110
+ </span>
111
+ </a>
112
+ </li>
113
+ <li class="md-nav__item">
114
+ <a class="md-nav__link" href="../../configuration/">
115
+ <span class="md-ellipsis">
116
+ Configuration
117
+ </span>
118
+ </a>
119
+ </li>
120
+ <li class="md-nav__item">
121
+ <a class="md-nav__link" href="../../deployment/">
122
+ <span class="md-ellipsis">
123
+ Deployment
124
+ </span>
125
+ </a>
126
+ </li>
127
+ <li class="md-nav__item">
128
+ <a class="md-nav__link" href="../../quick-start/">
129
+ <span class="md-ellipsis">
130
+ Quick start guide
131
+ </span>
132
+ </a>
133
+ </li>
134
+ <li class="md-nav__item md-nav__item--nested">
135
+ <input class="md-nav__toggle md-toggle" id="__nav_5" type="checkbox"/>
136
+ <div class="md-nav__link md-nav__container">
137
+ <a class="md-nav__link" href="../../developer-guide/">
138
+ <span class="md-ellipsis">
139
+ Developer guide
140
+ </span>
141
+ </a>
142
+ </div>
143
+ <nav aria-expanded="false" aria-labelledby="__nav_5_label" class="md-nav" data-md-level="1">
144
+ <label class="md-nav__title" for="__nav_5">
145
+ <span class="md-nav__icon md-icon"></span>
146
+ Developer guide
147
+ </label>
148
+ <ul class="md-nav__list" data-md-scrollfix="">
149
+ </ul>
150
+ </nav>
151
+ </li>
152
+ <li class="md-nav__item md-nav__item--nested">
153
+ <input class="md-nav__toggle md-toggle" id="__nav_6" type="checkbox"/>
154
+ <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
155
+ <span class="md-ellipsis">
156
+ Examples
157
+ </span>
158
+ <span class="md-nav__icon md-icon"></span>
159
+ </label>
160
+ <nav aria-expanded="false" aria-labelledby="__nav_6_label" class="md-nav" data-md-level="1">
161
+ <label class="md-nav__title" for="__nav_6">
162
+ <span class="md-nav__icon md-icon"></span>
163
+ Examples
164
+ </label>
165
+ <ul class="md-nav__list" data-md-scrollfix="">
166
+ <li class="md-nav__item">
167
+ <a class="md-nav__link" href="../../examples/_overview/">
168
+ <span class="md-ellipsis">
169
+ Overview
170
+ </span>
171
+ </a>
172
+ </li>
173
+ <li class="md-nav__item">
174
+ <a class="md-nav__link" href="../../examples/leaflet.xyz.3857/">
175
+ <span class="md-ellipsis">
176
+ Leaflet Raster Map
177
+ </span>
178
+ </a>
179
+ </li>
180
+ <li class="md-nav__item">
181
+ <a class="md-nav__link" href="../../examples/maplibre.opacity.3857/">
182
+ <span class="md-ellipsis">
183
+ Maplibre Opacity Slider
184
+ </span>
185
+ </a>
186
+ </li>
187
+ <li class="md-nav__item">
188
+ <a class="md-nav__link" href="../../examples/maplibre.vector.3857/">
189
+ <span class="md-ellipsis">
190
+ Maplibre Vector Map
191
+ </span>
192
+ </a>
193
+ </li>
194
+ </ul>
195
+ </nav>
196
+ </li>
197
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
198
+ <input checked="" class="md-nav__toggle md-toggle" id="__nav_7" type="checkbox"/>
199
+ <div class="md-nav__link md-nav__container">
200
+ <a class="md-nav__link" href="../">
201
+ <span class="md-ellipsis">
202
+ Operator guide
203
+ </span>
204
+ </a>
205
+ <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
206
+ <span class="md-nav__icon md-icon"></span>
207
+ </label>
208
+ </div>
209
+ <nav aria-expanded="true" aria-labelledby="__nav_7_label" class="md-nav" data-md-level="1">
210
+ <label class="md-nav__title" for="__nav_7">
211
+ <span class="md-nav__icon md-icon"></span>
212
+ Operator guide
213
+ </label>
214
+ <ul class="md-nav__list" data-md-scrollfix="">
215
+ <li class="md-nav__item">
216
+ <a class="md-nav__link" href="../cog-quality/">
217
+ <span class="md-ellipsis">
218
+ COG Quality
219
+ </span>
220
+ </a>
221
+ </li>
222
+ <li class="md-nav__item">
223
+ <a class="md-nav__link" href="../empty-tiles/">
224
+ <span class="md-ellipsis">
225
+ Sparse Datasets and empty tiles
226
+ </span>
227
+ </a>
228
+ </li>
229
+ <li class="md-nav__item">
230
+ <a class="md-nav__link" href="../gebco/">
231
+ <span class="md-ellipsis">
232
+ Gebco re-project to NZTM2000Quad cog file
233
+ </span>
234
+ </a>
235
+ </li>
236
+ <li class="md-nav__item md-nav__item--active">
237
+ <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/>
238
+ <label class="md-nav__link md-nav__link--active" for="__toc">
239
+ <span class="md-ellipsis">
240
+ Running LINZ Basemaps - Quick Start
241
+ </span>
242
+ <span class="md-nav__icon md-icon"></span>
243
+ </label>
244
+ <a class="md-nav__link md-nav__link--active" href="./">
245
+ <span class="md-ellipsis">
246
+ Running LINZ Basemaps - Quick Start
247
+ </span>
248
+ </a>
249
+ <nav aria-label="Table of contents" class="md-nav md-nav--secondary">
250
+ <label class="md-nav__title" for="__toc">
251
+ <span class="md-nav__icon md-icon"></span>
252
+ Table of contents
253
+ </label>
254
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
255
+ <li class="md-nav__item">
256
+ <a class="md-nav__link" href="#sample-imagery">
257
+ <span class="md-ellipsis">
258
+ Sample Imagery
259
+ </span>
260
+ </a>
261
+ </li>
262
+ <li class="md-nav__item">
263
+ <a class="md-nav__link" href="#running-basemaps-in-docker">
264
+ <span class="md-ellipsis">
265
+ Running Basemaps in Docker
266
+ </span>
267
+ </a>
268
+ <nav aria-label="Running Basemaps in Docker" class="md-nav">
269
+ <ul class="md-nav__list">
270
+ <li class="md-nav__item">
271
+ <a class="md-nav__link" href="#directly-from-the-tiff-files">
272
+ <span class="md-ellipsis">
273
+ Directly from the tiff files
274
+ </span>
275
+ </a>
276
+ </li>
277
+ <li class="md-nav__item">
278
+ <a class="md-nav__link" href="#creating-a-configuration-from-the-tiff-files">
279
+ <span class="md-ellipsis">
280
+ Creating a configuration from the tiff files
281
+ </span>
282
+ </a>
283
+ </li>
284
+ </ul>
285
+ </nav>
286
+ </li>
287
+ </ul>
288
+ </nav>
289
+ </li>
290
+ <li class="md-nav__item">
291
+ <a class="md-nav__link" href="../relief-shade/">
292
+ <span class="md-ellipsis">
293
+ Relief shade
294
+ </span>
295
+ </a>
296
+ </li>
297
+ <li class="md-nav__item">
298
+ <a class="md-nav__link" href="../texture-shade/">
299
+ <span class="md-ellipsis">
300
+ Texture shading
301
+ </span>
302
+ </a>
303
+ </li>
304
+ </ul>
305
+ </nav>
306
+ </li>
307
+ <li class="md-nav__item md-nav__item--nested">
308
+ <input class="md-nav__toggle md-toggle" id="__nav_8" type="checkbox"/>
309
+ <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
310
+ <span class="md-ellipsis">
311
+ User guide
312
+ </span>
313
+ <span class="md-nav__icon md-icon"></span>
314
+ </label>
315
+ <nav aria-expanded="false" aria-labelledby="__nav_8_label" class="md-nav" data-md-level="1">
316
+ <label class="md-nav__title" for="__nav_8">
317
+ <span class="md-nav__icon md-icon"></span>
318
+ User guide
319
+ </label>
320
+ <ul class="md-nav__list" data-md-scrollfix="">
321
+ <li class="md-nav__item">
322
+ <a class="md-nav__link" href="../../user-guide/_get-started/">
323
+ <span class="md-ellipsis">
324
+ Get started with LINZ Basemaps
325
+ </span>
326
+ </a>
327
+ </li>
328
+ <li class="md-nav__item">
329
+ <a class="md-nav__link" href="../../user-guide/api-documentation/">
330
+ <span class="md-ellipsis">
331
+ API documentation
332
+ </span>
333
+ </a>
334
+ </li>
335
+ <li class="md-nav__item">
336
+ <a class="md-nav__link" href="../../user-guide/technical-documentation/">
337
+ <span class="md-ellipsis">
338
+ Technical documentation and specifications
339
+ </span>
340
+ </a>
341
+ </li>
342
+ </ul>
343
+ </nav>
344
+ </li>
345
+ </ul>
346
+ </nav>
347
+ </div>
348
+ </div>
349
+ </div>
350
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
351
+ <div class="md-sidebar__scrollwrap">
352
+ <div class="md-sidebar__inner">
353
+ <nav aria-label="Table of contents" class="md-nav md-nav--secondary">
354
+ <label class="md-nav__title" for="__toc">
355
+ <span class="md-nav__icon md-icon"></span>
356
+ Table of contents
357
+ </label>
358
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
359
+ <li class="md-nav__item">
360
+ <a class="md-nav__link" href="#sample-imagery">
361
+ <span class="md-ellipsis">
362
+ Sample Imagery
363
+ </span>
364
+ </a>
365
+ </li>
366
+ <li class="md-nav__item">
367
+ <a class="md-nav__link" href="#running-basemaps-in-docker">
368
+ <span class="md-ellipsis">
369
+ Running Basemaps in Docker
370
+ </span>
371
+ </a>
372
+ <nav aria-label="Running Basemaps in Docker" class="md-nav">
373
+ <ul class="md-nav__list">
374
+ <li class="md-nav__item">
375
+ <a class="md-nav__link" href="#directly-from-the-tiff-files">
376
+ <span class="md-ellipsis">
377
+ Directly from the tiff files
378
+ </span>
379
+ </a>
380
+ </li>
381
+ <li class="md-nav__item">
382
+ <a class="md-nav__link" href="#creating-a-configuration-from-the-tiff-files">
383
+ <span class="md-ellipsis">
384
+ Creating a configuration from the tiff files
385
+ </span>
386
+ </a>
387
+ </li>
388
+ </ul>
389
+ </nav>
390
+ </li>
391
+ </ul>
392
+ </nav>
393
+ </div>
394
+ </div>
395
+ </div>
396
+ <div class="md-content" data-md-component="content">
397
+ <article class="md-content__inner md-typeset">
398
+ <h1 id="running-linz-basemaps-quick-start">Running LINZ Basemaps - Quick Start</h1>
399
+ <p>There are three options for LINZ basemaps server deployment</p>
400
+ <ul>
401
+ <li>Using docker and <code>@basemaps/server</code></li>
402
+ <li>Running <code>@basemaps/server</code> directly</li>
403
+ <li>Deploying <code>@basemaps/server</code> as a AWS Lambda Function</li>
404
+ </ul>
405
+ <p>The easiest option for running linz/basemaps is using docker and <a href="https://github.com/linz/basemaps/pkgs/container/basemaps%2Fserver">@basemaps/server container</a></p>
406
+ <p>As a base you will need some imagery, <a href="https://docs.docker.com/engine/install/">docker</a> and the AWS Command line</p>
407
+ <h2 id="sample-imagery">Sample Imagery</h2>
408
+ <p>To use basemaps, we need some <a href="https://www.cogeo.org/">Cloud optimised geotiffs</a> (COGs), and optionally their <a href="https://stacspec.org/">STAC</a> metadata</p>
409
+ <p>LINZ has a public bucket <a href="https://github.com/linz/imagery"><code>s3://nz-imagery</code></a> which contains COGs which work well with basemaps.</p>
410
+ <p>Wānaka is a nice location so lets grab a combination of rural and urban imagery around Wānaka</p>
411
+ <ul>
412
+ <li><a href="https://basemaps.linz.govt.nz/@-44.6966924,169.1330252,z14.74?i=queenstown-lakes-2022-2023-0.1m">Queenstown-Lakes 2022-2023 0.1m</a></li>
413
+ <li><a href="https://basemaps.linz.govt.nz/@-44.6966924,169.1330252,z12.74?i=otago-rural-2017-2019-0.3m">Otago Rural 2017-2019 0.3m</a></li>
414
+ </ul>
415
+ <p>Make a location to put the imagery</p>
416
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a href="#__codelineno-0-1" id="__codelineno-0-1" name="__codelineno-0-1"></a>mkdir<span class="w"> </span>-p<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/
417
+ </span><span id="__span-0-2"><a href="#__codelineno-0-2" id="__codelineno-0-2" name="__codelineno-0-2"></a>mkdir<span class="w"> </span>-p<span class="w"> </span>imagery/otago_2017-2019_0.3m/
418
+ </span></code></pre></div>
419
+ <p>First download the <code>collection.json</code> since this bucket is public, use <code>--no-sign-request</code> with the aws cli to ensure your local aws credentials are not used.</p>
420
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a href="#__codelineno-1-1" id="__codelineno-1-1" name="__codelineno-1-1"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/collection.json<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/collection.json
421
+ </span><span id="__span-1-2"><a href="#__codelineno-1-2" id="__codelineno-1-2" name="__codelineno-1-2"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/otago_2017-2019_0.3m/rgb/2193/collection.json<span class="w"> </span>imagery/otago_2017-2019_0.3m/collection.json
422
+ </span></code></pre></div>
423
+ <p>Download the Rural imagery 0.3m resolution</p>
424
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a href="#__codelineno-2-1" id="__codelineno-2-1" name="__codelineno-2-1"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/otago_2017-2019_0.3m/rgb/2193/CB12_5000_0107.tiff<span class="w"> </span>imagery/otago_2017-2019_0.3m/CB12_5000_0107.tiff
425
+ </span><span id="__span-2-2"><a href="#__codelineno-2-2" id="__codelineno-2-2" name="__codelineno-2-2"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/otago_2017-2019_0.3m/rgb/2193/CB12_5000_0108.tiff<span class="w"> </span>imagery/otago_2017-2019_0.3m/CB12_5000_0108.tiff
426
+ </span><span id="__span-2-3"><a href="#__codelineno-2-3" id="__codelineno-2-3" name="__codelineno-2-3"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/otago_2017-2019_0.3m/rgb/2193/CA12_5000_1007.tiff<span class="w"> </span>imagery/otago_2017-2019_0.3m/CA12_5000_1007.tiff
427
+ </span><span id="__span-2-4"><a href="#__codelineno-2-4" id="__codelineno-2-4" name="__codelineno-2-4"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/otago_2017-2019_0.3m/rgb/2193/CA12_5000_1008.tiff<span class="w"> </span>imagery/otago_2017-2019_0.3m/CA12_5000_1008.tiff
428
+ </span></code></pre></div>
429
+ <p>Download the Urban imagery 0.1m resolution</p>
430
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a href="#__codelineno-3-1" id="__codelineno-3-1" name="__codelineno-3-1"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0434.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0434.tiff
431
+ </span><span id="__span-3-2"><a href="#__codelineno-3-2" id="__codelineno-3-2" name="__codelineno-3-2"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0435.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0435.tiff
432
+ </span><span id="__span-3-3"><a href="#__codelineno-3-3" id="__codelineno-3-3" name="__codelineno-3-3"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0435.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0435.tiff
433
+ </span><span id="__span-3-4"><a href="#__codelineno-3-4" id="__codelineno-3-4" name="__codelineno-3-4"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0436.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0436.tiff
434
+ </span><span id="__span-3-5"><a href="#__codelineno-3-5" id="__codelineno-3-5" name="__codelineno-3-5"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0437.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0437.tiff
435
+ </span><span id="__span-3-6"><a href="#__codelineno-3-6" id="__codelineno-3-6" name="__codelineno-3-6"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0438.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0438.tiff
436
+ </span><span id="__span-3-7"><a href="#__codelineno-3-7" id="__codelineno-3-7" name="__codelineno-3-7"></a>
437
+ </span><span id="__span-3-8"><a href="#__codelineno-3-8" id="__codelineno-3-8" name="__codelineno-3-8"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0534.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0534.tiff
438
+ </span><span id="__span-3-9"><a href="#__codelineno-3-9" id="__codelineno-3-9" name="__codelineno-3-9"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0535.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0535.tiff
439
+ </span><span id="__span-3-10"><a href="#__codelineno-3-10" id="__codelineno-3-10" name="__codelineno-3-10"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0536.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0536.tiff
440
+ </span><span id="__span-3-11"><a href="#__codelineno-3-11" id="__codelineno-3-11" name="__codelineno-3-11"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0536.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0536.tiff
441
+ </span><span id="__span-3-12"><a href="#__codelineno-3-12" id="__codelineno-3-12" name="__codelineno-3-12"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0537.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0537.tiff
442
+ </span><span id="__span-3-13"><a href="#__codelineno-3-13" id="__codelineno-3-13" name="__codelineno-3-13"></a>aws<span class="w"> </span>--no-sign-request<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://nz-imagery/otago/queenstown-lakes_2022-2023_0.1m/rgb/2193/CB12_1000_0538.tiff<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/CB12_1000_0538.tiff
443
+ </span></code></pre></div>
444
+ <h2 id="running-basemaps-in-docker">Running Basemaps in Docker</h2>
445
+ <p>Basemaps server can be run in two modes</p>
446
+ <ol>
447
+ <li>Directly from the tiff and stac folders</li>
448
+ <li>With a configuration file</li>
449
+ </ol>
450
+ <p>Directly from the tiffs is easier and faster to setup but does not allow for a more custom setup.</p>
451
+ <h3 id="directly-from-the-tiff-files">Directly from the tiff files</h3>
452
+ <p>To start the server, mount the imagery into <code>/imagery</code> so the server has access to it</p>
453
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a href="#__codelineno-4-1" id="__codelineno-4-1" name="__codelineno-4-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
454
+ </span><span id="__span-4-2"><a href="#__codelineno-4-2" id="__codelineno-4-2" name="__codelineno-4-2"></a><span class="w"> </span>-v<span class="w"> </span><span class="nv">$PWD</span>:<span class="nv">$PWD</span><span class="w"> </span><span class="se">\</span>
455
+ </span><span id="__span-4-3"><a href="#__codelineno-4-3" id="__codelineno-4-3" name="__codelineno-4-3"></a><span class="w"> </span>-p<span class="w"> </span><span class="m">5000</span>:5000<span class="w"> </span><span class="se">\</span>
456
+ </span><span id="__span-4-4"><a href="#__codelineno-4-4" id="__codelineno-4-4" name="__codelineno-4-4"></a><span class="w"> </span>ghcr.io/linz/basemaps/server:latest<span class="w"> </span><span class="nv">$PWD</span>/imagery/*
457
+ </span></code></pre></div>
458
+ <div class="admonition note">
459
+ <p class="admonition-title">Note</p>
460
+ <p>Basemaps logs into structured JSON log format it can be useful to run a pretty printer over it such as <a href="https://www.npmjs.com/package/pretty-json-log">pretty-json-log</a></p>
461
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a href="#__codelineno-5-1" id="__codelineno-5-1" name="__codelineno-5-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
462
+ </span><span id="__span-5-2"><a href="#__codelineno-5-2" id="__codelineno-5-2" name="__codelineno-5-2"></a><span class="w"> </span>-v<span class="w"> </span><span class="nv">$PWD</span>:<span class="nv">$PWD</span><span class="w"> </span><span class="se">\</span>
463
+ </span><span id="__span-5-3"><a href="#__codelineno-5-3" id="__codelineno-5-3" name="__codelineno-5-3"></a><span class="w"> </span>-p<span class="w"> </span><span class="m">5000</span>:5000<span class="w"> </span><span class="se">\</span>
464
+ </span><span id="__span-5-4"><a href="#__codelineno-5-4" id="__codelineno-5-4" name="__codelineno-5-4"></a><span class="w"> </span>ghcr.io/linz/basemaps/server:latest<span class="w"> </span><span class="nv">$PWD</span>/imagery/*<span class="w"> </span><span class="p">|</span><span class="w"> </span>pjl
465
+ </span></code></pre></div>
466
+ </div>
467
+ <p>The server should now be started and you should see the following log lines, informing you that two layers were loaded Otago and Queenstown in <a href="https://github.com/linz/NZTM2000TileMatrixSet">NZTM2000Quad</a> tile matrix</p>
468
+ <div class="language-text highlight"><pre><span></span><code><span id="__span-6-1"><a href="#__codelineno-6-1" id="__codelineno-6-1" name="__codelineno-6-1"></a>INFO Imagery:Loaded imagery=/home/user/tmp/basemaps-quick-start/imagery/otago_2017-2019_0.3m title=otago_2017-2019_0.3m tileMatrix=NZTM2000Quad files=4
469
+ </span><span id="__span-6-2"><a href="#__codelineno-6-2" id="__codelineno-6-2" name="__codelineno-6-2"></a>INFO Imagery:Loaded imagery=/home/user/tmp/basemaps-quick-start/imagery/queenstown-lakes_2022-2023_0.1m title=queenstown-lakes_2022-2023_0.1m tileMatrix=NZTM2000Quad files=10
470
+ </span></code></pre></div>
471
+ <p>Then open a browser to <code>http://localhost:5000/layers</code> This will load a list of the layers that have been imported into the system, clicking on any of the layers will take you to the layer.</p>
472
+ <p><img alt="QuickStart Layers" src="../static/quick-start__layers.png"/></p>
473
+ <p>It is not recommended to run <code>:latest</code> for any prolonged period of time, all of the containers are published with the following tags</p>
474
+ <ul>
475
+ <li><code>:latest</code> - Current master branch</li>
476
+ <li><code>:vX.Y.Z</code> - Specific release tag which does not move eg <code>:v0.0.0</code></li>
477
+ <li><code>:vX.Y</code> - Moving tag for the latest major.minor release eg <code>:v7.0</code></li>
478
+ <li><code>:vX</code> - Moving tag for the latest major release eg <code>:v7</code></li>
479
+ </ul>
480
+ <h3 id="creating-a-configuration-from-the-tiff-files">Creating a configuration from the tiff files</h3>
481
+ <p>Using the <a href="https://github.com/linz/basemaps/tree/master/packages/cli#usage----bundle">basemaps CLI</a> a configuration bundle can be generated.</p>
482
+ <p>A <a href="../../configuration/">tileset</a> needs to be created as the entry point for the configuration.</p>
483
+ <p>Below is a configuration for the two example layers, where the rural imagery sets underneath the urban imagery, and the urban imagery is only turned on when the zoom is greater than z15.</p>
484
+ <p>storing this JSON into <code>config/aerial.json</code></p>
485
+ <div class="language-json highlight"><pre><span></span><code><span id="__span-7-1"><a href="#__codelineno-7-1" id="__codelineno-7-1" name="__codelineno-7-1"></a><span class="p">{</span>
486
+ </span><span id="__span-7-2"><a href="#__codelineno-7-2" id="__codelineno-7-2" name="__codelineno-7-2"></a><span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"raster"</span><span class="p">,</span>
487
+ </span><span id="__span-7-3"><a href="#__codelineno-7-3" id="__codelineno-7-3" name="__codelineno-7-3"></a><span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ts_basic"</span><span class="p">,</span>
488
+ </span><span id="__span-7-4"><a href="#__codelineno-7-4" id="__codelineno-7-4" name="__codelineno-7-4"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Basic Imagery Basemap"</span><span class="p">,</span>
489
+ </span><span id="__span-7-5"><a href="#__codelineno-7-5" id="__codelineno-7-5" name="__codelineno-7-5"></a><span class="w"> </span><span class="nt">"layers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
490
+ </span><span id="__span-7-6"><a href="#__codelineno-7-6" id="__codelineno-7-6" name="__codelineno-7-6"></a><span class="w"> </span><span class="p">{</span>
491
+ </span><span id="__span-7-7"><a href="#__codelineno-7-7" id="__codelineno-7-7" name="__codelineno-7-7"></a><span class="w"> </span><span class="c1">// Source location for EPSG:2193 Imagery, has to be absolute</span>
492
+ </span><span id="__span-7-8"><a href="#__codelineno-7-8" id="__codelineno-7-8" name="__codelineno-7-8"></a><span class="w"> </span><span class="nt">"2193"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/home/user/basemaps-quick-start/imagery/otago_2017-2019_0.3m/"</span><span class="p">,</span>
493
+ </span><span id="__span-7-9"><a href="#__codelineno-7-9" id="__codelineno-7-9" name="__codelineno-7-9"></a><span class="w"> </span><span class="c1">// url/slug friendly name of the imagery set</span>
494
+ </span><span id="__span-7-10"><a href="#__codelineno-7-10" id="__codelineno-7-10" name="__codelineno-7-10"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"otago_2017-2019_0.3m"</span><span class="p">,</span>
495
+ </span><span id="__span-7-11"><a href="#__codelineno-7-11" id="__codelineno-7-11" name="__codelineno-7-11"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Otago 0.3m Rural Aerial Photos (2017-2019)"</span><span class="w"> </span><span class="c1">// from collection.json#title</span>
496
+ </span><span id="__span-7-12"><a href="#__codelineno-7-12" id="__codelineno-7-12" name="__codelineno-7-12"></a><span class="w"> </span><span class="p">},</span>
497
+ </span><span id="__span-7-13"><a href="#__codelineno-7-13" id="__codelineno-7-13" name="__codelineno-7-13"></a><span class="w"> </span><span class="p">{</span>
498
+ </span><span id="__span-7-14"><a href="#__codelineno-7-14" id="__codelineno-7-14" name="__codelineno-7-14"></a><span class="w"> </span><span class="nt">"2193"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/home/user/basemaps-quick-start/imagery/queenstown-lakes_2022-2023_0.1m/"</span><span class="p">,</span>
499
+ </span><span id="__span-7-15"><a href="#__codelineno-7-15" id="__codelineno-7-15" name="__codelineno-7-15"></a><span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"queenstown-lakes_2022-2023_0.1m"</span><span class="p">,</span>
500
+ </span><span id="__span-7-16"><a href="#__codelineno-7-16" id="__codelineno-7-16" name="__codelineno-7-16"></a><span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Queenstown Lakes 0.1m Urban Aerial Photos (2022-2023)"</span><span class="p">,</span>
501
+ </span><span id="__span-7-17"><a href="#__codelineno-7-17" id="__codelineno-7-17" name="__codelineno-7-17"></a><span class="w"> </span><span class="c1">// Limit the imagery to greater than z15</span>
502
+ </span><span id="__span-7-18"><a href="#__codelineno-7-18" id="__codelineno-7-18" name="__codelineno-7-18"></a><span class="w"> </span><span class="nt">"minZoom"</span><span class="p">:</span><span class="w"> </span><span class="mi">15</span>
503
+ </span><span id="__span-7-19"><a href="#__codelineno-7-19" id="__codelineno-7-19" name="__codelineno-7-19"></a><span class="w"> </span><span class="p">}</span>
504
+ </span><span id="__span-7-20"><a href="#__codelineno-7-20" id="__codelineno-7-20" name="__codelineno-7-20"></a><span class="w"> </span><span class="p">]</span>
505
+ </span><span id="__span-7-21"><a href="#__codelineno-7-21" id="__codelineno-7-21" name="__codelineno-7-21"></a><span class="p">}</span>
506
+ </span></code></pre></div>
507
+ <p>Then using the basemaps CLI a config can be bundled, assuming $PWD is the same folder that contains <code>imagery/</code> and <code>config/</code></p>
508
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a href="#__codelineno-8-1" id="__codelineno-8-1" name="__codelineno-8-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
509
+ </span><span id="__span-8-2"><a href="#__codelineno-8-2" id="__codelineno-8-2" name="__codelineno-8-2"></a><span class="w"> </span>-v<span class="w"> </span><span class="nv">$PWD</span>:<span class="nv">$PWD</span><span class="w"> </span><span class="se">\</span>
510
+ </span><span id="__span-8-3"><a href="#__codelineno-8-3" id="__codelineno-8-3" name="__codelineno-8-3"></a><span class="w"> </span>-it<span class="w"> </span>ghcr.io/linz/basemaps/cli:latest<span class="w"> </span>bundle<span class="w"> </span>--config<span class="w"> </span><span class="nv">$PWD</span>/config/<span class="w"> </span>--output<span class="w"> </span><span class="nv">$PWD</span>/
511
+ </span></code></pre></div>
512
+ <p>This generates a <code>config.json</code> which has all the information needed to start the server</p>
513
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a href="#__codelineno-9-1" id="__codelineno-9-1" name="__codelineno-9-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
514
+ </span><span id="__span-9-2"><a href="#__codelineno-9-2" id="__codelineno-9-2" name="__codelineno-9-2"></a><span class="w"> </span>-v<span class="w"> </span><span class="nv">$PWD</span>:<span class="nv">$PWD</span><span class="w"> </span><span class="se">\</span>
515
+ </span><span id="__span-9-3"><a href="#__codelineno-9-3" id="__codelineno-9-3" name="__codelineno-9-3"></a><span class="w"> </span>-p<span class="w"> </span><span class="m">5000</span>:5000<span class="w"> </span><span class="se">\</span>
516
+ </span><span id="__span-9-4"><a href="#__codelineno-9-4" id="__codelineno-9-4" name="__codelineno-9-4"></a><span class="w"> </span>ghcr.io/linz/basemaps/server:latest<span class="w"> </span>--config<span class="w"> </span><span class="nv">$PWD</span>/config.json
517
+ </span></code></pre></div>
518
+ <p>For more advanced usage of configuration files please take a look at <a href="https://github.com/linz/basemaps-config">linz/basemaps-config</a></p>
519
+ </article>
520
+ </div>
521
+ </div>
522
+ </main>
523
+ <footer class="md-footer">
524
+ <div class="md-footer-meta md-typeset">
525
+ <div class="md-footer-meta__inner md-grid">
526
+ <div class="md-copyright">
527
+ <div class="md-copyright__highlight">
528
+ <a href="https://www.linz.govt.nz/copyright">© CC BY 4.0 LINZ</a>
529
+ </div>
530
+
531
+
532
+ Made with
533
+ <a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank">
534
+ Material for MkDocs
535
+ </a>
536
+ </div>
537
+ </div>
538
+ </div>
539
+ </footer>
540
+ </div>
541
+ <div class="md-dialog" data-md-component="dialog">
542
+ <div class="md-dialog__inner md-typeset"></div>
543
+ </div>
544
+ <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.indexes", "content.code.copy"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
545
+ <script src="../../assets/javascripts/bundle.6c14ae12.min.js"></script>
546
+ <script>document$.subscribe(() => {
547
+ window.update_swagger_ui_iframe_height = function (id) {
548
+ var iFrameID = document.getElementById(id);
549
+ if (iFrameID) {
550
+ full_height = (iFrameID.contentWindow.document.body.scrollHeight + 80) + "px";
551
+ iFrameID.height = full_height;
552
+ iFrameID.style.height = full_height;
553
+ }
554
+ }
555
+
556
+ let iframe_id_list = []
557
+ var iframes = document.getElementsByClassName("swagger-ui-iframe");
558
+ for (var i = 0; i < iframes.length; i++) {
559
+ iframe_id_list.push(iframes[i].getAttribute("id"))
560
+ }
561
+
562
+ let ticking = true;
563
+
564
+ document.addEventListener('scroll', function(e) {
565
+ if (!ticking) {
566
+ window.requestAnimationFrame(()=> {
567
+ let half_vh = window.innerHeight/2;
568
+ for(var i = 0; i < iframe_id_list.length; i++) {
569
+ let element = document.getElementById(iframe_id_list[i])
570
+ if(element==null){
571
+ return
572
+ }
573
+ let diff = element.getBoundingClientRect().top
574
+ if(element.contentWindow.update_top_val){
575
+ element.contentWindow.update_top_val(half_vh - diff)
576
+ }
577
+ }
578
+ ticking = false;
579
+ });
580
+ ticking = true;
581
+ }
582
+ });
583
+
584
+ const dark_scheme_name = "slate"
585
+
586
+ window.scheme = document.body.getAttribute("data-md-color-scheme")
587
+ const options = {
588
+ attributeFilter: ['data-md-color-scheme'],
589
+ };
590
+ function color_scheme_callback(mutations) {
591
+ for (let mutation of mutations) {
592
+ if (mutation.attributeName === "data-md-color-scheme") {
593
+ scheme = document.body.getAttribute("data-md-color-scheme")
594
+ var iframe_list = document.getElementsByClassName("swagger-ui-iframe")
595
+ for(var i = 0; i < iframe_list.length; i++) {
596
+ var ele = iframe_list.item(i);
597
+ if (ele) {
598
+ if (scheme === dark_scheme_name) {
599
+ ele.contentWindow.enable_dark_mode();
600
+ } else {
601
+ ele.contentWindow.disable_dark_mode();
602
+ }
603
+ }
604
+ }
605
+ }
606
+ }
607
+ }
608
+ observer = new MutationObserver(color_scheme_callback);
609
+ observer.observe(document.body, options);
610
+ })</script></body>
611
+ </html>