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

improve docker docs #315

Merged
merged 3 commits into from
Mar 15, 2024
Merged

Conversation

AgustinRamiroDiaz
Copy link
Contributor

fixes surrealdb/surrealdb#3468

Why

Docker file permissions are hard to understand, and cause trouble for newcomers. This PR adds an extra step to reduce the likelihood of errors for users.

Context

There's more context in the issue

Notes

I'm not a professional documentation creator, modify as you please

Signed-off-by: Agustín Ramiro Díaz <agustin.ramiro.diaz@gmail.com>
Copy link

netlify bot commented Feb 10, 2024

Deploy Preview for surrealdb-docs ready!

Name Link
🔨 Latest commit 057e1ed
🔍 Latest deploy log https://app.netlify.com/sites/surrealdb-docs/deploys/65f45c2f849c8a00087e7840
😎 Deploy Preview https://deploy-preview-315--surrealdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sgirones
Copy link
Member

thanks for the PR @AgustinRamiroDiaz.

I would suggest using the -dev Docker image tags instead, which run as root by default (i.e. surrealdb/surrealdb:latest-dev)

That way there's no need to change the file ownership

@Ekwuno
Copy link
Contributor

Ekwuno commented Feb 12, 2024

thanks for the PR @AgustinRamiroDiaz.

I would suggest using the -dev Docker image tags instead, which run as root by default (i.e. surrealdb/surrealdb:latest-dev)

That way there's no need to change the file ownership

+1 and the container will be based on. It's the latest-dev version of the surrealdb/surrealdb image.

@AgustinRamiroDiaz
Copy link
Contributor Author

@sgirones thanks for the warm welcome :D

I understand that the dev image would solve it too. I guess you are proposing that to simplify the usability of the command. I think that this approach might look a bit "unprofessional" to users since we suggest to use a dev image when running docker (just my thoughts)

WDYT about adding --user root to the docker run command (while still using the production image) and then specify something like "if you are an advanced docker user you can remove the root user and set permissions in the container accordingly"


@Ekwuno sorry, I don't understand your comment. What does "the container will be based on" mean?

@Ekwuno
Copy link
Contributor

Ekwuno commented Feb 12, 2024

@AgustinRamiroDiaz sorry about that. I mean that adding surrealdb/surrealdb:latest-dev means that the docker container will be based on the latest version of the surrealdb/surrealdb image

@Ekwuno Ekwuno merged commit e219c02 into surrealdb:main Mar 15, 2024
4 checks passed
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

Successfully merging this pull request may close these issues.

Bug: unable to run Docker container with a volume
3 participants