Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Three things commonly surprise people setting Shigola up for the first time:

| | |
|:---|:---|
| **The service root is the OGC landing page.** | `/` returns JSON. The embedded viewer is at `/viewer` — `/viewer` redirects to `/viewer/`, and the trailing slash matters because the viewer's assets are referenced relatively. An unknown path returns 404. |
| **The service root is the OGC landing page.** | `/` returns JSON. An unknown path returns 404. |
| **Cache keys begin with the tiling scheme.** | The key is `{tileMatrixSetId}/{map}/{layer}/{z}/{x}/{y}`. Without the scheme, tiles cut in two different schemes would collide at the same `z/x/y`. |
| **Cache writes do not block the response.** | Every cache, chained or not, hands its write to a bounded pool after the response is flushed. See [Layered cache](./layered-cache.md#writes-do-not-block-the-response). |

Expand All @@ -53,7 +53,7 @@ Three things commonly surprise people setting Shigola up for the first time:
[go-spatial/tegola](https://github.com/go-spatial/tegola), an open source vector tile server
created and maintained by the **[Go Spatial](https://github.com/go-spatial) team** and documented
at [tegola.io](https://tegola.io). Effectively all of this codebase is their work: the providers,
the geometry processing, the MVT encoder, the tile pipeline and the viewer all originate there.
the geometry processing, the MVT encoder and the tile pipeline all originate there.
Tegola is MIT licensed, Shigola keeps that licence and retains its copyright notice, and all
credit for what Shigola inherited belongs upstream.
- **morecantile** — Shigola's `tms` package is a faithful Go port of
Expand Down
19 changes: 8 additions & 11 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,18 @@ This will take care of

wait until the migration step exits and you're done.

## Shigola viewer
## Check it is serving

This example comes with the `mvt_postgis` provider. After you ran the prerequisites,
you can access the shigola viewer via `http://localhost:8080/viewer/`.
`http://localhost:8080/` returns the [OGC API - Tiles](./ogc-api-tiles.md) landing page — a JSON
document — and `http://localhost:8080/collections` lists your data as OGC collections.

> **Note the path.** `/` is the [OGC API - Tiles](./ogc-api-tiles.md) landing page — a JSON
> document — and the viewer lives at `/viewer`. Requesting `/viewer` redirects to `/viewer/`; the
> trailing slash matters, because the viewer's assets are referenced relatively.
The same data is reachable two ways — as OGC collections and through the native `/maps/...` routes
(for more on the difference see
[provider layers](./configuration.md#provider-layers "provider layers")).

While you are here, `http://localhost:8080/collections` lists the same data as OGC collections.

(for more on the differences see
[provider layers](./configuration.md#provider-layers "provider layers").

![Bonn, Germany](/images/bonn_internal_viewer.png)
To see the tiles on a map, point a client at them: the [tutorials](/tutorials) do this with
MapLibre, OpenLayers and Mapbox GL.

## Your first vector map

Expand Down
12 changes: 2 additions & 10 deletions docs/http-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ description: "Shigola API endpoints"
Shigola serves two tile APIs side by side: the **native** routes below, and an
**[OGC API - Tiles](./ogc-api-tiles.md)** surface documented separately.

> **The service root is the OGC landing page.** `/` returns JSON; the embedded viewer is at
> `/viewer`. An unknown path returns 404.
> **The service root is the OGC landing page.** `/` returns JSON. An unknown path returns 404.

## Native routes

Expand Down Expand Up @@ -125,20 +124,13 @@ For the OGC equivalent — TileJSON 3.0, per collection and per tiling scheme
### `GET` /maps/:map/style.json

Returns an automatically generated [Mapbox GL style](https://docs.mapbox.com/style-spec/) for the
map, used by the embedded viewer.
map, for a client to load directly.

### `GET` /metrics

Prometheus metrics, when a Prometheus observer is configured. Cache metrics are listed under
[Layered cache](./layered-cache.md#metrics).

### `GET` /viewer/

The embedded viewer. `/viewer` redirects to `/viewer/` — the
viewer's assets are referenced relatively and only resolve from a URL ending in a slash.

Excluded from the build with `-tags noViewer`.

## OGC API - Tiles routes

Full documentation on [OGC API - Tiles](./ogc-api-tiles.md).
Expand Down
6 changes: 2 additions & 4 deletions docs/ogc-api-tiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ the same bytes from the same cache entry.

### The service root is the landing page

OGC API - Tiles requires a landing page at the service root, so `/` returns JSON and the embedded
viewer is served from `/viewer`. `/viewer` redirects to `/viewer/` — the viewer's assets are
referenced relatively and only resolve from a URL ending in a slash. Point bookmarks, reverse-proxy
rules and health checks accordingly. An unknown path returns 404.
OGC API - Tiles requires a landing page at the service root, so `/` returns JSON. Point bookmarks,
reverse-proxy rules and health checks accordingly. An unknown path returns 404.

### Cache keys begin with the tiling scheme

Expand Down
3 changes: 0 additions & 3 deletions src/pages/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ go build -mod vendor ./cmd/shigola

Dependencies are vendored, so `-mod vendor` builds offline and pins exactly what CI used.

To build with the embedded viewer regenerated, run `go generate ./...` first — it shells out to
`npm` to build the viewer, and no-ops without it.

## Docker

```sh
Expand Down
4 changes: 2 additions & 2 deletions src/pages/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Most problems fall into a handful of shapes the docs already cover:
- **The cache is not being read.** See
[Cache is not being read](/documentation/debugging#cache-is-not-being-read) — a key format change
and a failing tier both present as a cache that never hits.
- **`/` returns JSON instead of the viewer.** That is the
[OGC landing page](/documentation/ogc-api-tiles); the viewer is at `/viewer/`.
- **`/` returns JSON.** That is the [OGC landing page](/documentation/ogc-api-tiles). To see the
tiles on a map, point a client at them, as the [tutorials](/tutorials) do.
- **A config key seems to be ignored.** Unknown keys are not rejected, so a typo is silent — check
the spelling against [Configuration](/documentation/configuration).

Expand Down
Binary file removed static/images/bonn_internal_viewer.png
Binary file not shown.