Skip to content
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

Closed
mateuscomh opened this issue Jan 8, 2024 · 8 comments
Closed

Request self hosted improvement documentation #1524

mateuscomh opened this issue Jan 8, 2024 · 8 comments

Comments

@mateuscomh
Copy link
Contributor

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.

@mateuscomh mateuscomh changed the title Request self hosted doc Request self hosted improvement documentation Jan 8, 2024
@ellie
Copy link
Member

ellie commented Jan 8, 2024

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

@mateuscomh
Copy link
Contributor Author

Im trying using with a docker-compose, on armbian 64 bits.
The atuin image and postgresql goes up but some erros i have on container
This is a first error i have when i copy from the doc.
2024-01-08_20-51

@solarisfire
Copy link

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.

@mateuscomh
Copy link
Contributor Author

I confess, for me is a little bit confuse this part on a self hosted but im continue trying
Late im will try to retake in a order propose.

I think can be explore and descript little more the params from self hosted to people curious like me (:

@ascheucher
Copy link

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...

@mateuscomh
Copy link
Contributor Author

Hello folks.

Im see the documentation has improved, and i have few questions:

when
Self hosted or docker that line:

- 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?
Thats not clear for me

@ellie
Copy link
Member

ellie commented Mar 1, 2024

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.

@ellie ellie closed this as not planned Won't fix, can't repro, duplicate, stale Mar 1, 2024
@ellie
Copy link
Member

ellie commented Mar 1, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants