Skip to content
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

Merged
merged 5 commits into from
Aug 13, 2024
Merged

Conversation

pcouy
Copy link
Contributor

@pcouy pcouy commented Jul 25, 2024

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 :

  • I still think that because of this reliance on third parties, the map feature should be disabled by default, or at the very least a screen about this (featuring a toggle) should be shown during onboarding.
  • It would be really nice to have a way to edit the style.json files directly from a textarea on the settings page
  • The ideal would be to allow users to pick a style.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 clients

In any case, I'm still worried about the current default tile provider and by the lack of transparency about it.

@github-actions github-actions bot added documentation Improvements or additions to documentation 🖥️web labels Jul 25, 2024
@mmomjian
Copy link
Contributor

mmomjian commented Jul 25, 2024

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.

Copy link
Contributor

@jrasm91 jrasm91 left a 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.

pcouy and others added 5 commits August 13, 2024 11:53
- 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
@jrasm91 jrasm91 changed the title Document the implications of enabling the map and changing tile provider docs: update custom map style guide Aug 13, 2024
@jrasm91 jrasm91 enabled auto-merge (squash) August 13, 2024 16:02
@jrasm91 jrasm91 merged commit c924f6c into immich-app:main Aug 13, 2024
23 of 24 checks passed
Yuvi-raj-P pushed a commit to Yuvi-raj-P/immich that referenced this pull request Aug 19, 2024
* 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]>
pcouy added a commit to pcouy/immich that referenced this pull request Aug 30, 2024
jrasm91 pushed a commit that referenced this pull request Aug 30, 2024
* docs:Add link to nginx caching proxy guide

Following comments on #11350

* docs:Fix typo

* docs:Fix typo

* docs:Switch to GitHub link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🖥️web
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants