From be1187bc4639ff87f879bb03e696ad5c274f9ab5 Mon Sep 17 00:00:00 2001 From: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> Date: Sat, 11 Jan 2025 23:09:54 -0500 Subject: [PATCH] chore(docs): clarify experimental network features (#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 --- docs/docs/FAQ.mdx | 10 +++++++--- mobile/assets/i18n/en-US.json | 8 ++++---- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/docs/FAQ.mdx b/docs/docs/FAQ.mdx index 755698ba1d..5c6bbe3298 100644 --- a/docs/docs/FAQ.mdx +++ b/docs/docs/FAQ.mdx @@ -53,10 +53,14 @@ On iOS (iPhone and iPad), the operating system determines if a particular app ca - 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. - Use the Immich app more often. -### Why are features not working with a self-signed cert or mTLS? +### Why are features in the mobile app not working with a self-signed certificate, Basic Auth, custom headers, or mutual TLS? -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). -We recommend using a real SSL certificate from a free provider, for example [Let's Encrypt](https://letsencrypt.org/). +These network features are experimental. They often do not work with video playback, asset upload or download, and other features. +Many of these limitations are tracked in [#15230](https://github.com/immich-app/immich/issues/15230). +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. + +We are not actively developing these features and will not be able to provide support, but welcome contributions to improve them. +Please discuss any large PRs with our dev team to ensure your time is not wasted. --- diff --git a/mobile/assets/i18n/en-US.json b/mobile/assets/i18n/en-US.json index 1ff40b3566..c0d23c681d 100644 --- a/mobile/assets/i18n/en-US.json +++ b/mobile/assets/i18n/en-US.json @@ -16,7 +16,7 @@ "advanced_settings_proxy_headers_subtitle": "Define proxy headers Immich should send with each network request", "advanced_settings_proxy_headers_title": "Proxy Headers", "advanced_settings_self_signed_ssl_subtitle": "Skips SSL certificate verification for the server endpoint. Required for self-signed certificates.", - "advanced_settings_self_signed_ssl_title": "Allow self-signed SSL certificates", + "advanced_settings_self_signed_ssl_title": "Allow self-signed SSL certificates (EXPERIMENTAL)", "advanced_settings_tile_subtitle": "Advanced user's settings", "advanced_settings_tile_title": "Advanced", "advanced_settings_troubleshooting_subtitle": "Enable additional features for troubleshooting", @@ -174,7 +174,7 @@ "client_cert_remove": "Remove", "client_cert_remove_msg": "Client certificate is removed", "client_cert_subtitle": "Supports PKCS12 (.p12, .pfx) format only. Certificate Import/Remove is available only before login", - "client_cert_title": "SSL Client Certificate", + "client_cert_title": "SSL Client Certificate (EXPERIMENTAL)", "common_add_to_album": "Add to album", "common_change_password": "Change Password", "common_create_new_album": "Create new album", @@ -278,7 +278,7 @@ "header_settings_header_value_input": "Header value", "header_settings_page_title": "Proxy Headers", "headers_settings_tile_subtitle": "Define proxy headers the app should send with each network request", - "headers_settings_tile_title": "Custom proxy headers", + "headers_settings_tile_title": "Custom proxy headers (EXPERIMENTAL)", "home_page_add_to_album_conflicts": "Added {added} assets to album {album}. {failed} assets are already in the album.", "home_page_add_to_album_err_local": "Can not add local assets to albums yet, skipping", "home_page_add_to_album_success": "Added {added} assets to album {album}.", @@ -658,4 +658,4 @@ "viewer_unstack": "Un-Stack", "wifi_name": "WiFi Name", "your_wifi_name": "Your WiFi name" -} \ No newline at end of file +}