@basemaps/landing 6.46.0 → 7.0.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 (86) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +0 -2
  3. package/dist/docs/404.html +824 -0
  4. package/dist/docs/assets/images/favicon.png +0 -0
  5. package/dist/docs/assets/javascripts/bundle.cd18aaf1.min.js +29 -0
  6. package/dist/docs/assets/javascripts/bundle.cd18aaf1.min.js.map +7 -0
  7. package/dist/docs/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  8. package/dist/docs/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  9. package/dist/docs/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  10. package/dist/docs/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  11. package/dist/docs/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
  12. package/dist/docs/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  13. package/dist/docs/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  14. package/dist/docs/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  15. package/dist/docs/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
  16. package/dist/docs/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
  17. package/dist/docs/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  18. package/dist/docs/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
  19. package/dist/docs/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  20. package/dist/docs/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  21. package/dist/docs/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  22. package/dist/docs/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
  23. package/dist/docs/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
  24. package/dist/docs/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  25. package/dist/docs/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  26. package/dist/docs/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  27. package/dist/docs/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  28. package/dist/docs/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  29. package/dist/docs/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  30. package/dist/docs/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
  31. package/dist/docs/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  32. package/dist/docs/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  33. package/dist/docs/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
  34. package/dist/docs/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
  35. package/dist/docs/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
  36. package/dist/docs/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  37. package/dist/docs/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  38. package/dist/docs/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
  39. package/dist/docs/assets/javascripts/lunr/tinyseg.js +206 -0
  40. package/dist/docs/assets/javascripts/lunr/wordcut.js +6708 -0
  41. package/dist/docs/assets/javascripts/workers/search.f886a092.min.js +42 -0
  42. package/dist/docs/assets/javascripts/workers/search.f886a092.min.js.map +7 -0
  43. package/dist/docs/assets/stylesheets/main.fad675c6.min.css +1 -0
  44. package/dist/docs/assets/stylesheets/main.fad675c6.min.css.map +1 -0
  45. package/dist/docs/assets/stylesheets/palette.356b1318.min.css +1 -0
  46. package/dist/docs/assets/stylesheets/palette.356b1318.min.css.map +1 -0
  47. package/dist/docs/configuration/index.html +981 -0
  48. package/dist/docs/deployment/index.html +932 -0
  49. package/dist/docs/developer-guide/index.html +884 -0
  50. package/dist/docs/examples/_overview/index.html +870 -0
  51. package/dist/docs/examples/index.leaflet.xyz.3857.html +38 -0
  52. package/dist/docs/examples/index.maplibre.opacity.3857.html +215 -0
  53. package/dist/docs/examples/index.maplibre.vector.3857.html +45 -0
  54. package/dist/docs/examples/leaflet.xyz.3857/index.html +904 -0
  55. package/dist/docs/examples/maplibre.opacity.3857/index.html +1081 -0
  56. package/dist/docs/examples/maplibre.vector.3857/index.html +911 -0
  57. package/dist/docs/index.css +3 -0
  58. package/dist/docs/index.html +1141 -0
  59. package/dist/docs/linz-motif.svg +124 -0
  60. package/dist/docs/operator-guide/cog-quality/index.html +1121 -0
  61. package/dist/docs/operator-guide/empty-tiles/index.html +990 -0
  62. package/dist/docs/operator-guide/index.html +859 -0
  63. package/dist/docs/operator-guide/quick-start/index.html +1104 -0
  64. package/dist/docs/operator-guide/relief-shade/index.html +971 -0
  65. package/dist/docs/operator-guide/static/2023-06-26-gisborne-2023.png +0 -0
  66. package/dist/docs/operator-guide/static/quality__005_006_0_bilinear.webp +0 -0
  67. package/dist/docs/operator-guide/static/quality__005_006_0_lanczos.webp +0 -0
  68. package/dist/docs/operator-guide/static/quality__i6.bilinear.webp +0 -0
  69. package/dist/docs/operator-guide/static/quality__i6.cubic.webp +0 -0
  70. package/dist/docs/operator-guide/static/quality__i6.lanczos.webp +0 -0
  71. package/dist/docs/operator-guide/static/quality__resampling-overview.webp +0 -0
  72. package/dist/docs/operator-guide/static/quick-start__layers.png +0 -0
  73. package/dist/docs/operator-guide/static/relief__aerial.webp +0 -0
  74. package/dist/docs/operator-guide/static/relief__base.webp +0 -0
  75. package/dist/docs/operator-guide/static/relief__darken.webp +0 -0
  76. package/dist/docs/operator-guide/static/relief__lighten.webp +0 -0
  77. package/dist/docs/operator-guide/texture-shade/index.html +1014 -0
  78. package/dist/docs/quick-start/index.html +872 -0
  79. package/dist/docs/search/search_index.json +1 -0
  80. package/dist/docs/sitemap.xml +83 -0
  81. package/dist/docs/sitemap.xml.gz +0 -0
  82. package/dist/docs/static/basemaps-service.png +0 -0
  83. package/dist/docs/static/tile-resize.png +0 -0
  84. package/dist/docs/static/workflow-run.png +0 -0
  85. package/dist/docs/user-guide/index.html +856 -0
  86. package/package.json +7 -7
@@ -0,0 +1,1104 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en" class="no-js">
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width,initial-scale=1">
8
+
9
+
10
+
11
+ <link rel="canonical" href="http://localhost:8000/docs/operator-guide/quick-start/">
12
+
13
+
14
+ <link rel="prev" href="../empty-tiles/">
15
+
16
+
17
+ <link rel="next" href="../relief-shade/">
18
+
19
+
20
+ <link rel="icon" href="../../assets/images/favicon.png">
21
+ <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.14">
22
+
23
+
24
+
25
+ <title>Running LINZ Basemaps - Quick Start - LINZ Basemaps</title>
26
+
27
+
28
+
29
+ <link rel="stylesheet" href="../../assets/stylesheets/main.fad675c6.min.css">
30
+
31
+
32
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.356b1318.min.css">
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
46
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i%7COpen+Sans+Mono:400,400i,700,700i&display=fallback">
47
+ <style>:root{--md-text-font:"Open Sans";--md-code-font:"Open Sans Mono"}</style>
48
+
49
+
50
+
51
+ <link rel="stylesheet" href="../../index.css">
52
+
53
+ <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>
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+ <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>
63
+
64
+ <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
65
+
66
+
67
+
68
+
69
+
70
+ </head>
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
81
+
82
+
83
+
84
+ <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>
85
+
86
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
87
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
88
+ <label class="md-overlay" for="__drawer"></label>
89
+ <div data-md-component="skip">
90
+
91
+
92
+ <a href="#running-linz-basemaps-quick-start" class="md-skip">
93
+ Skip to content
94
+ </a>
95
+
96
+ </div>
97
+ <div data-md-component="announce">
98
+
99
+ </div>
100
+
101
+
102
+
103
+
104
+
105
+
106
+ <header class="md-header md-header--shadow" data-md-component="header">
107
+ <nav class="md-header__inner md-grid" aria-label="Header">
108
+ <a href="../.." title="LINZ Basemaps" class="md-header__button md-logo" aria-label="LINZ Basemaps" data-md-component="logo">
109
+
110
+ <img src="../../linz-motif.svg" alt="logo">
111
+
112
+ </a>
113
+ <label class="md-header__button md-icon" for="__drawer">
114
+
115
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
116
+ </label>
117
+ <div class="md-header__title" data-md-component="header-title">
118
+ <div class="md-header__ellipsis">
119
+ <div class="md-header__topic">
120
+ <span class="md-ellipsis">
121
+ LINZ Basemaps
122
+ </span>
123
+ </div>
124
+ <div class="md-header__topic" data-md-component="header-topic">
125
+ <span class="md-ellipsis">
126
+
127
+ Running LINZ Basemaps - Quick Start
128
+
129
+ </span>
130
+ </div>
131
+ </div>
132
+ </div>
133
+
134
+
135
+ <form class="md-header__option" data-md-component="palette">
136
+
137
+
138
+
139
+
140
+ <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
141
+
142
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
143
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></svg>
144
+ </label>
145
+
146
+
147
+
148
+
149
+
150
+ <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
151
+
152
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
153
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></svg>
154
+ </label>
155
+
156
+
157
+ </form>
158
+
159
+
160
+
161
+
162
+ <label class="md-header__button md-icon" for="__search">
163
+
164
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
165
+ </label>
166
+ <div class="md-search" data-md-component="search" role="dialog">
167
+ <label class="md-search__overlay" for="__search"></label>
168
+ <div class="md-search__inner" role="search">
169
+ <form class="md-search__form" name="search">
170
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
171
+ <label class="md-search__icon md-icon" for="__search">
172
+
173
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
174
+
175
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
176
+ </label>
177
+ <nav class="md-search__options" aria-label="Search">
178
+
179
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
180
+
181
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
182
+ </button>
183
+ </nav>
184
+
185
+ </form>
186
+ <div class="md-search__output">
187
+ <div class="md-search__scrollwrap" data-md-scrollfix>
188
+ <div class="md-search-result" data-md-component="search-result">
189
+ <div class="md-search-result__meta">
190
+ Initializing search
191
+ </div>
192
+ <ol class="md-search-result__list" role="presentation"></ol>
193
+ </div>
194
+ </div>
195
+ </div>
196
+ </div>
197
+ </div>
198
+
199
+
200
+ <div class="md-header__source">
201
+ <a href="https://github.com/linz/basemaps" title="Go to repository" class="md-source" data-md-component="source">
202
+ <div class="md-source__icon md-icon">
203
+
204
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! 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"/></svg>
205
+ </div>
206
+ <div class="md-source__repository">
207
+ GitHub
208
+ </div>
209
+ </a>
210
+ </div>
211
+
212
+ </nav>
213
+
214
+ </header>
215
+
216
+ <div class="md-container" data-md-component="container">
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <main class="md-main" data-md-component="main">
224
+ <div class="md-main__inner md-grid">
225
+
226
+
227
+
228
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
229
+ <div class="md-sidebar__scrollwrap">
230
+ <div class="md-sidebar__inner">
231
+
232
+
233
+
234
+
235
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
236
+ <label class="md-nav__title" for="__drawer">
237
+ <a href="../.." title="LINZ Basemaps" class="md-nav__button md-logo" aria-label="LINZ Basemaps" data-md-component="logo">
238
+
239
+ <img src="../../linz-motif.svg" alt="logo">
240
+
241
+ </a>
242
+ LINZ Basemaps
243
+ </label>
244
+
245
+ <div class="md-nav__source">
246
+ <a href="https://github.com/linz/basemaps" title="Go to repository" class="md-source" data-md-component="source">
247
+ <div class="md-source__icon md-icon">
248
+
249
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! 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"/></svg>
250
+ </div>
251
+ <div class="md-source__repository">
252
+ GitHub
253
+ </div>
254
+ </a>
255
+ </div>
256
+
257
+ <ul class="md-nav__list" data-md-scrollfix>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <li class="md-nav__item">
266
+ <a href="../.." class="md-nav__link">
267
+
268
+
269
+ <span class="md-ellipsis">
270
+ LINZ Basemaps
271
+ </span>
272
+
273
+
274
+ </a>
275
+ </li>
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+ <li class="md-nav__item">
286
+ <a href="../../configuration/" class="md-nav__link">
287
+
288
+
289
+ <span class="md-ellipsis">
290
+ Configuration
291
+ </span>
292
+
293
+
294
+ </a>
295
+ </li>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+ <li class="md-nav__item">
306
+ <a href="../../deployment/" class="md-nav__link">
307
+
308
+
309
+ <span class="md-ellipsis">
310
+ Deployment
311
+ </span>
312
+
313
+
314
+ </a>
315
+ </li>
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+ <li class="md-nav__item">
326
+ <a href="../../quick-start/" class="md-nav__link">
327
+
328
+
329
+ <span class="md-ellipsis">
330
+ Quick start guide
331
+ </span>
332
+
333
+
334
+ </a>
335
+ </li>
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+ <li class="md-nav__item md-nav__item--nested">
357
+
358
+
359
+
360
+
361
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
362
+
363
+
364
+
365
+ <div class="md-nav__link md-nav__container">
366
+ <a href="../../developer-guide/" class="md-nav__link ">
367
+
368
+
369
+ <span class="md-ellipsis">
370
+ Developer guide
371
+ </span>
372
+
373
+
374
+ </a>
375
+
376
+ </div>
377
+
378
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
379
+ <label class="md-nav__title" for="__nav_5">
380
+ <span class="md-nav__icon md-icon"></span>
381
+ Developer guide
382
+ </label>
383
+ <ul class="md-nav__list" data-md-scrollfix>
384
+
385
+
386
+
387
+ </ul>
388
+ </nav>
389
+
390
+ </li>
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+ <li class="md-nav__item md-nav__item--nested">
416
+
417
+
418
+
419
+
420
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
421
+
422
+
423
+ <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
424
+
425
+
426
+ <span class="md-ellipsis">
427
+ Examples
428
+ </span>
429
+
430
+
431
+ <span class="md-nav__icon md-icon"></span>
432
+ </label>
433
+
434
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
435
+ <label class="md-nav__title" for="__nav_6">
436
+ <span class="md-nav__icon md-icon"></span>
437
+ Examples
438
+ </label>
439
+ <ul class="md-nav__list" data-md-scrollfix>
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+ <li class="md-nav__item">
448
+ <a href="../../examples/_overview/" class="md-nav__link">
449
+
450
+
451
+ <span class="md-ellipsis">
452
+ Overview
453
+ </span>
454
+
455
+
456
+ </a>
457
+ </li>
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <li class="md-nav__item">
469
+ <a href="../../examples/leaflet.xyz.3857/" class="md-nav__link">
470
+
471
+
472
+ <span class="md-ellipsis">
473
+ Leaflet Raster Map
474
+ </span>
475
+
476
+
477
+ </a>
478
+ </li>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+ <li class="md-nav__item">
490
+ <a href="../../examples/maplibre.opacity.3857/" class="md-nav__link">
491
+
492
+
493
+ <span class="md-ellipsis">
494
+ Maplibre Opacity Slider
495
+ </span>
496
+
497
+
498
+ </a>
499
+ </li>
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+ <li class="md-nav__item">
511
+ <a href="../../examples/maplibre.vector.3857/" class="md-nav__link">
512
+
513
+
514
+ <span class="md-ellipsis">
515
+ Maplibre Vector Map
516
+ </span>
517
+
518
+
519
+ </a>
520
+ </li>
521
+
522
+
523
+
524
+
525
+ </ul>
526
+ </nav>
527
+
528
+ </li>
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
562
+
563
+
564
+
565
+
566
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
567
+
568
+
569
+
570
+ <div class="md-nav__link md-nav__container">
571
+ <a href="../" class="md-nav__link ">
572
+
573
+
574
+ <span class="md-ellipsis">
575
+ Operator guide
576
+ </span>
577
+
578
+
579
+ </a>
580
+
581
+
582
+ <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
583
+ <span class="md-nav__icon md-icon"></span>
584
+ </label>
585
+
586
+ </div>
587
+
588
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
589
+ <label class="md-nav__title" for="__nav_7">
590
+ <span class="md-nav__icon md-icon"></span>
591
+ Operator guide
592
+ </label>
593
+ <ul class="md-nav__list" data-md-scrollfix>
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+ <li class="md-nav__item">
604
+ <a href="../cog-quality/" class="md-nav__link">
605
+
606
+
607
+ <span class="md-ellipsis">
608
+ COG Quality
609
+ </span>
610
+
611
+
612
+ </a>
613
+ </li>
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+ <li class="md-nav__item">
625
+ <a href="../empty-tiles/" class="md-nav__link">
626
+
627
+
628
+ <span class="md-ellipsis">
629
+ Sparse Datasets and empty tiles
630
+ </span>
631
+
632
+
633
+ </a>
634
+ </li>
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+ <li class="md-nav__item md-nav__item--active">
648
+
649
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
650
+
651
+
652
+
653
+
654
+
655
+ <label class="md-nav__link md-nav__link--active" for="__toc">
656
+
657
+
658
+ <span class="md-ellipsis">
659
+ Running LINZ Basemaps - Quick Start
660
+ </span>
661
+
662
+
663
+ <span class="md-nav__icon md-icon"></span>
664
+ </label>
665
+
666
+ <a href="./" class="md-nav__link md-nav__link--active">
667
+
668
+
669
+ <span class="md-ellipsis">
670
+ Running LINZ Basemaps - Quick Start
671
+ </span>
672
+
673
+
674
+ </a>
675
+
676
+
677
+
678
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
679
+
680
+
681
+
682
+
683
+
684
+
685
+ <label class="md-nav__title" for="__toc">
686
+ <span class="md-nav__icon md-icon"></span>
687
+ Table of contents
688
+ </label>
689
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
690
+
691
+ <li class="md-nav__item">
692
+ <a href="#sample-imagery" class="md-nav__link">
693
+ <span class="md-ellipsis">
694
+ Sample Imagery
695
+ </span>
696
+ </a>
697
+
698
+ </li>
699
+
700
+ <li class="md-nav__item">
701
+ <a href="#running-basemaps-in-docker" class="md-nav__link">
702
+ <span class="md-ellipsis">
703
+ Running Basemaps in Docker
704
+ </span>
705
+ </a>
706
+
707
+ <nav class="md-nav" aria-label="Running Basemaps in Docker">
708
+ <ul class="md-nav__list">
709
+
710
+ <li class="md-nav__item">
711
+ <a href="#directly-from-the-tiff-files" class="md-nav__link">
712
+ <span class="md-ellipsis">
713
+ Directly from the tiff files
714
+ </span>
715
+ </a>
716
+
717
+ </li>
718
+
719
+ <li class="md-nav__item">
720
+ <a href="#creating-a-configuration-from-the-tiff-files" class="md-nav__link">
721
+ <span class="md-ellipsis">
722
+ Creating a configuration from the tiff files
723
+ </span>
724
+ </a>
725
+
726
+ </li>
727
+
728
+ </ul>
729
+ </nav>
730
+
731
+ </li>
732
+
733
+ </ul>
734
+
735
+ </nav>
736
+
737
+ </li>
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+ <li class="md-nav__item">
749
+ <a href="../relief-shade/" class="md-nav__link">
750
+
751
+
752
+ <span class="md-ellipsis">
753
+ Relief shade
754
+ </span>
755
+
756
+
757
+ </a>
758
+ </li>
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+ <li class="md-nav__item">
770
+ <a href="../texture-shade/" class="md-nav__link">
771
+
772
+
773
+ <span class="md-ellipsis">
774
+ Texture shading
775
+ </span>
776
+
777
+
778
+ </a>
779
+ </li>
780
+
781
+
782
+
783
+
784
+ </ul>
785
+ </nav>
786
+
787
+ </li>
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+ <li class="md-nav__item md-nav__item--nested">
809
+
810
+
811
+
812
+
813
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
814
+
815
+
816
+
817
+ <div class="md-nav__link md-nav__container">
818
+ <a href="../../user-guide/" class="md-nav__link ">
819
+
820
+
821
+ <span class="md-ellipsis">
822
+ User guide
823
+ </span>
824
+
825
+
826
+ </a>
827
+
828
+ </div>
829
+
830
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
831
+ <label class="md-nav__title" for="__nav_8">
832
+ <span class="md-nav__icon md-icon"></span>
833
+ User guide
834
+ </label>
835
+ <ul class="md-nav__list" data-md-scrollfix>
836
+
837
+
838
+
839
+ </ul>
840
+ </nav>
841
+
842
+ </li>
843
+
844
+
845
+
846
+ </ul>
847
+ </nav>
848
+ </div>
849
+ </div>
850
+ </div>
851
+
852
+
853
+
854
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
855
+ <div class="md-sidebar__scrollwrap">
856
+ <div class="md-sidebar__inner">
857
+
858
+
859
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
860
+
861
+
862
+
863
+
864
+
865
+
866
+ <label class="md-nav__title" for="__toc">
867
+ <span class="md-nav__icon md-icon"></span>
868
+ Table of contents
869
+ </label>
870
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
871
+
872
+ <li class="md-nav__item">
873
+ <a href="#sample-imagery" class="md-nav__link">
874
+ <span class="md-ellipsis">
875
+ Sample Imagery
876
+ </span>
877
+ </a>
878
+
879
+ </li>
880
+
881
+ <li class="md-nav__item">
882
+ <a href="#running-basemaps-in-docker" class="md-nav__link">
883
+ <span class="md-ellipsis">
884
+ Running Basemaps in Docker
885
+ </span>
886
+ </a>
887
+
888
+ <nav class="md-nav" aria-label="Running Basemaps in Docker">
889
+ <ul class="md-nav__list">
890
+
891
+ <li class="md-nav__item">
892
+ <a href="#directly-from-the-tiff-files" class="md-nav__link">
893
+ <span class="md-ellipsis">
894
+ Directly from the tiff files
895
+ </span>
896
+ </a>
897
+
898
+ </li>
899
+
900
+ <li class="md-nav__item">
901
+ <a href="#creating-a-configuration-from-the-tiff-files" class="md-nav__link">
902
+ <span class="md-ellipsis">
903
+ Creating a configuration from the tiff files
904
+ </span>
905
+ </a>
906
+
907
+ </li>
908
+
909
+ </ul>
910
+ </nav>
911
+
912
+ </li>
913
+
914
+ </ul>
915
+
916
+ </nav>
917
+ </div>
918
+ </div>
919
+ </div>
920
+
921
+
922
+
923
+ <div class="md-content" data-md-component="content">
924
+ <article class="md-content__inner md-typeset">
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+ <h1 id="running-linz-basemaps-quick-start">Running LINZ Basemaps - Quick Start</h1>
933
+ <p>There are three options for LINZ basemaps server deployment</p>
934
+ <ul>
935
+ <li>Using docker and <code>@basemaps/server</code></li>
936
+ <li>Running <code>@basemaps/server</code> directly</li>
937
+ <li>Deploying <code>@basemaps/server</code> as a AWS Lambda Function</li>
938
+ </ul>
939
+ <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>
940
+ <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>
941
+ <h2 id="sample-imagery">Sample Imagery</h2>
942
+ <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>
943
+ <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>
944
+ <p>Wānaka is a nice location so lets grab a combination of rural and urban imagery around Wānaka</p>
945
+ <ul>
946
+ <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>
947
+ <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>
948
+ </ul>
949
+ <p>Make a location to put the imagery</p>
950
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>mkdir<span class="w"> </span>-p<span class="w"> </span>imagery/queenstown-lakes_2022-2023_0.1m/
951
+ </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>mkdir<span class="w"> </span>-p<span class="w"> </span>imagery/otago_2017-2019_0.3m/
952
+ </span></code></pre></div>
953
+ <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>
954
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__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
955
+ </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__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
956
+ </span></code></pre></div>
957
+ <p>Download the Rural imagery 0.3m resolution</p>
958
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__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
959
+ </span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__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
960
+ </span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__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
961
+ </span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__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
962
+ </span></code></pre></div>
963
+ <p>Download the Urban imagery 0.1m resolution</p>
964
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__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
965
+ </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__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
966
+ </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__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
967
+ </span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__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
968
+ </span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__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
969
+ </span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6" href="#__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
970
+ </span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a>
971
+ </span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8" href="#__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
972
+ </span><span id="__span-3-9"><a id="__codelineno-3-9" name="__codelineno-3-9" href="#__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
973
+ </span><span id="__span-3-10"><a id="__codelineno-3-10" name="__codelineno-3-10" href="#__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
974
+ </span><span id="__span-3-11"><a id="__codelineno-3-11" name="__codelineno-3-11" href="#__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
975
+ </span><span id="__span-3-12"><a id="__codelineno-3-12" name="__codelineno-3-12" href="#__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
976
+ </span><span id="__span-3-13"><a id="__codelineno-3-13" name="__codelineno-3-13" href="#__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
977
+ </span></code></pre></div>
978
+ <h2 id="running-basemaps-in-docker">Running Basemaps in Docker</h2>
979
+ <p>Basemaps server can be run in two modes</p>
980
+ <ol>
981
+ <li>Directly from the tiff and stac folders</li>
982
+ <li>With a configuration file</li>
983
+ </ol>
984
+ <p>Directly from the tiffs is easier and faster to setup but does not allow for a more custom setup.</p>
985
+ <h3 id="directly-from-the-tiff-files">Directly from the tiff files</h3>
986
+ <p>To start the server, mount the imagery into <code>/imagery</code> so the server has access to it</p>
987
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
988
+ </span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__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>
989
+ </span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__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>
990
+ </span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span>ghcr.io/linz/basemaps/server:latest<span class="w"> </span><span class="nv">$PWD</span>/imagery/*
991
+ </span></code></pre></div>
992
+ <div class="admonition note">
993
+ <p class="admonition-title">Note</p>
994
+ <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>
995
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
996
+ </span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__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>
997
+ </span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__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>
998
+ </span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__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
999
+ </span></code></pre></div>
1000
+ </div>
1001
+ <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>
1002
+ <div class="language-text highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__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
1003
+ </span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__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
1004
+ </span></code></pre></div>
1005
+ <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>
1006
+ <p><img alt="QuickStart Layers" src="../static/quick-start__layers.png" /></p>
1007
+ <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>
1008
+ <ul>
1009
+ <li><code>:latest</code> - Current master branch</li>
1010
+ <li><code>:vX.Y.Z</code> - Specific release tag which does not move eg <code>:v0.0.0</code></li>
1011
+ <li><code>:vX.Y</code> - Moving tag for the latest major.minor release eg <code>:v7.0</code></li>
1012
+ <li><code>:vX</code> - Moving tag for the latest major release eg <code>:v7</code></li>
1013
+ </ul>
1014
+ <h3 id="creating-a-configuration-from-the-tiff-files">Creating a configuration from the tiff files</h3>
1015
+ <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>
1016
+ <p>A <a href="../../configuration/">tileset</a> needs to be created as the entry point for the configuration.</p>
1017
+ <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>
1018
+ <p>storing this JSON into <code>config/aerial.json</code></p>
1019
+ <div class="language-json highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="p">{</span>
1020
+ </span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;raster&quot;</span><span class="p">,</span>
1021
+ </span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ts_basic&quot;</span><span class="p">,</span>
1022
+ </span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Basic Imagery Basemap&quot;</span><span class="p">,</span>
1023
+ </span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">&quot;layers&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
1024
+ </span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="p">{</span>
1025
+ </span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="w"> </span><span class="c1">// Source location for EPSG:2193 Imagery, has to be absolute</span>
1026
+ </span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span><span class="nt">&quot;2193&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/home/user/basemaps-quick-start/imagery/otago_2017-2019_0.3m/&quot;</span><span class="p">,</span>
1027
+ </span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span><span class="c1">// url/slug friendly name of the imagery set</span>
1028
+ </span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;otago_2017-2019_0.3m&quot;</span><span class="p">,</span>
1029
+ </span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Otago 0.3m Rural Aerial Photos (2017-2019)&quot;</span><span class="w"> </span><span class="c1">// from collection.json#title</span>
1030
+ </span><span id="__span-7-12"><a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a><span class="w"> </span><span class="p">},</span>
1031
+ </span><span id="__span-7-13"><a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a><span class="w"> </span><span class="p">{</span>
1032
+ </span><span id="__span-7-14"><a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a><span class="w"> </span><span class="nt">&quot;2193&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/home/user/basemaps-quick-start/imagery/queenstown-lakes_2022-2023_0.1m/&quot;</span><span class="p">,</span>
1033
+ </span><span id="__span-7-15"><a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a><span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;queenstown-lakes_2022-2023_0.1m&quot;</span><span class="p">,</span>
1034
+ </span><span id="__span-7-16"><a id="__codelineno-7-16" name="__codelineno-7-16" href="#__codelineno-7-16"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Queenstown Lakes 0.1m Urban Aerial Photos (2022-2023)&quot;</span><span class="p">,</span>
1035
+ </span><span id="__span-7-17"><a id="__codelineno-7-17" name="__codelineno-7-17" href="#__codelineno-7-17"></a><span class="w"> </span><span class="c1">// Limit the imagery to greater than z15</span>
1036
+ </span><span id="__span-7-18"><a id="__codelineno-7-18" name="__codelineno-7-18" href="#__codelineno-7-18"></a><span class="w"> </span><span class="nt">&quot;minZoom&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">15</span>
1037
+ </span><span id="__span-7-19"><a id="__codelineno-7-19" name="__codelineno-7-19" href="#__codelineno-7-19"></a><span class="w"> </span><span class="p">}</span>
1038
+ </span><span id="__span-7-20"><a id="__codelineno-7-20" name="__codelineno-7-20" href="#__codelineno-7-20"></a><span class="w"> </span><span class="p">]</span>
1039
+ </span><span id="__span-7-21"><a id="__codelineno-7-21" name="__codelineno-7-21" href="#__codelineno-7-21"></a><span class="p">}</span>
1040
+ </span></code></pre></div>
1041
+ <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>
1042
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
1043
+ </span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__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>
1044
+ </span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__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>/
1045
+ </span></code></pre></div>
1046
+ <p>This generates a <code>config.json</code> which has all the information needed to start the server</p>
1047
+ <div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
1048
+ </span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__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>
1049
+ </span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__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>
1050
+ </span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__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
1051
+ </span></code></pre></div>
1052
+ <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>
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+ </article>
1062
+ </div>
1063
+
1064
+
1065
+ </div>
1066
+
1067
+ </main>
1068
+
1069
+ <footer class="md-footer">
1070
+
1071
+ <div class="md-footer-meta md-typeset">
1072
+ <div class="md-footer-meta__inner md-grid">
1073
+ <div class="md-copyright">
1074
+
1075
+ <div class="md-copyright__highlight">
1076
+ <a href="https://www.linz.govt.nz/copyright">© CC BY 4.0 LINZ</a>
1077
+ </div>
1078
+
1079
+
1080
+ Made with
1081
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1082
+ Material for MkDocs
1083
+ </a>
1084
+
1085
+ </div>
1086
+
1087
+ </div>
1088
+ </div>
1089
+ </footer>
1090
+
1091
+ </div>
1092
+ <div class="md-dialog" data-md-component="dialog">
1093
+ <div class="md-dialog__inner md-typeset"></div>
1094
+ </div>
1095
+
1096
+
1097
+ <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>
1098
+
1099
+
1100
+ <script src="../../assets/javascripts/bundle.cd18aaf1.min.js"></script>
1101
+
1102
+
1103
+ </body>
1104
+ </html>