Skip to content

Commit 62c28aa

Browse files
authored
Docs 2 (#21)
* chore: simplify application-docker.properties configuration - Removed unused server and static resource settings. - Updated property names for consistency (`paikka.import-configuration.threads` → `paikka.import.threads`). - Adjusted default path for `paikka.stats-db-path`. * chore: add STATS_DIR environment variable and directory setup in Dockerfile * chore: update docker-compose.yml service configuration - Simplified environment variables for `paikka` service. - Adjusted `start_period` in healthcheck. - Removed unused volume drivers for cleaner setup. * docs: update README formatting and environment variable details - Improved list indentation for better readability. - Clarified admin password requirements and `.env` setup in Docker Compose section. - Updated memory and swap recommendations for import operations. - Enhanced example commands with detailed parameter descriptions. * docs: add official instance details to README with usage guidelines
1 parent 0835e51 commit 62c28aa

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
![](.github/banner.png)
22

3+
## Official Instance
4+
5+
There is an official instance of PAIKKA running at **https://geo.dedicatedcode.com** that you can use for free.
6+
7+
**Important notes about this instance:**
8+
- There are **no usage limits or restrictions** – feel free to integrate it into your projects.
9+
- However, there are **no guarantees about availability or SLA** (Service Level Agreement). The service is provided on a best-effort basis.
10+
- The instance is shared among all users. **Please do not abuse it** – excessive or abusive usage will affect everyone else.
11+
12+
Be nice to each other and use the service responsibly.
13+
314
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ːɑ].
415

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

486497
## About
487498

488-
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.
499+
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.

0 commit comments

Comments
 (0)