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

Overhaul docker documentation and fix minor bugs #6540

Merged
merged 3 commits into from
Jul 9, 2024

Conversation

ebr
Copy link
Member

@ebr ebr commented Jun 24, 2024

Summary

  • Adds instructions on running the official images to the main README, to the docker/README.md, and to the mkdocs documentation
  • changes the name of docker-compose profile to invokeai-cuda, as suggested in Docker compose changes #6043
  • ensures that the chown command in docker entrypoint script does not break on read-only filesystems

Related Issues / Discussions

Closes #6264

QA Instructions

I tested following these docs on a Linux system, but some testing on Windows with WSL would be helpful.

  1. Try the docker run commands from the README, including working directory persistence. Try mounting an existing InvokeAI root dir into the container, as described in the README.
  2. Test the run.sh script and docker compose commands

Merge Plan

Merge when approved

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Documentation added / updated (if applicable)

Copy link
Collaborator

@psychedelicious psychedelicious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

I'd prefer a link to the docker docs in root repo README, rather than partially duplicating the docker docs. More to keep updated and longer README. Will leave that up to you though, not a big deal either way. Maybe docker is popular enough that it makes sense to have it front-and-center.

@ebr
Copy link
Member Author

ebr commented Jul 9, 2024

Thanks! yeah, we occasionally see questions on where to find the official images, so I think it's helpful to have a one-liner in the main README that "just works" to get started. Agreed that the more extensive docs should stay in the other locations - i tried to keep it that way.

@ebr ebr enabled auto-merge (rebase) July 9, 2024 13:39
@ebr ebr merged commit 4313578 into main Jul 9, 2024
14 checks passed
@ebr ebr deleted the ebr/fix/docker-improvements branch July 9, 2024 13:47
@ebr ebr mentioned this pull request Jul 23, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker docs PRs that change docs Root
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug]: chown in docker entrypoint causes mounting of config to no longer be possible
3 participants