2013-03-22 22:41:53 -07:00
# Packer
2023-10-23 11:52:47 -04:00
[](LICENSE)
2022-02-25 16:58:52 -08:00
[](https://github.com/hashicorp/packer/actions/workflows/build.yml)
2021-03-02 12:21:45 +01:00
[](https://discuss.hashicorp.com/c/packer)
2023-10-23 11:52:47 -04:00
===
2015-01-23 11:55:34 +09:00
2021-03-02 12:21:45 +01:00
<p align="center" style="text-align:center;">
<a href="https://www.packer.io">
2021-03-03 03:55:35 -05:00
<img alt="HashiCorp Packer logo" src="website/public/img/logo-packer-padded.svg" width="500" />
2021-03-02 12:21:45 +01:00
</a>
</p>
2013-06-08 22:56:34 -07:00
2013-06-08 22:35:58 -07:00
Packer is a tool for building identical machine images for multiple platforms
from a single source configuration.
2013-03-22 22:41:53 -07:00
2013-06-08 22:35:58 -07:00
Packer is lightweight, runs on every major operating system, and is highly
2016-02-05 14:21:10 -08:00
performant, creating machine images for multiple platforms in parallel. Packer
2023-10-23 11:52:47 -04:00
supports various platforms through external plugin integrations, the full list of which can
be found at https://developer.hashicorp.com/packer/integrations.
2014-05-09 07:37:34 -07:00
2023-10-23 11:52:47 -04:00
The images that Packer creates can easily be turned into [Vagrant ](http://www.vagrantup.com ) boxes.
2013-03-22 22:41:53 -07:00
2013-03-23 15:59:17 -07:00
## Quick Start
2023-10-23 11:52:47 -04:00
### Packer
2013-06-28 09:36:01 -04:00
2023-10-23 11:52:47 -04:00
There is a great [introduction and getting started guide ](https://learn.hashicorp.com/tutorials/packer/get-started-install-cli )
for building a Docker image on your local machine without using any paid cloud resources.
2013-03-23 15:59:17 -07:00
2023-10-23 11:52:47 -04:00
Alternatively, you can refer to [getting started with AWS ](https://developer.hashicorp.com/packer/tutorials/aws-get-started ) to
learn how to build a machine image for an external cloud provider.
2021-03-02 12:21:45 +01:00
2023-10-23 11:52:47 -04:00
### HCP Packer
2013-06-08 22:35:58 -07:00
2023-10-23 11:52:47 -04:00
HCP Packer registry stores Packer image metadata, enabling you to track your image lifecycle.
2021-03-02 12:21:45 +01:00
2023-10-23 11:52:47 -04:00
To get started with building an AWS machine image to HCP Packer for referencing in Terraform refer
to the collection of [HCP Packer Tutorials ](https://developer.hashicorp.com/packer/tutorials/hcp-get-started ).
2013-03-23 15:59:17 -07:00
2013-06-08 22:35:58 -07:00
## Documentation
2013-03-23 15:59:17 -07:00
2023-10-23 11:52:47 -04:00
Comprehensive documentation is viewable on the Packer website at https://developer.hashicorp.com/packer/docs.
2013-03-23 15:59:17 -07:00
2021-03-02 12:21:45 +01:00
## Contributing to Packer
2013-03-22 22:41:53 -07:00
2018-04-02 10:55:13 -07:00
See
[CONTRIBUTING.md ](https://github.com/hashicorp/packer/blob/master/.github/CONTRIBUTING.md )
for best practices and instructions on setting up your development environment
to work on Packer.
2020-07-08 07:17:13 -04:00
2026-03-25 21:29:13 +05:30
### Contributing to Documentation
**Important:** Packer documentation has moved to the [`hashicorp/web-unified-docs` ](https://github.com/hashicorp/web-unified-docs ) repository.
To contribute documentation changes:
- Make contributions directly to the `web-unified-docs` repository
- See the [Updating Documentation section ](https://github.com/hashicorp/packer/blob/main/.github/CONTRIBUTING.md#updating-documentation ) in CONTRIBUTING.md for detailed instructions
2020-07-08 07:17:13 -04:00
## Unmaintained Plugins
2020-07-09 06:39:29 -04:00
As contributors' circumstances change, development on a community maintained
2021-11-09 16:06:03 -05:00
plugin can slow. When this happens, HashiCorp may use GitHub's option to archive the
plugin’ s repository, to clearly signal the plugin's status to users.
2020-07-08 07:17:13 -04:00
What does **unmaintained** mean?
1. The code repository and all commit history will still be available.
1. Documentation will remain on the Packer website.
1. Issues and pull requests are monitored as a best effort.
2021-11-09 16:06:03 -05:00
1. No active development will be performed by HashiCorp.
If you are interested in maintaining an unmaintained or archived plugin, please reach out to us at packer@hashicorp .com.
2020-07-08 07:17:13 -04:00
2023-10-23 11:52:47 -04:00