Skip to content

docs: add INSTALL.md and update README#794

Open
adityashekhawat1999 wants to merge 4 commits intogoharbor:mainfrom
adityashekhawat1999:docs/add-install-methods
Open

docs: add INSTALL.md and update README#794
adityashekhawat1999 wants to merge 4 commits intogoharbor:mainfrom
adityashekhawat1999:docs/add-install-methods

Conversation

@adityashekhawat1999
Copy link
Copy Markdown
Contributor

Description

This PR improves the installation documentation by adding a dedicated INSTALL.md file and expanding the available installation methods.

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • [ ✅] Documentation update
  • Chore / maintenance

Changes

  • Added INSTALL.md with detailed installation instructions
  • Included package based installation methods(deb, rpm, apk, apt)
  • Added a security section mentioning SBOM and Cosign support

Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
@adityashekhawat1999
Copy link
Copy Markdown
Contributor Author

@NucleoFusion I wasn't sure about the security section can you check it and see if any more changes are required

Comment on lines +41 to +43
#### APT repository

APT based installation is available via the project's gh-pages branch. Refer to the repository for more details.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You need to add this
Refer to the .dagger/apt.go file for how.

README.md Outdated
Comment on lines 72 to 93
@@ -92,6 +92,8 @@ brew install harbor-cli

Otherwise, you can download the binary from the [releases page](https://github.com/goharbor/harbor-cli/releases).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would keep this in the installation.md as well, and only have the 'refer to xxx' in the readme.md

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I didn't remove the installation through homebrew i think it is best to keep it here but i moved the container configuration in install.md

INSTALL.md Outdated

## Security

Harbor CLI provides security features such as SBOM (Software Bill of Materials) and Cosign support for verifying artifacts. These help ensure the integrity and authenticity of distributed binaries.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would explain more
That harbor-cli provides attested binaries and images.
Via the Cosign, Checksum.

And also provides downloadable SBOM following the Dynamo format or something for each binary

Aditya Pratap Singh Shekhawat added 3 commits April 3, 2026 21:07
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
@adityashekhawat1999
Copy link
Copy Markdown
Contributor Author

@NucleoFusion Please review the changes

@NucleoFusion
Copy link
Copy Markdown
Contributor

Lets discuss in the next meet how we want to re-structure the readme for the growing installation section

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.

enhancement: Adding up-to-date installation docs

2 participants