Skip to content

Improve Installation mechanisim and instructions. #86

Description

@sarg3nt

The installation instructions at:
https://github.com/sarg3nt/gearbox/blob/main/docs/getting-started.md
Are very out of date and need a lot of help. Besides that, we need to also add some helpers, such as an install script, et cetera. Right now, the instructions say to clone the repo and build it yourself, which is never a good model for adopters.

At minimum, we need to make sure that we are building the binaries when we do releases so that users can download those directly onto their box. And I would also like to explore with the best in class way of doing an installation of a service-based app, like gearbox agent, and a dashboard-based, uh, application like your box is, I would expect that most people would run gearbox itself as a docker container, but that might not be always the case.

It could just be an app that they run on the box. We need to look at all these possibilities, do research on all of them and come up with really the best in class way of doing it in 2026. Once we figure that out, we then need to update the documentation to reflect it. One mechanism I've seen is to have a simple install script that a user can run via one liner curl command against the GitHub. repo, but some people have trouble trusting those, which I totally understand. What are other options, understanding that we need to support different flavors of Linux, such as Ubuntu, and Red Half versions, and eventually, we'll want to support Windows, servers, Windows, desktops, Mac desktops, et cetera. But for now, we'll stick with Linux, but we want to make sure we keep our understanding that those others are going to show up eventually.

Like, for example, we'll want to support Wingate and brew and other package installers in the future as well. So this issue is about one, creating a long-term plan, to creating a short-term plan for how we're going to make it possible, for supporting at minimum, services on Ubuntu and red hat-based... Lemixistros and docker containers. for both gearbox and gearbox-agent.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions