-
Notifications
You must be signed in to change notification settings - Fork 144
docs: add INSTALL.md and update README #794
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
adityashekhawat1999
wants to merge
6
commits into
goharbor:main
Choose a base branch
from
adityashekhawat1999:docs/add-install-methods
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6c90c9d
docs: add INSTALL.md and update README
cc2fac1
docs: refine APT installation section
1d3edae
docs: move container setup to INSTALL.md and fix formatting
776c20d
docs: expand security section with cosign, checksum and sbom details
423af49
docs: update based on review
4c99570
docs: add detailed APT installation steps
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Installation Guide | ||
|
|
||
| ## Container Configuration | ||
|
|
||
| Use the `HARBOR_ENCRYPTION_KEY` container environment variable as a base64-encoded 32-byte key for AES-256 encryption. This securely stores your harbor login password. | ||
|
|
||
| If you intend to run the CLI as a container, it is advised | ||
| to set the following environment variables and to create an alias | ||
| and append the alias to your .zshrc or .bashrc file | ||
|
|
||
| ```shell | ||
| echo "export HARBOR_CLI_CONFIG=\$HOME/.config/harbor-cli" >> ~/.zshrc | ||
| echo "export HARBOR_ENCRYPTION_KEY=\$(cat <path_to_32bit_private_key_file> | base64)" >> ~/.zshrc | ||
| echo "alias harbor='docker run -ti --rm -v \$HARBOR_CLI_CONFIG:/root/.config/harbor-cli -e HARBOR_ENCRYPTION_KEY=\$HARBOR_ENCRYPTION_KEY registry.goharbor.io/harbor-cli/harbor-cli'" >> ~/.zshrc | ||
| source ~/.zshrc # or restart your terminal | ||
| ``` | ||
|
|
||
| ## Homebrew | ||
| ```bash | ||
| brew install harbor-cli | ||
| ``` | ||
|
|
||
| Otherwise, you can download the binary from the [releases page](https://github.com/goharbor/harbor-cli/releases). | ||
|
|
||
| ### Package based Installation | ||
|
|
||
| You can also install Harbor CLI using platform specific packages from the releases page. | ||
|
|
||
| #### Debian/Ubuntu(.deb) | ||
|
|
||
| > Replace `<version>` with the desired release version (e.g., v0.x.x). | ||
|
|
||
| ```bash | ||
| wget https://github.com/goharbor/harbor-cli/releases/download/<version>/harbor-cli_<version>_linux_amd64.deb | ||
| sudo dpkg -i harbor-cli_<version>_linux_amd64.deb | ||
| ``` | ||
|
|
||
| #### Fedora/CentOS(.rpm) | ||
|
|
||
| > Replace `<version>` with the desired release version (e.g., v0.x.x). | ||
|
|
||
| ```bash | ||
| wget https://github.com/goharbor/harbor-cli/releases/download/<version>/harbor-cli_<version>_linux_amd64.rpm | ||
| sudo rpm -i harbor-cli_<version>_linux_amd64.rpm | ||
| ``` | ||
|
|
||
| #### Alpine(.apk) | ||
|
|
||
| > Replace `<version>` with the desired release version (e.g., v0.x.x). | ||
|
|
||
| ```bash | ||
| wget https://github.com/goharbor/harbor-cli/releases/download/<version>/harbor-cli_<version>_linux_amd64.apk | ||
| sudo apk add --allow-untrusted harbor-cli_<version>_linux_amd64.apk | ||
| ``` | ||
|
|
||
| #### APT repository | ||
|
|
||
| Harbor CLI provides an APT repository for Debian/Ubuntu systems. | ||
|
|
||
| 1. Add the repository: | ||
|
|
||
| ```bash | ||
| echo "deb [trusted=yes] https://goharbor.github.io/harbor-cli/buildDirs/stable /" | sudo tee /etc/apt/sources.list.d/harbor-cli.list | ||
| ``` | ||
|
|
||
| 2. Update package index: | ||
|
|
||
| ```bash | ||
| sudo apt update | ||
| ``` | ||
|
|
||
| 3. Install Harbor CLI: | ||
|
|
||
| ```bash | ||
| sudo apt install harbor-cli | ||
| ``` | ||
|
|
||
| > Note: The repository currently uses `trusted=yes` which skips signature verification. | ||
|
|
||
| ## Security | ||
|
|
||
| Harbor CLI provides attested binaries and artifacts to ensure integrity and authenticity. | ||
|
|
||
| Artifacts are signed using Cosign as part of the release process enabling verification of distributed binaries and container images. | ||
|
|
||
| SHA256 checksums are generated for all release artifacts allowing users to validate downloads. | ||
|
|
||
| Additionally, SBOMs (Software Bill of Materials) are generated for each release using Syft in CycloneDX format providing transparency into dependencies and build contents. | ||
|
|
||
| These features help ensure the integrity and trustworthiness of Harbor CLI artifacts. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesnt work rn due to some error in serving the apt.
Please hold on while we try to fix it.