Перейти к основному содержимому
warning

Это руководство создано сообществом и не поддерживается командой Open WebUI. Оно предназначено только для демонстрации того, как настроить Open WebUI для ваших конкретных задач. Хотите внести вклад? Ознакомьтесь с руководством по внесению вклада.

Руководства по внесению вклада

Мы ценим ваш интерес в добавлении руководств в документацию Open WebUI. Следуйте приведённым ниже шагам, чтобы настроить вашу среду и отправить своё руководство.

Шаги

  1. Сделайте fork репозитория openwebui/docs на GitHub

    • Перейдите в репозиторий Open WebUI Docs на GitHub.
    • Нажмите кнопку Fork в правом верхнем углу, чтобы создать копию в вашей учетной записи GitHub.
  2. Активируйте GitHub Actions

    • В вашем форкнутом репозитории перейдите на вкладку Actions.
    • Если будет предложено, включите GitHub Actions, следуя инструкциям на экране.
  3. Включите GitHub Pages

    • В вашем форкнутом репозитории перейдите в Settings > Pages.
    • В разделе Source выберите ветку, которую хотите развернуть (например, main), и папку (например, /docs).
    • Нажмите Save, чтобы включить GitHub Pages.
  4. Настройте переменные окружения GitHub

    • В вашем форкнутом репозитории перейдите в Settings > Secrets and variables > Actions > Variables.
    • Добавьте следующие переменные окружения:
      • BASE_URL должно быть установлено в /docs (или вашу выбранную базу URL для форка).
      • SITE_URL должно быть установлено в https://<ваше-имя-на-github>.github.io/.

📝 Обновление GitHub Pages Workflow и файла конфигурации

Если вам нужно настроить параметры развертывания под вашу конфигурацию, выполните следующее:

a. Обновите .github/workflows/gh-pages.yml

  • При необходимости добавьте переменные окружения BASE_URL и SITE_URL в шаг сборки:

      - name: Сборка
    env:
    BASE_URL: ${{ vars.BASE_URL }}
    SITE_URL: ${{ vars.SITE_URL }}
    run: npm run build

b. Измените docusaurus.config.ts для использования переменных окружения

  • Обновите docusaurus.config.ts для использования этих переменных окружения с дефолтными значениями для локального или прямого развертывания:

    const config: Config = {
    title: "Open WebUI",
    tagline: "ChatGPT-Style WebUI для LLMs (Ранее Ollama WebUI)",
    favicon: "images/favicon.png",
    url: process.env.SITE_URL || "https://openwebui.com",
    baseUrl: process.env.BASE_URL || "/",
    ...
    };
  • Эта настройка гарантирует согласованное поведение развертывания для форков и пользовательских настроек.

  1. Запустите GitHub Workflow gh-pages

    • На вкладке Actions найдите Workflow gh-pages.
    • Запустите Workflow вручную, если это необходимо, или он может автоматически запуститься в зависимости от вашей настройки.
  2. Перейдите на свой форк

    • Посетите https://<ваше-имя-на-github>.github.io/<BASE_URL>, чтобы просмотреть вашу форкнутую документацию.
  3. Создайте свои изменения

    • В вашем форкнутом репозитории перейдите в соответствующую директорию (например, docs/tutorial/).
    • Создайте новый markdown-файл для вашего руководства или отредактируйте существующие.
    • Убедитесь, что в вашем руководстве включён баннер предупреждения о неподдерживаемости.
  4. Отправьте Pull Request

    • Когда ваше руководство будет готово, зафиксируйте изменения в вашем форке.
    • Перейдите в оригинальный репозиторий open-webui/docs.
    • Нажмите New Pull Request и выберите ваш форк и ветку в качестве источника.
    • Укажите описательное название и описание для своего PR.
    • Отправьте pull request на рассмотрение.

Важно

Руководства, созданные сообществом, должны включать следующее:

:::warning
Это руководство создано сообществом и не поддерживается командой Open WebUI. Оно предназначено только для демонстрации того, как настроить Open WebUI для ваших конкретных задач. Хотите внести вклад? Ознакомьтесь с руководством по внесению вклада.
:::

Как тестировать Docusaurus локально

Вы можете протестировать ваш сайт на Docusaurus локально, используя следующие команды:

npm install   # Установить зависимости
npm run build # Собрать сайт для продакшн

Это поможет вам обнаружить любые проблемы перед развертыванием.