From 994923a318d25c8c5bd777e3cd0229849a4b1dd6 Mon Sep 17 00:00:00 2001 From: Matthew Hand Date: Wed, 6 Nov 2024 19:33:27 +0000 Subject: [PATCH 1/5] docs: Add frontmatter metadata to Docker and HTTPS Nginx tutorials --- docs/tutorials/integrations/docker-install.md | 4 ++++ docs/tutorials/integrations/https-nginx.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/tutorials/integrations/docker-install.md b/docs/tutorials/integrations/docker-install.md index d459d6c..3dd3f59 100644 --- a/docs/tutorials/integrations/docker-install.md +++ b/docs/tutorials/integrations/docker-install.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +title: Installing Docker +--- # Installing Docker diff --git a/docs/tutorials/integrations/https-nginx.md b/docs/tutorials/integrations/https-nginx.md index 03be8bd..caff3c8 100644 --- a/docs/tutorials/integrations/https-nginx.md +++ b/docs/tutorials/integrations/https-nginx.md @@ -1,3 +1,7 @@ +--- +title: HTTPS using Nginx +--- + :::warning This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial. ::: From b00b27b031e7ada07c2b74f5aaf4df9eddf28f3f Mon Sep 17 00:00:00 2001 From: Matthew Hand Date: Wed, 6 Nov 2024 19:37:02 +0000 Subject: [PATCH 2/5] docs: Add GitHub Community link to resources section --- docs/getting-started/using-openwebui/resources.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/using-openwebui/resources.mdx b/docs/getting-started/using-openwebui/resources.mdx index 2147226..e6958d6 100644 --- a/docs/getting-started/using-openwebui/resources.mdx +++ b/docs/getting-started/using-openwebui/resources.mdx @@ -20,10 +20,12 @@ Visit [Open WebUI](https://openwebui.com/) for official documentation, tools, an ## 🌍 Community Platforms Connect with the Open WebUI community for support, tips, and discussions. -- **Discord**: Join our community on Discord to chat with other users, ask questions, and stay updated. +- **Discord**: Join our community on Discord to chat with other users, ask questions, and stay updated. [Join the Discord Server](https://discord.com/invite/5rJgQTnV4s) -- **Reddit**: Follow the Open WebUI subreddit for announcements, discussions, and user-submitted content. +- **Reddit**: Follow the Open WebUI subreddit for announcements, discussions, and user-submitted content. [Visit Reddit Community](https://www.reddit.com/r/OpenWebUI/) +- **GitHub Community**: Participate in discussions, propose feature requests, and report issues specific to the Open WebUI Community Platform website. + [Explore the GitHub Community](https://github.com/open-webui/community) --- From fe6c177329a4154a33ef77f570664a7040dde754 Mon Sep 17 00:00:00 2001 From: Matthew Hand Date: Wed, 6 Nov 2024 19:41:57 +0000 Subject: [PATCH 3/5] fix: eliminate non compliant whitespace --- docs/getting-started/using-openwebui/resources.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/using-openwebui/resources.mdx b/docs/getting-started/using-openwebui/resources.mdx index e6958d6..2bf1a3f 100644 --- a/docs/getting-started/using-openwebui/resources.mdx +++ b/docs/getting-started/using-openwebui/resources.mdx @@ -20,9 +20,9 @@ Visit [Open WebUI](https://openwebui.com/) for official documentation, tools, an ## 🌍 Community Platforms Connect with the Open WebUI community for support, tips, and discussions. -- **Discord**: Join our community on Discord to chat with other users, ask questions, and stay updated. +- **Discord**: Join our community on Discord to chat with other users, ask questions, and stay updated. [Join the Discord Server](https://discord.com/invite/5rJgQTnV4s) -- **Reddit**: Follow the Open WebUI subreddit for announcements, discussions, and user-submitted content. +- **Reddit**: Follow the Open WebUI subreddit for announcements, discussions, and user-submitted content. [Visit Reddit Community](https://www.reddit.com/r/OpenWebUI/) - **GitHub Community**: Participate in discussions, propose feature requests, and report issues specific to the Open WebUI Community Platform website. [Explore the GitHub Community](https://github.com/open-webui/community) From f7c92cb7ae8dfdda2f8e4ff0631ec37fef6544cc Mon Sep 17 00:00:00 2001 From: Matthew Hand Date: Wed, 6 Nov 2024 19:55:53 +0000 Subject: [PATCH 4/5] docs: Add instructions for configuring environment variables in gh-pages and Docusaurus --- docs/tutorials/tips/contributing-tutorial.md | 30 +++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/tips/contributing-tutorial.md b/docs/tutorials/tips/contributing-tutorial.md index 0bca1bc..4ea2432 100644 --- a/docs/tutorials/tips/contributing-tutorial.md +++ b/docs/tutorials/tips/contributing-tutorial.md @@ -25,6 +25,34 @@ We appreciate your interest in contributing tutorials to the Open WebUI document - `BASE_URL` set to `/docs` (or your chosen base URL for the fork). - `SITE_URL` set to `https://.github.io/`. +### πŸ“ Updating the GitHub Pages Workflow and Config File + +If you need to adjust deployment settings to fit your custom setup, here’s what to do: + +a. **Update `.github/workflows/gh-pages.yml`** + - Add environment variables for `BASE_URL` and `SITE_URL` to the build step if necessary: + ```yaml + - name: Build + env: + BASE_URL: ${{ vars.BASE_URL }} + SITE_URL: ${{ vars.SITE_URL }} + run: npm run build + ``` + +b. **Modify `docusaurus.config.ts` to Use Environment Variables** + - Update `docusaurus.config.ts` to use these environment variables, with default values for local or direct deployment: + ```typescript + const config: Config = { + title: "Open WebUI", + tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)", + favicon: "img/favicon.png", + url: process.env.SITE_URL || "https://openwebui.com", + baseUrl: process.env.BASE_URL || "/", + ... + }; + ``` + - This setup ensures consistent deployment behavior for forks and custom setups. + 3. **Enable GitHub Actions** - In your forked repository, navigate to the **Actions** tab. @@ -43,7 +71,7 @@ We appreciate your interest in contributing tutorials to the Open WebUI document 6. **Browse to Your Forked Copy** - - Visit `https://.github.io/docs` to view your forked documentation. + - Visit `https://.github.io/` to view your forked documentation. 7. **Draft Your Changes** From 5c9623dd6fccab65fb2f361f13124247fe6d50ae Mon Sep 17 00:00:00 2001 From: Matthew Hand Date: Wed, 6 Nov 2024 20:06:59 +0000 Subject: [PATCH 5/5] docs: Update contributing tutorial in feature branch --- docs/tutorials/tips/contributing-tutorial.md | 25 ++++++++++---------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/tutorials/tips/contributing-tutorial.md b/docs/tutorials/tips/contributing-tutorial.md index 4ea2432..6c3e200 100644 --- a/docs/tutorials/tips/contributing-tutorial.md +++ b/docs/tutorials/tips/contributing-tutorial.md @@ -18,7 +18,19 @@ We appreciate your interest in contributing tutorials to the Open WebUI document - Navigate to the [Open WebUI Docs Repository](https://github.com/open-webui/docs) on GitHub. - Click the **Fork** button at the top-right corner to create a copy under your GitHub account. -2. **Configure GitHub Environment Variables** +2. **Enable GitHub Actions** + + - In your forked repository, navigate to the **Actions** tab. + - If prompted, enable GitHub Actions by following the on-screen instructions. + +3. **Enable GitHub Pages** + + - Go to **Settings** > **Pages** in your forked repository. + - Under **Source**, select the branch you want to deploy (e.g., `main`) and the folder (e.g.,`/docs`). + - Click **Save** to enable GitHub Pages. + + +4. **Configure GitHub Environment Variables** - In your forked repository, go to **Settings** > **Secrets and variables** > **Actions** > **Variables**. - Add the following environment variables: @@ -53,17 +65,6 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables** ``` - This setup ensures consistent deployment behavior for forks and custom setups. -3. **Enable GitHub Actions** - - - In your forked repository, navigate to the **Actions** tab. - - If prompted, enable GitHub Actions by following the on-screen instructions. - -4. **Enable GitHub Pages** - - - Go to **Settings** > **Pages** in your forked repository. - - Under **Source**, select the branch you want to deploy (e.g., `main`) and the folder (e.g.,`/docs`). - - Click **Save** to enable GitHub Pages. - 5. **Run the `gh-pages` GitHub Workflow** - In the **Actions** tab, locate the `gh-pages` workflow.