mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00

Go to file

Silentoplayz 1bf3f137ec Squashed commit of the following:

commit af900c8803
Author: Silentoplayz <50341825+Silentoplayz@users.noreply.github.com>
Date:   Thu Dec 26 14:56:03 2024 -0500

    Update env-configuration.md

    update for v0.4.8 list of env vars

commit 622cd3d6cb
Merge: ce3429a 41f918c
Author: Timothy Jaeryang Baek <tim@openwebui.com>
Date:   Wed Dec 25 13:31:27 2024 -0800

    Merge pull request #339 from jtslear/main

    Details model default for ComfyUI

commit ce3429a907
Author: Timothy Jaeryang Baek <tim@openwebui.com>
Date:   Tue Dec 24 20:37:54 2024 -0700

    refac

commit 7c221579ad
Author: Timothy Jaeryang Baek <tim@openwebui.com>
Date:   Mon Dec 23 13:06:36 2024 -0700

    refac

commit 41f918c408
Author: John T Skarbek <jtslear@users.noreply.github.com>
Date:   Mon Dec 23 08:45:24 2024 -0500

    Details model default for ComfyUI

    Adds concise detail for the Set Default Model option in the Image configuration pane for ComfyUI

commit 6b2523cf35
Author: Timothy Jaeryang Baek <tim@openwebui.com>
Date:   Mon Dec 23 01:59:26 2024 -0700

    Update roadmap.mdx

commit 15df6c51c1
Author: Timothy Jaeryang Baek <tim@openwebui.com>
Date:   Sun Dec 22 16:58:14 2024 -0700

    refac

commit dbe6a7261d
Merge: 13aec58 142e75b
Author: silentoplayz <50341825+silentoplayz@users.noreply.github.com>
Date:   Sat Dec 21 20:43:20 2024 -0500

    Merge pull request #337 from silentoplayz/main

    Updated DockerUpdating.md page

commit 13aec580d3
Author: Timothy Jaeryang Baek <tim@openwebui.com>
Date:   Sat Dec 21 18:21:30 2024 -0700

    Update roadmap.mdx

commit b286d6cb42
Merge: 6d8b6d9 0bdca8c
Author: silentoplayz <50341825+silentoplayz@users.noreply.github.com>
Date:   Sat Dec 21 12:53:14 2024 -0500

    Merge pull request #336 from silentoplayz/main

    New Apache Tika & Artifacts Docs Pages

commit 6d8b6d97ca
Merge: a2bc93d 1c83f95
Author: silentoplayz <50341825+silentoplayz@users.noreply.github.com>
Date:   Sat Dec 21 10:45:40 2024 -0500

    Merge pull request #335 from silentoplayz/main

    New "Redis Websockets" Docs Page

commit a2bc93d074
Merge: 283df1a 62c4ca3
Author: silentoplayz <50341825+silentoplayz@users.noreply.github.com>
Date:   Fri Dec 20 17:49:40 2024 -0500

    Merge pull request #330 from xiaowuap/patch-1

    Add BingAPI in web_search.md

commit 62c4ca375f
Author: Enzo Wu <xiaowuap@outlook.com>
Date:   Sat Dec 21 01:09:45 2024 +0800

    Add BingAPI in web_search.md

    First time to contribute~

2024-12-26 14:57:54 -05:00

.github/workflows

chore: reset gh-pages.yml and docusaurus.config.ts to match upstream main

2024-11-07 20:51:46 +00:00

blog

Add truncate to fix Docusaurus warning

2024-09-26 01:52:25 +02:00

docs

Squashed commit of the following:

2024-12-26 14:57:54 -05:00

scripts

Update scan-missing-env-vars.py

2024-12-26 13:54:20 -05:00

src

Apply stylelint fixes

2024-09-26 01:53:26 +02:00

static

doc: Folder and Tag

2024-11-06 23:28:56 -08:00

.gitignore

init

2024-02-19 21:02:13 -08:00

.node-version

Use node-version file to set the version once

2024-09-26 02:01:49 +02:00

.prettierignore

chore: consistent formatting using prettier

2024-06-16 21:32:12 +01:00

.prettierrc.mjs

Switch to ts and ESM configs

2024-09-26 01:51:00 +02:00

.stylelintrc.json

Add stylelint config

2024-09-26 01:53:07 +02:00

babel.config.mjs

Switch to ts and ESM configs

2024-09-26 01:51:00 +02:00

docusaurus.config.ts

chore: reset gh-pages.yml and docusaurus.config.ts to match upstream main

2024-11-07 20:51:46 +00:00

eslint.config.mjs

Add eslint flat config

2024-09-26 01:53:16 +02:00

package-lock.json

Bump dependancies and install lint and format packages

2024-09-26 01:47:47 +02:00

package.json

Bump dependancies and install lint and format packages

2024-09-26 01:47:47 +02:00

postcss.config.js

chore: consistent formatting using prettier

2024-06-16 21:32:12 +01:00

README.md

use npm ci instead of npm i.

2024-07-27 09:25:54 +00:00

sidebars.ts

Fixed docs layout

2024-07-20 11:33:23 -06:00

tailwind.config.ts

Switch to ts and ESM configs

2024-09-26 01:51:00 +02:00

tsconfig.json

Run prettier

2024-09-26 01:51:58 +02:00

README.md

Website

This website is built using Docusaurus, a modern static website generator.

Installation

npm ci

Local Development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true npm run deploy

Not using SSH:

GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.