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

Create README.md #3219

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@montao
Copy link

montao commented Nov 4, 2018

- What I did
Documented how to get started with the sshd example using Windows 10 as a host.
- How I did it
I forked the repository, built linuxkit, ran it and connected via ssh. Then I described how I did it so that new users can easily get started.
- How to verify it
Step through the README.md
- Description for the changelog

Add README.md with initial instructions for Windows 10

- A picture of a cute animal (not mandatory but encouraged)

@GordonTheTurtle

This comment has been minimized.

Copy link
Collaborator

GordonTheTurtle commented Nov 4, 2018

Please sign your commits following these rules:
https://github.com/moby/moby/blob/master/CONTRIBUTING.md#sign-your-work
The easiest way to do this is to amend the last commit:

$ git clone -b "master" git@github.com:montao/linuxkit.git somewhere
$ cd somewhere
$ git commit --amend -s --no-edit
$ git push -f

Amending updates the existing PR. You DO NOT need to open a new one.

Create README.md
Signed-off-by: niklasr <niklasr@protonmail.com>

@GordonTheTurtle GordonTheTurtle removed the dco/no label Nov 4, 2018

@rn

This comment has been minimized.

Copy link
Member

rn commented Nov 4, 2018

Thanks for the documentation. I think https://github.com/linuxkit/linuxkit/blob/master/docs/platform-hyperv.md would be a better place to add this information. It already contains some (almost certainly incomplete) instructions on how to run images on Windows.


`linuxkit.exe build -format iso-efi sshd.yml`

Then you run the image, maybe in Git BASH or some other shell which respects the `$HOME/.ssh/id_rsa.pub` variable:

This comment has been minimized.

@rn

rn Nov 4, 2018

Member

I think it is the linuxkit build command which needs to find $HOME/.ssh/id_rsa.pub, not the linuxkit run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment