1
0
forked from MTSR/mapserver
mapserver/doc/install.md
Buckaroo Banzai fc7303947d
Cicd overhaul (#393)
* go mod tidy

* alpha channel temp fix

* cicd overhaul

---------

Co-authored-by: BuckarooBanzay <BuckarooBanzay@users.noreply.github.com>
2024-06-28 17:29:29 +02:00

49 lines
1.4 KiB
Markdown

# Mapserver installation
**Please make a backup of your world in case something goes wrong**
## Simple installation
* Download the binary from the [releases](https://github.com/minetest-mapserver/mapserver/releases) for your architecture and platform
* Drop the binary into your world folder (the one with the `world.mt` and `map.sqlite` files)
* Start the mapserver via command-line: `./mapserver` or `./mapserver.exe`
* Point your browser to `http://127.0.0.1:8080`
For additional infos (lag,time,players => active mode) on the mapserver interface you should install the [mapserver-mod](mod.md)
## Docker image
Simple docker run example to run in the world-directory:
```
docker run --rm --it -p 8080:8080 -v $(pwd):/minetest -w /minetest ghcr.io/minetest-mapserver/mapserver
```
## Docker compose
Examplary `docker-compose` config:
```yml
services:
mapserver:
image: ghcr.io/minetest-mapserver/mapserver
restart: always
networks:
- default
depends_on:
- "postgres"
volumes:
- "./data/minetest/world:/minetest"
working_dir: "/minetest"
```
* See also: https://github.com/pandorabox-io/pandorabox.io/blob/master/docker-compose.yml
## Performance / Scalability
For small to medium setups the default values should suffice.
If you have a bigger map (say: above 10 GB) you should configure the mapserver accordingly:
* See [Mapobject-Database](./mapobjectdb.md) for a scalable mapserver database