New "Chat Sharing" page

New "Chat Sharing" docs page

docs/features/PWA.md

@@ -3,6 +3,8 @@ sidebar_position: 18
 title: "📱 Progressive Web App"
 ---
 
+COMING SOON!
+
 📱 Progressive Web App for Mobile: Enjoy a native progressive web application experience on your mobile device with offline access on localhost or a personal domain, and a smooth user interface. In order for our PWA to be installable on your device, it must be delivered in a secure context. This usually means that it must be served over HTTPS.
 
     To set up a PWA, you'll need some understanding of technologies like Linux, Docker, and reverse proxies such as Nginx, Caddy, or Traefik. Using these tools can help streamline the process of building and deploying a PWA tailored to your needs. While there's no "one-click install" option available, and your available option to securely deploy your Open WebUI instance over HTTPS requires user experience, using these resources can make it easier to create and deploy a PWA tailored to your needs.

docs/features/chat-overview/chatshare.md

@@ -1,7 +1,106 @@
 ---
-sidebar_position: 19
+sidebar_position: 3
 title: "🗨️ Chat Sharing"
 ---
 
+### Enabling Community Sharing
 
-🗨️ Local Chat Sharing: Generate and share chat links between users in an efficient and seamless manner, thereby enhancing collaboration and communication.
+To enable community sharing, follow these steps:
+
+1. Navigate to the **Admin Panel** page as an **Admin**.
+2. Click on the **Settings** tab.
+3. Toggle on **Enable Community Sharing** within the **General** settings tab.
+
+:::note
+**Note:** Only Admins can toggle the **Enable Community Sharing** option. If this option is toggled off, users and Admins will not see the **Share to Open WebUI Community** option for sharing their chats. Community sharing must be enabled by an Admin for users to share chats to the Open WebUI community.
+:::
+
+This will enable community sharing for all users on your Open WebUI instance.
+
+### Sharing Chats
+
+To share a chat:
+
+1. Select the chat conversation you want to share.
+2. Click on the 3-dots that appear when hovering the mouse pointer above the desired chat.
+3. Then click on the **Share** option.
+4. Select either **Share to Open WebUI Community** (if **Enable Community Sharing** is toggled on by an **Admin**) or **Copy Link**.
+
+#### Sharing to Open WebUI Community
+
+When you select `Share to Open WebUI Community`:
+
+* A new tab will open, allowing you to upload your chat as a snapshot to the Open WebUI community website (https://openwebui.com/chats/upload).
+* You can control who can view your uploaded chat by choosing from the following access settings:
+  * **Private**: Only you can access this chat.
+  * **Public**: Anyone on the internet can view the messages displayed in the chat snapshot.
+  * **Public, Full History**: Anyone on the internet can view the full regeneration history of your chat.
+
+:::note
+Note: You can change the permission level of your shared chats on the community platform at any time from your openwebui.com account.
+
+**Currently, shared chats on the community website cannot be found through search. However, future updates are planned to allow public chats to be discoverable by the public if their permission is set to `Public` or `Public, Full History`.**
+:::
+
+Example of a shared chat to the community platform website: https://openwebui.com/c/iamg30/5e3c569f-905e-4d68-a96d-8a99cc65c90f
+
+#### Copying a Share Link
+
+When you select `Copy Link`, a unique share link is generated that can be shared with others.
+
+**Important Considerations:**
+
+* The shared chat will only include messages that existed at the time the link was created. Any new messages sent within the chat after the link is generated will not be included, unless the link is deleted and updated with a new link.
+* The generated share link acts as a static snapshot of the chat at the time the link was generated.
+* To view the shared chat, users must:
+  1. Have an account on the Open WebUI instance where the link was generated.
+  2. Be signed in to their account on that instance.
+* If a user tries to access the shared link without being signed in, they will be redirected to the login page to log in before they can view the shared chat.
+
+### Viewing Shared Chats
+
+To view a shared chat:
+
+1. Ensure you are signed in to an account on the Open WebUI instance where the chat was shared.
+2. Click on the shared link provided to you.
+3. The chat will be displayed in a read-only format.
+4. If the Admin of the Open WebUI instance from which the shared link was shared has Text-to-Speech set up, there may be an audio button for messages to be read aloud to you (situational).
+
+### Updating Shared Chats
+
+To update a shared chat:
+
+1. Select the chat conversation you want to share.
+2. Click on the 3-dots that appear when hovering the mouse pointer above the desired chat.
+3. Click on the **Share** option.
+4. The **Share Chat** Modal should look different if you've shared a chat before.
+
+The **Share Chat** Modal includes the following options:
+
+* **before**: Opens a new tab to view the previously shared chat from the share link.
+* **delete this link**: Deletes the shared link of the chat and presents the initial share chat modal.
+* **Share to Open WebUI Community**: Opens a new tab for https://openwebui.com/chats/upload with the chat ready to be shared as a snapshot.
+* **Update and Copy Link**: Updates the snapshot of the chat of the previously shared chat link and copies it to your device's clipboard.
+
+### Deleting Shared Chats
+
+To delete a shared chat link:
+
+1. Select the chat conversation you want to delete the shared link for.
+2. Click on the 3-dots that appear when hovering the mouse pointer above the desired chat.
+3. Click on the **Share** option.
+4. The **Share Chat** Modal should look different if you've shared a chat before.
+5. Click on **delete this link**.
+
+Once deleted, the shared link will no longer be valid, and users will not be able to view the shared chat.
+
+:::note
+**Note:** Chats shared to the community platform cannot be deleted. To change the access level of a chat shared to the community platform:
+:::
+
+1. Log in to your Open WebUI account on openwebui.com.
+2. Click on your account username at the top right of the website.
+3. Click on **Chats**.
+4. Click on the chat you wish to change permission access for.
+5. Scroll to the bottom of the chat and update its permission level.
+6. Click the **Update Chat** button.

docs/features/chat-overview/favorite.md

@@ -3,5 +3,4 @@ sidebar_position: 1
 title: "⭐ Favorite Response"
 ---
 
-
-Test
+COMING SOON!

docs/features/chat-overview/index.mdx

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 1
 title: "😏 Chat Overview"
----
+---
+
+COMING SOON!

docs/features/memory.md

@@ -3,4 +3,6 @@ sidebar_position: 15
 title: "🧠 Memory (Experimental)"
 ---
 
+COMING SOON!
+
 🧠 Memory Feature: Manually add information you want your LLMs to remember via the Settings > Personalization > Memory menu. Memories can be added, edited, and deleted.

docs/features/oauth/index.mdx

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 4
 title: "🔐 OAuth"
----
+---
+
+COMING SOON!

docs/features/ollama.md

@@ -3,7 +3,7 @@ sidebar_position: 6
 title: "⚖️ Ollama Load Balancing"
 ---
 
-# Ollama Load Balancing Setup
+# ⚖️ Ollama Load Balancing Setup
 
 This guide demonstrates how to configure Open WebUI to connect to multiple Ollama instances for load balancing within your deployment. This approach enables you to distribute processing loads across several nodes, enhancing both performance and reliability. The configuration leverages environment variables to manage connections between container updates, rebuilds, or redeployments seamlessly.
 

docs/features/playgroundbeta/index.mdx

@@ -3,8 +3,4 @@ sidebar_position: 2
 title: "🛝 Playground (Beta)"
 ---
 
-import { TopBanners } from "@site/src/components/TopBanners";
-
-<TopBanners />
-
-Test
+COMING SOON!

docs/features/tasks.md

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 4
 title: "📝 Task Model"
----
+---
+
+COMING SOON!

docs/features/usergroups/assign-user.md

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 1
 title: "👥 Assign Users to User Group"
----
+---
+
+COMING SOON!

docs/features/usergroups/index.mdx

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 3
 title: "👨‍👧‍👦 User Groups"
----
+---
+
+COMING SOON!

docs/features/usergroups/providing-access.md

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 2
 title: "✅ Provide User Group Access"
----
+---
+
+COMING SOON!

docs/features/usergroups/usergroup-perms.md

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 0
 title: "☑️ User Group Permissions"
----
+---
+
+COMING SOON!

docs/features/videocall.md

@@ -3,6 +3,8 @@ sidebar_position: 21
 title: "📹 Video Call"
 ---
 
+COMING SOON!
+
 📹 Video Call Feature: Enable video calls with supported vision models like LlaVA and GPT-4o, adding a visual dimension to your communications.
 
     Both Camera & Microphone access is required using a secure connection over HTTPS for this feature to work.

docs/features/voicecall.md

@@ -3,6 +3,7 @@ sidebar_position: 20
 title: "🎙️ Hands-Free Voice Call"
 ---
 
+COMING SOON!
 
 🎙️ Hands-Free Voice Call Feature: Initiate voice calls without needing to use your hands, making interactions more seamless.
 

docs/features/workspace/index.mdx

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 0
 title: "🖥️ Workspace"
----
+---
+
+COMING SOON!

docs/features/workspace/prompts.md

@@ -1,4 +1,6 @@
 ---
 sidebar_position: 2
 title: "📚 Prompts"
----
+---
+
+COMING SOON!

docs/troubleshooting/password-reset.mdx

@@ -19,9 +19,13 @@ First, you need to create a bcrypt hash of your new password. Run the following
 htpasswd -bnBC 10 "" your-new-password | tr -d ':\n'
 ```
 
+**Note:** The output will include a bcrypt hash with special characters that need to be handled carefully. Any `$` characters in the hash will need to be triple-escaped (replaced with `\\\`) to be used correctly in the next step.
+
 ### Step 2: Update the Password in Docker 🔄
 
-Next, you'll update the password in your Docker deployment. Replace `HASH` in the command below with the bcrypt hash generated in Step 1. Also, replace `admin@example.com` with the email address linked to your admin account.
+Next, you'll update the password in your Docker deployment. Replace `HASH` in the command below with the bcrypt hash generated in Step 1, making sure to triple-escape any `$` characters. Also, replace `admin@example.com` with the email address linked to your admin account.
+
+**Important:** The following command may not work in all cases. If it doesn't work for you, try the alternative command below it.
 
 ```bash
 docker run --rm -v open-webui:/data alpine/socat EXEC:"bash -c 'apk add sqlite && echo UPDATE auth SET password='\''HASH'\'' WHERE email='\''admin@example.com'\''; | sqlite3 /data/webui.db'", STDIO
@@ -49,4 +53,5 @@ sqlite3 backend/data/webui.db "UPDATE auth SET password='HASH' WHERE email='admi
 
 ---
 
-📖 By following these straightforward steps, you'll regain access to your Open WebUI admin account in no time. If you encounter any issues during the process, please consider searching for your issue on forums or community platforms.
+📖 By following these straightforward steps, you'll regain access to your Open WebUI admin account in no time. If you encounter any issues during the process, please consider searching for your issue on forums or community platforms.
+```

docs/tutorials/integrations/web_search.md

@@ -21,7 +21,7 @@ If you want to modify the default configuration, follow these steps:
 git clone https://github.com/searxng/searxng-docker.git
 ```
 
-1. Navigate to the `searxng-docker` repository:
+2. Navigate to the `searxng-docker` repository:
 
 ```bash
 cd searxng-docker
@@ -109,6 +109,8 @@ search:
     # json is required
 ```
 
+The port in the settings.yml file for SearXNG should match that of the port number in your docker-compose.yml file for SearXNG. So if you plan to use port `1337` for example, you'd set both to `1337`. If you want to use port `8080`, keep both on `8080`. Feel free to change the `bind_address` from `0.0.0.0` to `127.0.0.1` instead. Leaving it on `0.0.0.0` means that SearXNG can listen across all interfaces, while `127.0.0.1` just means that its listening on localhost.
+
 </details>
 
 8. Your `searxng-docker/uwsgi.ini` file for SearXNG should look like:

docs/tutorials/speech-to-text/index.mdx

@@ -0,0 +1,6 @@
+---
+sidebar_position: 3
+title: "🗨️ Speech-to-Text"
+---
+
+Coming soon!

docs/tutorials/speech-to-text/openai.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 1
+title: "🗨️ OpenAI API"
+---
+
+Coming soon!

docs/tutorials/speech-to-text/webapi.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 2
+title: "🗨️ Web API"
+---
+
+Coming soon!

docs/tutorials/speech-to-text/whisper-local.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 0
+title: "🗨️ Whisper (Local)"
+---
+
+Coming soon!