-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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.
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
docs: update custom map style guide #11350
Conversation
Thanks for your PR. I was following this conversation. my recommendation is that the nginx config, at minimum, be hosted on a separate repo and a link provided under Community Guides. This level of specific instructions provides a large documentation burden to keep up to date that the current team isn’t familiar with. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good to me, with the exception of the nginx caching part. We should move that to an external gist/repo and add it the the community guides list instead.
- Split setting a style.json in Immich and creating a style with Maptiler - Make it clearer that this is the way to change tile provider
Includes detailed steps on how to use Nginx to build a caching proxy in front of OSM's tile server, and instructions on how to use it with Immich
Added a link to the guide on customizing map styles as well
…ings page" This reverts commit 664df1e.
This reverts commit 469e06a.
* docs:Reword "Custom Map Style" guide - Split setting a style.json in Immich and creating a style with Maptiler - Make it clearer that this is the way to change tile provider --------- Co-authored-by: Jason Rasmussen <[email protected]>
Following comments on immich-app#11350
* docs:Add link to nginx caching proxy guide Following comments on #11350 * docs:Fix typo * docs:Fix typo * docs:Switch to GitHub link
Following my conversation with @bo0tzz and @zackpollard on discord, I'm proposing this PR that adds details to the instance settings page to clarify that enabling maps makes you rely on third parties.
I also came-up with a Nginx-based solution to build a simple caching proxy in front of a tile server, for which I included a guide in the docs.
There are still some things that I would like to address, but for these I need to know what is okay with you :
style.json
files directly from a textarea on the settings pagestyle.json
from a default list of pre-made ones, using different tile providers. Though this probably requires server admins to fill an API key for their chosen service, which may in turn require proxying requests to the tile servers in order not to leak the API key to every clientsIn any case, I'm still worried about the current default tile provider and by the lack of transparency about it.