[![Modules Status](https://github.com/OpenVoxProject/openbolt/actions/workflows/modules.yaml/badge.svg?branch=main)](https://github.com/OpenVoxProject/openbolt/actions/workflows/modules.yaml)
[![Build Status](https://github.com/OpenVoxProject/openbolt/actions/workflows/build.yml/badge.svg)](https://github.com/OpenVoxProject/openbolt/actions/workflows/build.yml)
[![Version](https://img.shields.io/github/v/tag/OpenVoxProject/openbolt?label=version)](./CHANGELOG.md)
[![Platforms](https://img.shields.io/badge/platforms-linux%20%7C%20windows%20%7C%20macos-lightgrey)](./documentation/bolt_installing.md)
[![License](https://img.shields.io/github/license/OpenVoxProject/openbolt)](./LICENSE)

OpenBolt is an open source orchestration tool that automates the manual work it takes to maintain your infrastructure. 
Use OpenBolt to automate tasks that you perform on an as-needed basis or as part of a greater orchestration workflow. 
For example, you can use OpenBolt to patch and update systems, troubleshoot servers, deploy applications, or stop and restart services. 
OpenBolt can be installed on your local workstation and connects directly to remote targets with SSH or WinRM, so you are not required to install any agent software.

OpenBolt is a community implementation of [Puppet Bolt](https://github.com/puppetlabs/bolt).

### Bring order to the chaos with orchestration

Run simple plans to rid yourself of the headaches of orchestrating complex workflows. Create and share OpenBolt plans to easily expand across your application stack.

### Use what you have to automate simple tasks or complex workflows

Get going with your existing scripts and plans, including YAML, PowerShell, Bash, Python or Ruby, or reuse content from the [Puppet Forge](https://forge.puppet.com).

### Documentation

OpenBolt's documentation can be found under [documentation](./documentation). See also the [Puppet Bolt Docs site](https://help.puppet.com/bolt/current/topics/bolt.htm)

At the time of writing, the OpenVoxProject does not have a documentation website.
But your help is very welcome!
Reach out to the [Documentation Special Interest Group](https://github.com/voxpupuli/community-triage/wiki/SIG.Documentation) if you want to help.

### Learning Resources

- Puppet Bolt [getting started guide](https://puppet.com/docs/bolt/latest/getting_started_with_bolt.html)
- Puppet Bolt [self-paced training](https://puppet.com/learning-training/kits/intro-to-bolt).

## Supported platforms

OpenBolt can be installed on Linux, Windows, and macOS. For complete installation details, see the [installation docs](https://docs.openvoxproject.org/openbolt/latest/bolt_installing.html).

For alternate installation methods and running from source code, see our [contributing guidelines](https://github.com/OpenVoxProject/openbolt/blob/main/CONTRIBUTING.md).

## Getting help

Join #bolt on the Vox Pupuli Slack or IRC to chat with OpenBolt developers and the community - see [connecting with Vox Pupuli](https://voxpupuli.org/connect/)

## Contributing

We welcome error reports and pull requests to OpenBolt. See our [contributing guidelines](./CONTRIBUTING.md) for how to help.

## License

See [LICENSE](LICENSE) file.
OpenBolt is licensed by the OpenVox Project as a community maintained implementation of Bolt.
The OpenVox Project can be contacted at: openvox@voxpupuli.org.