Skip to content

Docs 2 #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgraf-gh merged 6 commits into from
Mar 3, 2026
Merged

Docs 2 #21

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1828f7a
chore: simplify application-docker.properties configuration
dgraf-gh Mar 3, 2026
e3bc7fc
chore: add STATS_DIR environment variable and directory setup in Dock…
dgraf-gh Mar 3, 2026
c08e4d3
chore: update docker-compose.yml service configuration
dgraf-gh Mar 3, 2026
f01ebf9
docs: update README formatting and environment variable details
dgraf-gh Mar 3, 2026
f74755b
Merge branch 'main' into docs-2
dgraf-gh Mar 3, 2026
c4845cd
docs: add official instance details to README with usage guidelines
dgraf-gh Mar 3, 2026
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
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
![](.github/banner.png)

## Official Instance

There is an official instance of PAIKKA running at **https://geo.dedicatedcode.com** that you can use for free.

**Important notes about this instance:**
- There are **no usage limits or restrictions** – feel free to integrate it into your projects.
- However, there are **no guarantees about availability or SLA** (Service Level Agreement). The service is provided on a best-effort basis.
- The instance is shared among all users. **Please do not abuse it** – excessive or abusive usage will affect everyone else.

Be nice to each other and use the service responsibly.

PAIKKA is a specialized reverse geocoding service designed to provide high-performance location resolution for [Reitti](https://github.com/dedicatedcode/reitti). The name comes from the Finnish word for "place" and is pronounced [ˈpɑi̯kːɑ].

## Overview
Expand Down Expand Up @@ -485,4 +496,4 @@ This project is licensed under the GNU Affero General Public License v3 (AGPLv3)

## About

PAIKKA is developed as part of the Reitti ecosystem by (https://github.com/dedicatedcode). It provides the geocoding infrastructure that powers location-based features in Reitti.
PAIKKA is developed as part of the Reitti ecosystem by (https://github.com/dedicatedcode). It provides the geocoding infrastructure that powers location-based features in Reitti.
Loading