Skip to content

Commit 08556f2

Browse files
mmomjianvladd11
authored andcommitted
chore(docs): clarify experimental network features (immich-app#15228)
* auth * URL switch * mobile app * caps * headers, app changes * oxford comma * Match case to other use in Immich * add url * asset download also causes issues
1 parent 02b76ff commit 08556f2

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

docs/docs/FAQ.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,14 @@ On iOS (iPhone and iPad), the operating system determines if a particular app ca
5353
- Disable Background App Refresh for apps that don't need background tasks to run. This will reduce the competition for background task invocation for Immich.
5454
- Use the Immich app more often.
5555

56-
### Why are features not working with a self-signed cert or mTLS?
56+
### Why are features in the mobile app not working with a self-signed certificate, Basic Auth, custom headers, or mutual TLS?
5757

58-
Due to limitations in the upstream app/video library, using a self-signed TLS certificate or mutual TLS may break video playback or asset upload (both foreground and/or background).
59-
We recommend using a real SSL certificate from a free provider, for example [Let's Encrypt](https://letsencrypt.org/).
58+
These network features are experimental. They often do not work with video playback, asset upload or download, and other features.
59+
Many of these limitations are tracked in [#15230](https://github.com/immich-app/immich/issues/15230).
60+
Instead of these experimental features, we recommend using the URL switching feature, a VPN, or a [free trusted SSL certificate](https://letsencrypt.org/) for your domain.
61+
62+
We are not actively developing these features and will not be able to provide support, but welcome contributions to improve them.
63+
Please discuss any large PRs with our dev team to ensure your time is not wasted.
6064

6165
---
6266

mobile/assets/i18n/en-US.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"advanced_settings_proxy_headers_subtitle": "Define proxy headers Immich should send with each network request",
1717
"advanced_settings_proxy_headers_title": "Proxy Headers",
1818
"advanced_settings_self_signed_ssl_subtitle": "Skips SSL certificate verification for the server endpoint. Required for self-signed certificates.",
19-
"advanced_settings_self_signed_ssl_title": "Allow self-signed SSL certificates",
19+
"advanced_settings_self_signed_ssl_title": "Allow self-signed SSL certificates (EXPERIMENTAL)",
2020
"advanced_settings_tile_subtitle": "Advanced user's settings",
2121
"advanced_settings_tile_title": "Advanced",
2222
"advanced_settings_troubleshooting_subtitle": "Enable additional features for troubleshooting",
@@ -174,7 +174,7 @@
174174
"client_cert_remove": "Remove",
175175
"client_cert_remove_msg": "Client certificate is removed",
176176
"client_cert_subtitle": "Supports PKCS12 (.p12, .pfx) format only. Certificate Import/Remove is available only before login",
177-
"client_cert_title": "SSL Client Certificate",
177+
"client_cert_title": "SSL Client Certificate (EXPERIMENTAL)",
178178
"common_add_to_album": "Add to album",
179179
"common_change_password": "Change Password",
180180
"common_create_new_album": "Create new album",
@@ -278,7 +278,7 @@
278278
"header_settings_header_value_input": "Header value",
279279
"header_settings_page_title": "Proxy Headers",
280280
"headers_settings_tile_subtitle": "Define proxy headers the app should send with each network request",
281-
"headers_settings_tile_title": "Custom proxy headers",
281+
"headers_settings_tile_title": "Custom proxy headers (EXPERIMENTAL)",
282282
"home_page_add_to_album_conflicts": "Added {added} assets to album {album}. {failed} assets are already in the album.",
283283
"home_page_add_to_album_err_local": "Can not add local assets to albums yet, skipping",
284284
"home_page_add_to_album_success": "Added {added} assets to album {album}.",
@@ -658,4 +658,4 @@
658658
"viewer_unstack": "Un-Stack",
659659
"wifi_name": "WiFi Name",
660660
"your_wifi_name": "Your WiFi name"
661-
}
661+
}

0 commit comments

Comments
 (0)