@basemaps/server 6.27.0 → 6.29.0

package/CHANGELOG.md

@@ -3,6 +3,45 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.29.0](https://github.com/linz/basemaps/compare/v6.28.1...v6.29.0) (2022-06-27)
+
+
+### Bug Fixes
+
+* upgrade sharp to fix the bad webp upscalling behaviour ([#2261](https://github.com/linz/basemaps/issues/2261)) ([68fe14c](https://github.com/linz/basemaps/commit/68fe14c0549a884c0c4ededa40eb2d4bd7098590))
+
+
+### Features
+
+* **lambda-tiler:** serve assets via /v1/sprites and /v1/fonts ([#2246](https://github.com/linz/basemaps/issues/2246)) ([0e04c63](https://github.com/linz/basemaps/commit/0e04c631363d5b540ae16bfc8c4c7910e1308412))
+* **tiler-sharp:** extract regions before rescaling them when overzooming ([#2240](https://github.com/linz/basemaps/issues/2240)) ([fe9b858](https://github.com/linz/basemaps/commit/fe9b8588bbbe1aa8e719f7c8c645eada8c7e2876))
+
+
+
+
+
+## [6.28.1](https://github.com/linz/basemaps/compare/v6.28.0...v6.28.1) (2022-06-07)
+
+**Note:** Version bump only for package @basemaps/server
+
+
+
+
+
+# [6.28.0](https://github.com/linz/basemaps/compare/v6.27.0...v6.28.0) (2022-06-06)
+
+
+### Features
+
+* **docker:** add a container of basemaps-server and basemaps-landing ([#2225](https://github.com/linz/basemaps/issues/2225)) ([13f8144](https://github.com/linz/basemaps/commit/13f814446de0b2896e0ccca620d4b0a017380c14))
+* **server:** bundle basemaps-server cli so its easier to install ([#2218](https://github.com/linz/basemaps/issues/2218)) ([8457b66](https://github.com/linz/basemaps/commit/8457b66be6d0f54decf43b515bb78853cefbc8ed))
+* **server:** provide a better error when loading configuration bundles ([#2222](https://github.com/linz/basemaps/issues/2222)) ([8318192](https://github.com/linz/basemaps/commit/83181920c8a9e061babd38a8ffd0dec93830dced))
+* **sprites:** create sprites using sharp ([#2235](https://github.com/linz/basemaps/issues/2235)) ([e7b6a9e](https://github.com/linz/basemaps/commit/e7b6a9e9c95359dc866b40e7a6988837a71d9d96))
+
+
+
+
+
 # [6.27.0](https://github.com/linz/basemaps/compare/v6.26.0...v6.27.0) (2022-05-29)
 
 

package/README.md

@@ -2,14 +2,42 @@
 
 WMTS/XYZ Tile server command line interface.
 
-This wraps the @basemaps/lambda-tiler into a standalone express http server.
+This wraps the @basemaps/tiler into a standalone express http server.
 
 ## Usage
+Basemaps server expects a folder tree full of configuration, with multiple tilesets and styles configuration files.
 
+```bash
+basemaps-server --config path/to/config/
+```
+
+### Usage docker
+
+The server is also published as a docker container 
+
+```bash
+docker run -it \
+    --volume $PWD/config:/config \
+    --volume $PWD/tiffs:$PWD/tiffs \
+    -p 5000:5000 \
+     ghcr.io/linz/basemaps-server:v6.28.0 --config /config
 ```
-basemaps-server --config path/to/config
+
+Where `${PWD}/config` contains all the configuration and `${PWD}/tiffs` is all the relevant tiff files
+
+### Bundled configuration
+
+Basemaps server can also be configured with a single configuration bundle file, which can be created from a configuration folder
+
+By bundling the configuration the startup time is greatly reduced as each individual tiff file does not have to be scanned for dimensions, it does mean that new tiffs will not be picked up until a new bundle is created.
+
+```bash
+basemaps-server --config path/to/config/ --bundle config.bundle.json
+basemaps-server --config config.bundle.json
 ```
 
+
+### Usage with LINZ imagery
 Usage with basemaps config, you will need access to basemaps' imagery cache 
 
 please contact basemaps@linz.govt.nz if you need access.
@@ -20,6 +48,8 @@ basemaps-server --config basemaps-config/config
 ```
 
 
+
+
 ### Direct TIFF access
 
 If you have a folder of tiffs the basemaps-server can index the folder and create tiles from
@@ -32,7 +62,7 @@ For example given a structure where there are two folders full of tiffs
 /images/10_geographx_nz_texture_shade_2012_8-0m_01FHRPYJ5FV1XAARZAC4T4K6MC/*.tiff
 ```
 
-running `basemaps-server --config /images` will create two tile sets one for each folder `gebco_2021...` and `geographx_nz_t...` and then also create a combined layer in the order the tiffs are found.
+running `basemaps-server --config /images --no-config` will create two tile sets one for each folder `gebco_2021...` and `geographx_nz_t...` and then also create a combined layer in the order the tiffs are found.
 
 
 ## Developing
@@ -40,8 +70,10 @@ running `basemaps-server --config /images` will create two tile sets one for eac
 When running the `@basemaps/server` in development mode, ensure `@basemaps/landing` page has been bundled
 
 ```bash
-cd packages/landing
-yarn bundle
+yarn
+yarn build
+
+npx lerna run bundle --stream # Bundle everything
 ```
 
-This will package all the static assets into `landing/dist` and will be served from `http://localhost:3000`
+This will package all the static assets into `landing/dist` and will be served from `http://localhost:5000`