Skip to content

About

A storage addon for BlueMap that enables storing map data in S3-compatible storage services.

Topics

Resources

Stars

11 stars

Watchers

0 watching

Forks

Repository files navigation

BlueMapS3Storage

A storage addon for BlueMap that stores map data in S3-compatible storage services (Amazon S3, Cloudflare R2, MinIO, DigitalOcean Spaces, Backblaze B2, or anything else that speaks the S3 API) instead of the local filesystem.

Useful for distributed server architectures, environments without persistent local storage, and multi-server networks that need to share the same map data.

Requirements

  • BlueMap 5.3 or higher
  • Java 21 or higher
  • Access to an S3-compatible storage service

Quick start

  1. Download the latest jar from the releases page and put it into BlueMap's packs directory.
  2. Create a storage configuration with storage-type: "themeinerlp:s3", a bucket, an account ID or endpoint, and an access key.
  3. Set storage in a map configuration to that storage and restart the server. The tutorial walks through it end to end.

Documentation

Start at the documentation index, or jump straight in:

  • Tutorial: learn by putting a map on Cloudflare R2.
  • How-to guides: solve a specific task, such as connecting to AWS S3 or MinIO.
  • Reference: look up configuration keys, file locations and error messages.
  • Explanation: understand why the addon works the way it does.

License

GNU Affero General Public License v3.0 (AGPL-3.0)

Credits

Support

Open an issue on GitHub.

About

A storage addon for BlueMap that enables storing map data in S3-compatible storage services.

Topics

Resources

Stars

11 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages