Skip to content

docs: OpenBolt install#173

Open
d1nuc0m wants to merge 1 commit intoOpenVoxProject:mainfrom
d1nuc0m:install-docs
Open

docs: OpenBolt install#173
d1nuc0m wants to merge 1 commit intoOpenVoxProject:mainfrom
d1nuc0m:install-docs

Conversation

@d1nuc0m
Copy link
Contributor

@d1nuc0m d1nuc0m commented Jan 8, 2026

For Windows - I wasn't able to find the appropriate files, have they been released?

@jay7x
Copy link
Contributor

jay7x commented Jan 8, 2026

I roughly remember there was some issues with windows builds.. maybe @nmburgan remembers more details

@nmburgan
Copy link
Member

nmburgan commented Jan 8, 2026

Yes, we ran into some problems with the build. We’re working on server/db releases right now but hopefully can revisit this soon.

@d1nuc0m
Copy link
Contributor Author

d1nuc0m commented Mar 5, 2026

@nmburgan as the Win builds aren't available yet, maybe we can start merging and then updating the docs when it'll be available?

@nmburgan
Copy link
Member

Yeah, that seems fine. I don't know when we'll be able to revisit, but hopefully it won't be too long.

@d1nuc0m
Copy link
Contributor Author

d1nuc0m commented Mar 11, 2026

@nmburgan ok, rebased

@d1nuc0m
Copy link
Contributor Author

d1nuc0m commented Mar 17, 2026

@nmburgan rebased again

**Uninstall Bolt**

To uninstall Bolt, run the following command:
# Debian 10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deb 10, Ubuntu 18, and Ubuntu 20 are no longer supported

Copy link
Member

@nmburgan nmburgan Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Take a look at our currently supported platform list for openvox. It should be the same here. Missing SLES 16, Ubuntu 26, maybe some others.

# Installing OpenBolt

Packaged versions of Bolt are available for several Linux distributions, macOS,
Packaged versions of OpenBolt are available for several Linux distributions, macOS,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably leave a note about Windows builds coming soon.

# EL9
sudo dnf install https://yum.voxpupuli.org/openvox8-release-el-9.noarch.rpm
# EL8 FIPS
sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-redhatfips-8.noarch.rpm
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not going to build OpenBolt for FIPS

sudo rpm -Uvh https://yum.voxpupuli.org/openvox8-release-redhatfips-8.noarch.rpm
# EL9 FIPS
sudo dnf install https://yum.voxpupuli.org/openvox8-release-redhatfips-9.noarch.rpm
# Fedora 36
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don’t support 36. I forget exactly which Fedoras are currently supported. Take a look at the shared-actions repo, the build vanagon action, to see the current platform list.

## Install OpenBolt on macOS

You can install Bolt packages for macOS using either Homebrew or the
You can install OpenBolt packages for macOS using either Homebrew or the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think we have it in brew yet.

2. Double-click the `openbolt-[version].dmg` file to mount the installer and
then double-click `openbolt-[version]-installer.pkg` to run the installer.

If you get a message that the installer "can't be opened because Apple cannot check it for malicious software:"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not happen now. Our binaries are fully signed and notarized.

**Uninstall OpenBolt**

To uninstall Bolt, remove Bolt's files and executable:
To uninstall OpenBolt, remove OpenBolt's files and executable:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct. It should be removed using the package manager, or the uninstalled in the dmg for macOS.

modules which are required for common OpenBolt actions.

To install Bolt as a gem:
To install OpenBolt as a gem:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gem install openbolt

- On Windows with the default install location:
```
"C:/Program Files/Puppet Labs/Bolt/bin/gem.bat" install --user-install <GEM>
"C:/Program Files/OpenVox/OpenBolt/bin/gem.bat" install --user-install <GEM>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once Windows builds are fixed, it will actually be the same puppetlabs path as Bolt.

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.

3 participants