-
-
Notifications
You must be signed in to change notification settings - Fork 528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Request self hosted improvement documentation #1524
Comments
Could you let me know a bit more about what you find unclear please? It would help if you shared your level of experience, and what sort of self-hosting you've done + are comfortable with |
Yeah, I think if a user is working through the documentation, and ends up on the docker page (https://atuin.sh/docs/self-hosting/docker) before the actual self-hosting page (https://atuin.sh/docs/self-hosting/) they can get ahead of themselves and start trying to create docker containers before the server.toml file actually exists anywhere. It could maybe do with a call to action to make sure you've looked at the first page first? That page makes the assumption the user is running atuin itself on the sync server, so has a ~/.config/atuin/ directory created. In the case that the user decided they don't want atuin on their sync server, a user may need prompting to create that directory? I also found that the docker container needed to be started with: docker run -p 8888:8888 -d -v "$HOME/.config/atuin:/config" ghcr.io/atuinsh/atuin:latest server start To actually expose port 8888. |
I confess, for me is a little bit confuse this part on a self hosted but im continue trying I think can be explore and descript little more the params from self hosted to people curious like me (: |
The server.toml file is never mentioned on the Docker page. Was a bit of jumping back and forth to figure out, what is needed where to get it up and running... |
Hello folks. Im see the documentation has improved, and i have few questions: when - ATUIN_HOST: "0.0.0.0" means the port atuin will listen or needs change 0.0.0.0 to a hosted server ip address? |
It means that Atuin will listen on all interfaces. Please don't put your servers IP address here. ATUIN_PORT specifies the port. You may wish to read up on network interfaces and CIDR ranges - this isn't at all specific to Atuin. |
tldr is that 127.0.0.1 would specify listening on only the local network interface, whereas 0.0.0.0 is a way of writing "listen on all". atuin would not be accessible over the network if you set 127.0.0.1, whereas it will be with 0.0.0.0. |
Sometimes i wanted to host my self atuin on my ARM and i have read the documentation but is not full cleary for me.
I want on this issue a suggest to improvement a documentation explain with more details for more people.
The text was updated successfully, but these errors were encountered: