Make it possible to host BlueMap on static web hosts with client decompression mode#815
Merged
Merged
Conversation
TBlueF
approved these changes
Jul 9, 2026
TBlueF
left a comment
Member
There was a problem hiding this comment.
I am currently in the process of rewriting the webapp, this feature is already implemented there.
But until that rewrite is done, i think it doesn't do any harm to merge this :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What it does
This PR is intended to address #293 by allowing you to host the
webdirectory generated by BlueMap on a static web host, such as Github Pages. This is achieved by modifyingweb/settings.jsonand adding"clientDecompression": true.A Github Pages demo is currently available from the following links (though I may move it soon):
Implementation details
There are two places that request files that are stored gzipped at rest:
textures.jsonand PRBMs. WhenclientDecompressionis on, it will attempt to fetch<filename>.gzinstead of the normal filename, usingRevalidatingFileLoader. After settingRevalidatingFileLoader.setClientDecompression(true), the file loader will decompress the gzipped data using the browser-native Compression Streams API.Possible issues
npm run dev), since the decompression code errors out withFailed to read data from the ReadableStream: “TypeError: The input data is corrupted: incorrect header check”. This seems to be the same issue faced by these folks: Can't download mp3 when self-hosting via Docker monochrome-music/monochrome#320. However, this does not affect the production environment.