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

Add Docker to run docsy user guide locally #1016

Merged
merged 2 commits into from
Jun 13, 2022
Merged

Conversation

geriom
Copy link
Collaborator

@geriom geriom commented May 21, 2022

Add support to run the docsy website server locally inside a container.
With support for both docker and docker-compose.

The folder is mounted as a shared volume, allowing changes to be picked up
by the container. The node_modules folder is kept in a volume, to
avoid surfacing those files in the host folder.

The documentation explains how to run the container as the host user, so
you don't end up with files like package.json and .hugo-build.lock
owned by root on the host os.

Docs preview

Add support to run the docsy website server locally inside a container.
With support for both `docker` and `docker-compose`.

The folder is mounted as a shared volume, allowing changes to be picked up
by the container. The `node_modules` folder is kept in a volume, to
avoid surfacing those files in the host folder.

The documentation explains how to run the container as the host user, so
you don't end up with files like `package.json` and `.hugo-build.lock`
owned by root on the host os.
@geriom geriom requested review from chalin and LisaFC May 21, 2022 23:40
@geriom
Copy link
Collaborator Author

geriom commented May 21, 2022

Tested only on Linux, please test on Mac.

@LisaFC
Copy link
Collaborator

LisaFC commented Jun 13, 2022

Works fine on my Mac!

@LisaFC LisaFC merged commit 436ae87 into google:main Jun 13, 2022
fekete-robert pushed a commit to fekete-robert/docsy that referenced this pull request Sep 13, 2022
Add support to run the docsy website server locally inside a container.
With support for both `docker` and `docker-compose`.

The folder is mounted as a shared volume, allowing changes to be picked up
by the container. The `node_modules` folder is kept in a volume, to
avoid surfacing those files in the host folder.

The documentation explains how to run the container as the host user, so
you don't end up with files like `package.json` and `.hugo-build.lock`
owned by root on the host os.

Co-authored-by: LisaFC <lcarey@google.com>
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.

None yet

2 participants