github-starred/ollama
2
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2026-05-06 16:11:34 -05:00
Code Issues 14.5k Packages Projects Releases 120 Wiki Activity

[GH-ISSUE #10370] Cannot find hosted documentation #6814

New Issue
Open
opened 2026-04-12 18:36:19 -05:00 by GiteaMirror · 11 comments
GiteaMirror commented 2026-04-12 18:36:19 -05:00
Owner
Copy Link

Originally created by @jonas-eschle on GitHub (Apr 22, 2025).
Original GitHub issue: https://github.com/ollama/ollama/issues/10370

What is the issue?

Hi and thanks a lot for this repo, no need to say how useful this is!

However, I seem to struggle with a very basic thing: where is the documentation hosted? I found some docs, sure, but I did not find any relevant hosted docs. The ollama website seems to be quite bare-bones.

The example is to know how to properly set environment variables. Where can this information be found except of the github repository files in the docs folder? I.e. on the ollama website?

Relevant log output

OS

No response

GPU

No response

CPU

No response

Ollama version

No response

Originally created by @jonas-eschle on GitHub (Apr 22, 2025). Original GitHub issue: https://github.com/ollama/ollama/issues/10370 ### What is the issue? Hi and thanks a lot for this repo, no need to say how useful this is! However, I seem to struggle with a very basic thing: where is the documentation hosted? I found some docs, sure, but I did not find any relevant hosted docs. The ollama website seems to be quite bare-bones. The example is to know how to properly set environment variables. Where can this information be found _except_ of the github repository files in the docs folder? I.e. on the ollama website? ### Relevant log output ```shell ``` ### OS _No response_ ### GPU _No response_ ### CPU _No response_ ### Ollama version _No response_
GiteaMirror added the documentationquestionollama.com labels 2026-04-12 18:36:20 -05:00
GiteaMirror commented 2026-04-12 18:36:22 -05:00
Author
Owner
Copy Link

@rick-github commented on GitHub (Apr 22, 2025):

The Docs link on the ollama.com main page (bottom right) links to the github docs. That's the source of truth for documentation.

Setting environment variables is covered here.

<!-- gh-comment-id:2821176494 --> @rick-github commented on GitHub (Apr 22, 2025): The Docs link on the ollama.com main page (bottom right) links to the github docs. That's the source of truth for documentation. Setting environment variables is covered [here](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server).
GiteaMirror commented 2026-04-12 18:36:25 -05:00
Author
Owner
Copy Link

@jonas-eschle commented on GitHub (Apr 22, 2025):

Thanks! I clearly would have not found that without the help.

Okay, that is of course a design decision, but I would strongly suggest to make this bigger somewhere? I think I don't know of any other docs that are designed this way?
Also, are there plans to simply autogenerate html files and have them hosted together with the website?

(I find myself maybe a bit lost asking such a project such trivial things, so maybe I am completely missing something in the design here?)

<!-- gh-comment-id:2821194321 --> @jonas-eschle commented on GitHub (Apr 22, 2025): Thanks! I clearly would have not found that without the help. Okay, that is of course a design decision, but I would strongly suggest to make this bigger somewhere? I think I don't know of any other docs that are designed this way? Also, are there plans to simply autogenerate html files and have them hosted together with the website? (I find myself maybe a bit lost asking such a project such trivial things, so maybe I am completely missing something in the design here?)
GiteaMirror commented 2026-04-12 18:36:26 -05:00
Author
Owner
Copy Link

@rick-github commented on GitHub (Apr 22, 2025):

Most ollama users and developers are a bit techy and it's more fun to write code than documentation, so the docs are pretty bare-boned and not terribly neophyte-friendly. There are plenty of tutorials available on the web to help those starting out, Matt Williams (ollama alumni) has a video series here. As the project matures I expect the documentation will improve, but in the meantime feel free to post questions here or in the discord.

<!-- gh-comment-id:2821231469 --> @rick-github commented on GitHub (Apr 22, 2025): Most ollama users and developers are a bit techy and it's more fun to write code than documentation, so the docs are pretty bare-boned and not terribly neophyte-friendly. There are plenty of tutorials available on the web to help those starting out, Matt Williams (ollama alumni) has a video series [here](https://www.youtube.com/playlist?list=PLvsHpqLkpw0fIT-WbjY-xBRxTftjwiTLB). As the project matures I expect the documentation will improve, but in the meantime feel free to post questions here or in the [discord](https://discord.com/invite/ollama).
GiteaMirror commented 2026-04-12 18:36:28 -05:00
Author
Owner
Copy Link

@jonas-eschle commented on GitHub (Apr 22, 2025):

@rick-github many thanks, I may have misjudged! As the project is quite popular (138K stars!) and seems to work very well, I was expecting something different .

The issue with tutorials and docs is not great I think. For example googling will result first in many wrong pages that will suggest to set an enviromnent variable. There is even a thread where people use stufff like softlinks (https://github.com/ollama/ollama/issues/680). So I would disagree, I find it very hard to find basic things for ollama (including the docs. Google doesn't find them for example).

That being said, I fully understand that not everything can be up and running, this needs time and polish! I would suggest then to actually have an open issue (this?) to add proper documentation that is indexed by search engines etc.?

<!-- gh-comment-id:2821299973 --> @jonas-eschle commented on GitHub (Apr 22, 2025): @rick-github many thanks, I may have misjudged! As the project is quite popular (138K stars!) and seems to work very well, I was expecting something different . The issue with tutorials and docs is not great I think. For example googling will result first in many wrong pages that will suggest to set an enviromnent variable. There is even a thread where people use stufff like softlinks (https://github.com/ollama/ollama/issues/680). So I would disagree, I find it very hard to find basic things for ollama (including the docs. Google doesn't find them for example). That being said, I fully understand that not everything can be up and running, this needs time and polish! I would suggest then to actually have an open issue (this?) to add proper documentation that is indexed by search engines etc.?
GiteaMirror commented 2026-04-12 18:36:29 -05:00
Author
Owner
Copy Link

@rick-github commented on GitHub (Apr 22, 2025):

When I ask google "how do i set environment variables in ollama?" the first response is a link to the ollama FAQ and the snippet shows the relevant portion. Ditto for brave, bing and perplexity, so it would seem it's already indexed by search engines. I'm not sure if an explicit issue is required for improving documentation, I think it will improve organically. I myself have a couple of PRs pending for dealing with FAQs that occur here and on the discord.

<!-- gh-comment-id:2821345003 --> @rick-github commented on GitHub (Apr 22, 2025): When I ask google "how do i set environment variables in ollama?" the first response is a link to the ollama FAQ and the snippet shows the relevant portion. Ditto for brave, bing and perplexity, so it would seem it's already indexed by search engines. I'm not sure if an explicit issue is required for improving documentation, I think it will improve organically. I myself have a couple of PRs pending for dealing with FAQs that occur here and on the discord.
GiteaMirror commented 2026-04-12 18:36:31 -05:00
Author
Owner
Copy Link

@jonas-eschle commented on GitHub (Apr 22, 2025):

Well, "how do i set environment variables in ollama" isn't the question. The question is how to change the model directory. If you google "ollama change model directory" for example, I don't land there.

And there is also no way to search the docs page since it is not hosted on the docs page, that's what many hosted docs offer.

I would still say that it is a very subpar experience overall, and projects with a few 100 stars have often better accessible docs (I take that this is partially a subjective opinion).

Gradually is fine, but I would vote for a nice documentation as can be found in basically any other project of this size/popularity (this maybe comes of more negative than intedned, but are you aware of any other project without searchable, nice docs?)

I am thinking of using RTD, there's also all the versioning and the cutting edge. It's searchable and all.
MD Spinx plugin and this should be up in a day (*), and a proper link to the (slightly too) minimalistic ollama website?

*we know what "a day means"

<!-- gh-comment-id:2821406720 --> @jonas-eschle commented on GitHub (Apr 22, 2025): Well, "how do i set environment variables in ollama" isn't the question. The question is how to change the model directory. If you google "ollama change model directory" for example, I don't land there. And there is also no way to search the docs page since it is not hosted on the docs page, that's what many hosted docs offer. I would still say that it is a very subpar experience overall, and projects with a few 100 stars have often better accessible docs (I take that this is partially a subjective opinion). Gradually is fine, but I would vote for a nice documentation as can be found in basically any other project of this size/popularity (this maybe comes of more negative than intedned, but are you aware of _any_ other project without searchable, nice docs?) I am thinking of using RTD, there's also all the versioning _and_ the cutting edge. It's searchable and all. MD Spinx plugin and this should be up in a day (*), and a proper link to the (slightly _too_) minimalistic ollama website? *we know what "a day means"
GiteaMirror commented 2026-04-12 18:36:31 -05:00
Author
Owner
Copy Link

@rick-github commented on GitHub (Apr 22, 2025):

If you google "ollama change model directory" for example, I don't land there.

You are correct that this search does not link to the ollama docs, but the responses on the results page supplies the requested information.

And there is also no way to search the docs page since it is not hosted on the docs page, that's what many hosted docs offer.

github has a search bar, "/" is the keyboard shortcut.

I am thinking of using RTD, there's also all the versioning and the cutting edge. It's searchable and all.

Feel free to submit a PR, it's a community project after all.

<!-- gh-comment-id:2821454381 --> @rick-github commented on GitHub (Apr 22, 2025): > If you google "ollama change model directory" for example, I don't land there. You are correct that this search does not link to the ollama docs, but the responses on the results page supplies the requested information. > And there is also no way to search the docs page since it is not hosted on the docs page, that's what many hosted docs offer. github has a search bar, "/" is the keyboard shortcut. > I am thinking of using RTD, there's also all the versioning and the cutting edge. It's searchable and all. Feel free to submit a PR, it's a community project after all.
GiteaMirror commented 2026-04-12 18:36:33 -05:00
Author
Owner
Copy Link

@jonas-eschle commented on GitHub (Apr 22, 2025):

... but the responses on the results page supplies the requested information.

I think it does not work as it suggests, as export OLLAMA_MODELS="/path/to/models" (the Linux explanation) does not work but instead the ollama.service file needs to be edited (as described in the FAQ). Don't wanna bloat this up, but wanted to highlight this as an issue.

github has a search bar, "/" is the keyboard shortcut.

Feel free to submit a PR, it's a community project after all.

Gladly, that was my intention, I didn't formulate this properly. Basically asking if this aligns with your idea/the spirit of the project. So this seems like a decent idea? I'll just go ahead and set something up, thanks!

<!-- gh-comment-id:2821478182 --> @jonas-eschle commented on GitHub (Apr 22, 2025): > ... but the responses on the results page supplies the requested information. I think it does not work as it suggests, as `export OLLAMA_MODELS="/path/to/models"` (the Linux explanation) does not work but instead the ollama.service file needs to be edited (as described in the FAQ). Don't wanna bloat this up, but wanted to highlight this as an issue. > github has a search bar, "/" is the keyboard shortcut. > Feel free to submit a PR, it's a community project after all. Gladly, that was my intention, I didn't formulate this properly. Basically asking if this aligns with your idea/the spirit of the project. So this seems like a decent idea? I'll just go ahead and set something up, thanks!
GiteaMirror commented 2026-04-12 18:36:33 -05:00
Author
Owner
Copy Link

@rick-github commented on GitHub (Apr 22, 2025):

export OLLAMA_MODELS="/path/to/models" (the Linux explanation)

This is a valid response when the server is being run from the command line. When running as a service, editing the service file is required.

<!-- gh-comment-id:2821494420 --> @rick-github commented on GitHub (Apr 22, 2025): > export OLLAMA_MODELS="/path/to/models" (the Linux explanation) This is a valid response when the server is being run from the command line. When running as a service, editing the service file is required.
GiteaMirror commented 2026-04-12 18:36:34 -05:00
Author
Owner
Copy Link

@jonas-eschle commented on GitHub (Apr 22, 2025):

Yes, fair. But this is where it starts: it's hard to find the docs to even understand the problem, because their perfectly hidden on the landing page and not at all on the README (some link to it, but no "documentation". So it's unclear on how to actually start. What are the options etc. But then we're back to the initial issue, so I'll try to get a PR up in the comming days

<!-- gh-comment-id:2821526090 --> @jonas-eschle commented on GitHub (Apr 22, 2025): Yes, fair. But this is where it starts: it's hard to find the docs to even understand the problem, because their perfectly hidden on the landing page and not at all on the README (some link to it, but no "documentation". So it's unclear on how to actually start. What are the options etc. But then we're back to the initial issue, so I'll try to get a PR up in the comming days
GiteaMirror commented 2026-04-12 18:36:34 -05:00
Author
Owner
Copy Link

@jonas-eschle commented on GitHub (May 16, 2025):

@rick-github getting more specific, opened a PR at #10732 , maybe you have opinions

<!-- gh-comment-id:2886621684 --> @jonas-eschle commented on GitHub (May 16, 2025): @rick-github getting more specific, opened a PR at #10732 , maybe you have opinions
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
amd
api
app
bug
build
cli
cloud
compatibility
context-length
create
docker
documentation
embeddings
feature request
feedback wanted
good first issue
gpt-oss
gpu
harmony
help wanted
image
install
intel
js
launch
linux
macos
memory
mlx
model
needs more info
networking
nvidia
ollama.com
performance
pull-request
Mirrored from GitHub Pull Request
 python
question
registry
rendering
thinking
tools
top
vulkan
windows
wsl
No Label documentation ollama.com question
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#6814
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?