mirror of
https://github.com/open-webui/docs.git
synced 2026-08-24 06:23:58 -04:00
help wanted: better doc (idiot-proof level) #2
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @tjbck on GitHub (Jan 9, 2024).
Hi guys! I've been noticing some people struggling with installation/update process for ollama-webui and I feel like it would be extremely helpful for a lot of people if we could have a more thorough documentation!
Unfortunately, I won't have much time this week and If anyone can get the ball rolling for this (so that I can focus on adding more features), It'll be greatly appreciated. Thanks in advance, guys!
@justinh-rahb commented on GitHub (Jan 9, 2024):
@tjbck I think I can help here, I'll have a look at the docker instructions specifically first.
open-webui/open-webui#436 should help people unfamiliar with using Docker.
@oliverbob commented on GitHub (Jan 10, 2024):
I really love this bro @tjbck. And hey, I thank you for all the features in the RAG and full user/admin support that you implemented from my suggestions. You are an amazing, hardworking developer. Will be clicking that sponsor button very, very soon.
I wish we're just one block away from each other so we can better collaborate.
@oliverbob commented on GitHub (Jan 10, 2024):
Why not make me a contributor so I can work on the docs then, work with other devs to work on it too, since your PR is rising like wild fire.
@svenoaks commented on GitHub (Jan 10, 2024):
Idiot here, can someone help me update the docker container? I've got the container with webui only. If I delete the container, then install with the same listed command, it seems I get the same old version (v1.0.0-alpha.40).
I truly tried to search the issues for instructions, but can't find any
@justinh-rahb commented on GitHub (Jan 10, 2024):
Apologies, I am working on an updating doc as I type but it need polish and review. For now, please try:
I think you probably were missing the docker pull step to get the latest image. Hope this helps you out, and I'll get back to work on documenting it properly 👍
@svenoaks commented on GitHub (Jan 10, 2024):
@justinh-rahb Thank you! it worked, I did have to use
docker pull ghcr.io/ollama-webui/ollama-webui:mainto pull it@justinh-rahb commented on GitHub (Jan 10, 2024):
Quite right, I forgot the container registry, my bad. Glad you've got it sorted!
@jukofyork commented on GitHub (Jan 11, 2024):
Yeah, I'm pretty tech savy and I struggled badly with this too:
Eventually after stopping, removing and reloading a few times, I thought the rag stuff much be on a different branch so tried changing :main to :rag, etc after seeing those were Github tags.
After none of that worked I eventually went to the URL in the docker command hoping to find the right tag but somehow it went to a Web page that looked like the github and I managed to download something from there that was quite a few 100mb so I knew something was different.
I've literally no idea how I did it or if I could do it again, and still don't understand why stop+rm of the Docker command didn't seem to work?
EDIT: I see the pull command is what I needed! I was just doing stop, rm and then run. doh!
@justinh-rahb commented on GitHub (Jan 11, 2024):
Hello @jukofyork I've had to close and reopen the tab I've opened Ollama-WebUI in, and sometimes disable cache to force a complete refresh even after pulling a new image and restarting the container, F5/Cmd+R isn't always enough.
@tjbck commented on GitHub (Jan 16, 2024):
I've been super busy writing a research paper the last couple of days, but I should have more time to work new features for the project starting from tomorrow! @justinh-rahb Thanks a lot for helping, Your efforts haven't gone unnoticed!
@turnercore commented on GitHub (Jan 16, 2024):
This is a docs question related to the new RAG implementation
@tjbck commented on GitHub (Jan 16, 2024):
For everyone's information, One thing I want to emphasize is that people seem to forget that this is a community driven project, which means everyone is dedicating their free time and working on this project alongside their full-time job. So if you guys think the project could use better documentation, I actively encourage to make a PR, be the change you want to see in the world!
@justinh-rahb commented on GitHub (Jan 16, 2024):
@tjbck we thank you for your dedication and commitment to making this the best interface for Ollama, I'll continue to show my appreciation for your work by trying to tackle as many issues for you as I can confidently answer. Keep up the great work you're doing! 🚀
@oliverbob commented on GitHub (Jan 17, 2024):
Noted @tjbck. Glad to hear.
@mafrasiabi commented on GitHub (Jan 18, 2024):
I have trouble using litellm and create a config file that works with webui, @justinh-rahb could you please add the config file in docs and add a docker compose file too. I think all of us can benefit from this.
@iplayfast commented on GitHub (Jan 19, 2024):
After spending an hour trying to get a simple web ui up and running, I'd say get rid of docker, it's a huge stumbling block, to a web interface. It's like having to install an OS in order to run a program. Total overkill.
@0xb15d3 commented on GitHub (Jan 19, 2024):
Docker is a life saver for me, especially now that the webui has other backend components. I don't know what the guy above me is talking about.
@justinh-rahb commented on GitHub (Jan 19, 2024):
@iplayfast if you are having trouble setting up Ollama WebUI with Docker, I want to make it clear that switching to a non-Docker setup will not necessarily make the process any easier. The underlying complexity of setting up and configuring a complex web application such as this remains the same, regardless of whether you use Docker or not.
While it may be tempting to look for an easier solution, such as switching to a non-Docker setup, I believe that this will ultimately be more time-consuming and frustrating in the long run.
That all being said, native-installers for various platforms are under consideration (#470), but are not as high-priority as features right now.
@oliverbob commented on GitHub (Jan 20, 2024):
@iplayfast What exactly do yo experience causing you to believe its an overkill? Are you suggesting a branch or fork without the use of docker? What do you have in mind?
@jukofyork commented on GitHub (Feb 3, 2024):
I think one thing that could be improved is an explanation of the steps needed to get the frontend to reflect the changes after an update.
I wrote down all the steps needed to do an update in a text file and even when I followed these again it took a while for the frontend to actually show it had updated and everything (including the version number) stayed the same.
@stephenhouser commented on GitHub (Feb 8, 2024):
I'm putting this in the "better doc" issue, though it may belong elsewhere. I would not rate it as a newbie issue, I've been using Unix/Linux for many years.
This option specification:
--webui[port=PORT] Set the port for the web user interface.being translated to a command line like:
./run-compose.sh --webui[port=1234]Is completely non-standard. In almost every case brackets
[]mean an optional argument/parameter and you are not supposed to actually have to type them in. Having to look at the source code to sort it out is not friendly.@tjbck commented on GitHub (Feb 8, 2024):
@stephenhouser I agree, someone should make a PR to change the behaviour of the
./run-compose.shfile.@jonasbg commented on GitHub (Feb 10, 2024):
If you think docker is complicated then I promise you a regular installation is far more complicated and much further from making an installation that works with everyone.
Btw, stating that docker is like installing an OS is only true for those running windows, docker is not a VM. You do not install another OS when running things in a docker container. Every process is executed and owned by the host system.
This project is one of the easiest I've got up and running. They got everything right. Focused on docker and sqlite makes it a breeze to install. No complicated dependencies and feature creeping such as mongodb, redis etc.
I've now installed it locally on three machines and deployed it to my local kubernetes.
I don't think you understand the implications of your request, both for the devs but also for the users.
@jukofyork commented on GitHub (Feb 25, 2024):
I still can't seem to get this to update:
(I actually use a different
OLLAMA_API_BASE_URLbecause I'm also serving the Ollama API)It appears to be doing lots of "stuff" like downloading and unzipping files (unlike when I was just doing
docker runand it did nothing), but actually getting it to update seems to be completely random - I followed these exact same steps last time to get it tov1.0.0-alpha.100...I should point out I have a degree in CompSci and have been using Unix for 30 years - if I can't get this to update, what hope is there for other people!?
This absolutely needs some completely foolproof documentation on how to update it or else 90% of the likely audience are going to be turned off. IMO the problem isn't using Docker itself; there are plenty of people who happily install/use lots of Linux tools without understanding the steps they are following - it's simply that there are no proper instructions...
@jukofyork commented on GitHub (Feb 25, 2024):
Managed to get it to update by looking through the packages and found the name had been changed:
but you probably don't want to do it this way as it seems to clear the settings and reset the admin login...
I assume this will keep the new
open-webuiup-to-date (so long as the name doesn't change again):@justinh-rahb commented on GitHub (Feb 25, 2024):
@jukofyork https://docs.openwebui.com/migration
@jukofyork commented on GitHub (Feb 25, 2024):
Thanks - I should have realized the name had changed! :)
@jukofyork commented on GitHub (Feb 25, 2024):
LOL, it's turned back into:
???
It definitely was "Open Web Ui" earlier today as I noticed the option to turn off the suggested prompts, but for some unknown reason I'm now back to this 😕
@jukofyork commented on GitHub (Feb 25, 2024):
Running the steps in the bash script I posted above has now gone back to:
but why did it revert itself?
I definitely deleted the old docker image and can confirm
docker psshows this:I've literally done nothing to the machine and yet it somehow reverted to the old version on its own???
@jukofyork commented on GitHub (Feb 25, 2024):
Yeah, I'm beyond confused now:
I'm beginning to side with the "Docker isn't a good idea" argument now as stuff like this just makes absolutely no sense...
@tjbck commented on GitHub (Feb 25, 2024):
@jukofyork it might just be a browser cache issue :)
@jukofyork commented on GitHub (Feb 25, 2024):
Yeah, but how can it be fully functional and let me use it? Surely if I've deleted the Docker image it should break as soon as I try to use something that needs to write to the backend?
Also earlier today I used the exact same Firefox instance on the same machine to log in and was definitely using the new version, then several hours later the same Firefox instance on the same machine was clearly showing the old version (as was the ssh tunnel)?
@justinh-rahb commented on GitHub (Feb 25, 2024):
You don't need Docker to mysteriously end up with multiple dueling installations of Ollama or Open WebUI, we've also seen people manage to do this without even touching Docker... 🙄
@jukofyork commented on GitHub (Feb 25, 2024):
Yeah, it definitely is some weird caching issue as I just uploaded a document on what appears to be Ollama WebUI and it also shows up on the Open WebUI instance.
I still don't understand how a caching issue can revert to the old version from the same browser instance though?
@jukofyork commented on GitHub (Feb 25, 2024):
Well I did spend 3 days trying to compile Ollama only to find the service the old version was creating was starting up the old version of the binary it had hidden away somewhere lol.
@jukofyork commented on GitHub (Feb 25, 2024):
Well have cleared both browser caches and they both showing the new version again. Fingers crossed I don't wake up to "Ollama Web UI Version v1.0.0-alpha.100" 😁
@oliverbob commented on GitHub (Mar 1, 2024):
Can you reinstall ollama and the webui from scratch? Lets see how it works.
@oliverbob commented on GitHub (Mar 3, 2024):
Looks like
docker build -t open-webui .needs to come back in our docs for first time visitors. I'm essentially working with lots of schools these days, and I'm guiding them through ways to install OI. Can someone restore it from the main installation guide? Do you have time for it justinh-rahb or is it possible?Thanks.
@bozo32 commented on GitHub (Mar 29, 2024):
I volunteer to be an idiot.
I work on OS X (home machine), Linux (without root access, I ssh in, it is a stand alone PC with a titan 12gb gpu) and a HPC that runs scientific linux (some redhat variant) (no docker...uses singularity, have to declare which/how many GPUs I'm using each session, have to close out GPUs after each session to stop billing, it has a bunch of NVIDIA and AMD GPUs. It uses slurm)
Installation on my Mac is trivial
installation on the ssh accessed linux box with cloud flared was a trick
I used a docker setup that I pieced together by reading this docker compose file: https://github.com/jgarland79/ollama-webui-docker
the only problem is that calls from open-webui to ollama containers didn't use ollama/ollama...I had to use the hard internal IP
I have not figured out how to set it up on the cluster in a way that would not be a total pain...every time I initiate a session I have to
@westbrook-ai commented on GitHub (Aug 18, 2024):
These docs feel pretty idiot-proof now: https://docs.openwebui.com/getting-started/
Gonna close this since no one has commented in four months, anyone can re-open if they disagree.