Skip to content

Commit

Permalink
updated readme + small update
Browse files Browse the repository at this point in the history
  • Loading branch information
ambrazasp committed Oct 9, 2024
1 parent 19c08da commit 88cc6b6
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish-pmtiles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ jobs:
docker-image: ghcr.io/govlt/national-boundaries-vector
docker-context: vector/docker/static
file: vector/docker/static/Dockerfile
environment: ${{ (startsWith(github.ref, 'refs/tags/') && !contains(github.ref, 'pre')) && 'stable' || 'preview' }}
environment: ${{ startsWith(github.ref, 'refs/tags/') && 'stable' || 'preview' }}
no-cache: true
push: true
cache-from: ''
Expand Down
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Use hosted versions of boundaries on your website, with global low latency and h

### Self-Hosting

#### PMTiles

Download the latest PMTiles archives and host them on your own server.

| Type | Lithuanian Translation | PMTiles Archive URL |
Expand All @@ -41,6 +43,33 @@ Download the latest PMTiles archives and host them on your own server.
| **Streets** | Gatvių ribos | [streets.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/streets.pmtiles) |
| **Parcels** | Žemės sklypų ribos | [parcels.pmtiles](https://github.com/govlt/national-boundaries/releases/latest/download/parcels.pmtiles)<br/>(**Important:** visible from zoom level 14) |

Ensure to periodically download the PMTiles archives mentioned above to
your own S3 or file storage and utilize them as needed.

#### Docker Vector Tiles

Utilize the provided Docker
image [national-boundaries-vector](https://github.com/govlt/national-boundaries/pkgs/container/national-boundaries-vector),
which includes all PMTiles enabling you to serve vector tiles on-the-fly.

Here's an example of its usage with Docker Compose:

```yaml
services:
national-boundaries-vector:
image: ghcr.io/govlt/national-boundaries-vector:stable
pull_policy: always
restart: unless-stopped
ports:
- "80:80"
healthcheck:
test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://127.0.0.1:80/health || exit 1" ]
interval: 5s
timeout: 3s
start_period: 5s
retries: 5
```
## Architecture
```mermaid
Expand Down
2 changes: 0 additions & 2 deletions vector/docker/static/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ FROM caddy:2.8

EXPOSE 80

HEALTHCHECK --interval=30s --timeout=5s --start-period=5s --retries=3 CMD wget -qO- http://127.0.0.1:80/health || exit 1

# Copy Caddyfile
COPY ./caddy/Caddyfile /etc/caddy/Caddyfile

Expand Down

0 comments on commit 88cc6b6

Please sign in to comment.