README.md
1# hcsshim
2
3[](https://github.com/microsoft/hcsshim/actions?query=branch%3Amaster)
4
5This package contains the Golang interface for using the Windows [Host Compute Service](https://techcommunity.microsoft.com/t5/containers/introducing-the-host-compute-service-hcs/ba-p/382332) (HCS) to launch and manage [Windows Containers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/about/). It also contains other helpers and functions for managing Windows Containers such as the Golang interface for the Host Network Service (HNS).
6
7It is primarily used in the [Moby Project](https://github.com/moby/moby), but it can be freely used by other projects as well.
8
9## Contributing
10
11This project welcomes contributions and suggestions. Most contributions require you to agree to a
12Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
13the rights to use your contribution. For details, visit https://cla.microsoft.com.
14
15When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
16a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
17provided by the bot. You will only need to do this once across all repos using our CLA.
18
19We also ask that contributors [sign their commits](https://git-scm.com/docs/git-commit) using `git commit -s` or `git commit --signoff` to certify they either authored the work themselves or otherwise have permission to use it in this project.
20
21
22## Code of Conduct
23
24This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
25For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
26contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
27
28## Dependencies
29
30This project requires Golang 1.9 or newer to build.
31
32For system requirements to run this project, see the Microsoft docs on [Windows Container requirements](https://docs.microsoft.com/en-us/virtualization/windowscontainers/deploy-containers/system-requirements).
33
34## Reporting Security Issues
35
36Security issues and bugs should be reported privately, via email, to the Microsoft Security
37Response Center (MSRC) at [secure@microsoft.com](mailto:secure@microsoft.com). You should
38receive a response within 24 hours. If for some reason you do not, please follow up via
39email to ensure we received your original message. Further information, including the
40[MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in
41the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).
42
43For additional details, see [Report a Computer Security Vulnerability](https://technet.microsoft.com/en-us/security/ff852094.aspx) on Technet
44
45---------------
46Copyright (c) 2018 Microsoft Corp. All rights reserved.
47
){kind=link}