Skip to content

Commit f09cb61

Browse files
committed
add lgtm badges
move layer config info to wiki
1 parent 35023c3 commit f09cb61

File tree

1 file changed

+5
-35
lines changed

1 file changed

+5
-35
lines changed

README.md

+5-35
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Cloud-Tileserver
22

3-
[![Build Status](https://travis-ci.org/henrythasler/cloud-tileserver.svg?branch=master)](https://travis-ci.org/henrythasler/cloud-tileserver) [![Coverage Status](https://coveralls.io/repos/github/henrythasler/cloud-tileserver/badge.svg?branch=master)](https://coveralls.io/github/henrythasler/cloud-tileserver?branch=master) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=henrythasler_cloud-tileserver&metric=alert_status)](https://sonarcloud.io/dashboard?id=henrythasler_cloud-tileserver)
3+
[![Build Status](https://travis-ci.org/henrythasler/cloud-tileserver.svg?branch=master)](https://travis-ci.org/henrythasler/cloud-tileserver) [![Coverage Status](https://coveralls.io/repos/github/henrythasler/cloud-tileserver/badge.svg?branch=master)](https://coveralls.io/github/henrythasler/cloud-tileserver?branch=master)
4+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=henrythasler_cloud-tileserver&metric=alert_status)](https://sonarcloud.io/dashboard?id=henrythasler_cloud-tileserver)
5+
[![Total alerts](https://img.shields.io/lgtm/alerts/g/henrythasler/cloud-tileserver.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/henrythasler/cloud-tileserver/alerts/)
6+
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/henrythasler/cloud-tileserver.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/henrythasler/cloud-tileserver/context:javascript)
47

5-
Serve mapbox vectortiles via AWS stack.
8+
Serve mapbox vectortiles via AWS stack. Please visit the [Wiki](https://github.com/henrythasler/cloud-tileserver/wiki) for installation instructions.
69

710
## Goals
811

@@ -40,36 +43,3 @@ The Live-Demo is available at: [cyclemap.link](https://cyclemap.link)
4043
[![](docs/img/map_screenshot.png)](https://cyclemap.link/#15/48.17374/11.54676)
4144

4245
[![](docs/img/map_screenshot2.png)](https://cyclemap.link/#14/47.01863/11.5046)
43-
44-
### TOML Source-Definition file
45-
46-
The Lambda-function is configured via a toml-file (`sources.toml`). during the build-process. The TOML-File **should** contain an array of `sources`. Each source **may** contain properties and **should** contain an array of `layers`. Each Layer **may** contain properties and **may** contain an array of `variants`.
47-
48-
```
49-
[[sources]]
50-
property = foo
51-
(...)
52-
[[sources.layers]]
53-
property = bar
54-
(...)
55-
[[sources.layers.variants]]
56-
property = something
57-
```
58-
59-
#### Layer Properties
60-
61-
property | type | description | default if not given
62-
---|---|---|---
63-
name | `string` | A name for the item. Must be alphanumeric + underscore [A-Za-z0-9_]. No special characters allowed. | (must be provided)
64-
minzoom | `number` | minimum (greater-or-equal-than) zoom value where the layer must be provided | `0`
65-
maxzoom | `number` | maximum (less-than) zoom value where the layer must be provided | `32`
66-
geom | `string` | name of the geometry-column to be used in the vector tile | `"geometry"`
67-
keys | `string[]` | array of column names that will be encoded besides the geometry column. May contain SQL-expressions.| `""`
68-
where | `string[]` | array of conditions that will be used in the SQL-query as `WHERE`-Clause. Multiple conditions are concatenated with `AND` | `""`
69-
prefix | `string` | SQL-Statement that will be inserted **before** the `ST_AsMvtGeom`-Function. Useful for `DISTINCT ON()`-Statements | `""`
70-
postfix | `string` | SQL-Statement that will be inserted **after** the `WHERE`-Clause. Useful for `ORDER BY`-Statements | `""`
71-
srid | `number` | identifier of the [spatial reference system](https://postgis.net/docs/manual-1.4/ch04.html#spatial_ref_sys) | `3857`
72-
extend | `number` | tile extent in pixels (see [ST_AsMVTGeom](https://postgis.net/docs/manual-dev/ST_AsMVTGeom.html)) | `4096`
73-
buffer | `number` | buffer in pixels around each tile (see [ST_AsMVTGeom](https://postgis.net/docs/manual-dev/ST_AsMVTGeom.html)) | `256`
74-
clip_geom | `boolean` | clip geometries that lie outside the current tile incl. buffer (see [ST_AsMVTGeom](https://postgis.net/docs/manual-dev/ST_AsMVTGeom.html)) | `true`
75-

0 commit comments

Comments
 (0)