1
0
mirror of https://github.com/goharbor/harbor.git synced 2026-10-23 10:08:57 +03:00

171 Commits

Author SHA1 Message Date
Vadim Bauer
cce1901e90 docs: switch security reporting to GitHub private vulnerability reporting (#23559)
* docs: switch security reporting to GitHub private vulnerability reporting

Replace the cncf-harbor-security mailing list with GitHub private
vulnerability reporting as the intake channel for security reports,
per goharbor/community#292. Private vulnerability reporting is enabled
on the repository.

- SECURITY.md: point reporters at the Security tab / Report a
  vulnerability form; describe the advisory-based triage, CVSS,
  in-band CVE request, and temporary private fork workflow; keep the
  mailing list only as a fallback for reporters without a GitHub
  account and for distributor list membership requests
- Add issue template contact link routing vulnerability reports to
  the private advisory form
- Add a security warning to the bug report template

Signed-off-by: Vadim Bauer <vb@container-registry.com>

* docs: make GitHub private reporting the sole intake channel

Address review feedback: drop the mailing-list fallback so there is a
single reporting method, clarify that the reporter can see their own
report, and fix template grammar.

Signed-off-by: Vadim Bauer <vb@container-registry.com>

* docs: address review feedback on security reporting switch

- Relax the response SLA: acknowledge within 5 business days, then
  investigate and follow up, instead of promising a full investigation
  plan within 3 business days.
- Request a CVE from GitHub only where GitHub is eligible as CNA; when
  another CNA already covers the affected component, coordinate with
  that CNA instead of filing a duplicate.
- Point README.md's vulnerability reporting section at private
  vulnerability reporting instead of the security mailing list.
- List cncf-harbor-security@lists.cncf.io again under Mailing lists,
  scoped to distributors-list administration, since the Embargo Policy
  and membership sections still reference it.
- Split the reporting paragraph, state the GitHub-account requirement as
  a deliberate single-channel decision, and stop overloading
  'acknowledged' to mean both receipt and triage verdict.
- Disable blank issues so reports cannot bypass the issue chooser and
  its security contact link.
- Note that larger artifacts are shared in the temporary private fork;
  the advisory form is not documented to accept attachments.

Signed-off-by: Vadim Bauer <vb@container-registry.com>

* docs: drop Notary from the dependency example list

Notary is no longer part of Harbor, so listing it as an example
dependency in the vulnerability-scope section is misleading. Also
normalises PGSql to PostgreSQL in the same list.

Signed-off-by: Vadim Bauer <vb@container-registry.com>

* docs: drop the Notary feature bullet from README

Notary is no longer part of Harbor, so advertising Docker Content Trust
signing via Notary in the feature list is misleading.

Signed-off-by: Vadim Bauer <vb@container-registry.com>

---------

Signed-off-by: Vadim Bauer <vb@container-registry.com>
2026-08-14 14:56:29 +00:00
Akanksha Trehun
36d6e8c243 docs: fix markdown formatting issues in CONTRIBUTING.md and README.md (#23537)
Signed-off-by: Akanksha Trehun <akankshatrehun@gmail.com>
2026-07-15 06:44:45 +00:00
Siddharth Kushwaha
23c2313239 docs: fix minor typos and grammar improvements in README (#22934)
Signed-off-by: Siddharth Kushwaha <siddharthkushwahan@gmail.com>
Co-authored-by: Orlix <7236111+OrlinVasilev@users.noreply.github.com>
2026-03-06 04:33:05 +00:00
kashish
c898767b19 chore: add OpenSSF Security Scorecard badge #22774
ADD: OpenSSF Security scorecard badge
2026-01-27 07:56:09 +00:00
Ikram ALOUI
e7f0333979 Add Cosign keyless signing for Harbor release artifacts (#22578)
* feat: implement keyless signing in release workflow

- Move signing from build to release workflow
- Use .sigstore.json naming convention (Sigstore standard)
- update signature verification documentation and readme file
- Update workflows to sign artifacts at release time only

Signed-off-by: Aloui-Ikram <ikram@container-registry.com>

* WIP: update release workflow and utils

Signed-off-by: Aloui-Ikram <ikram@container-registry.com>

* Add Cosign signing and fix accidental deletions

- Add Cosign signing to releases for security
- Revert to using getAssets function
- Restore latest installer uploads
- Restore pre-release comment

Signed-off-by: Aloui-Ikram <ikram@container-registry.com>

* Remove braces from variable names for consistency

Signed-off-by: Aloui-Ikram <ikram@container-registry.com>

* Remove unnecessary permissions from build-package.yml

Signed-off-by: Aloui-Ikram <ikram@container-registry.com>

---------

Signed-off-by: Aloui-Ikram <ikram@container-registry.com>
Co-authored-by: Aloui-Ikram <ikram@container-registry.com>
Co-authored-by: Daniel Jiang <daniel.jiang@broadcom.com>
2026-01-13 09:47:28 +00:00
Vadim Bauer
47586cd5b6 Update badges (#22139)
remove outdated badges, useless badges, clarify badges

Signed-off-by: Vadim Bauer <vb@container-registry.com>
2025-09-25 09:25:11 +00:00
Mohamed Awnallah
e049fcd985 README.md: add artifact hub badge (#20736)
In this commit, we add the artifact hub
badge for the harbor project to improve
their discoverability and the best practices
index on [clomonitor.io](https://clomonitor.io/projects/cncf/harbor)

Signed-off-by: Mohamed Awnallah <mohamedmohey2352@gmail.com>
Co-authored-by: Vadim Bauer <vb@container-registry.com>
2025-06-05 14:13:34 +03:00
Prasanth Baskar
cc966435a5 Replace vmware with goharbor in README (#21626)
replace vmware with goharbor in README

Signed-off-by: bupd <bupdprasanth@gmail.com>
2025-02-13 16:58:02 +00:00
Yang Jiao
e397e86478 Fix docker version to 20.10.10 (#19751)
Signed-off-by: Yang Jiao <yang.jiao@broadcom.com>
Co-authored-by: Yang Jiao <yang.jiao@broadcom.com>
2023-12-26 16:57:25 +08:00
Shijun Sun
ef96c729c0 Add costomized banner message UI (#18827)
1.Fixes #18719
2.Add Banner Message item to configuration
3.Add banner_message property to systeminfo API

Signed-off-by: AllForNothing <sshijun@vmware.com>
2023-07-03 15:58:37 +08:00
Shijun Sun
9973d99f3e Remove chart api (#18265)
* remove chart api from swagger

Delete the api path for chart in the swagger

Signed-off-by: Wang Yan <wangyan@vmware.com>

* Remove chart APIs
   1. Remove some chart-related steps for Dockerfile for portal  container
   2. Remove chart APIs for API center

Signed-off-by: AllForNothing <sshijun@vmware.com>

---------

Signed-off-by: Wang Yan <wangyan@vmware.com>
Signed-off-by: AllForNothing <sshijun@vmware.com>
Co-authored-by: Wang Yan <wangyan@vmware.com>
2023-02-24 14:47:42 +08:00
Fish-pro
ca5fed3e2c docs(readme): fix syntax errors in the document (#18113) 2023-01-30 12:08:47 +02:00
Orlix
17bfd43a72 Add FOSSA badge and licence analysis (#17656)
Signed-off-by: OrlinVasilev <ovasilev@vmware.com>

Signed-off-by: OrlinVasilev <ovasilev@vmware.com>
Co-authored-by: OrlinVasilev <ovasilev@vmware.com>
2022-11-02 11:01:43 +08:00
koushik-ms
5afd11015a README.md: fix broken links to badges and Swagger editor (#16910)
* README.md: fix links to badges

the links to badges are still referring to "master" branch instead of "main". this commit fixes it.

* README.md: fix Restful API links to swagger editor

The links to swagger editor had the URL paths to the master branch which has hence been renamed. This leads to swagger editor failing to open the API links. this commit fixes that.
2022-05-31 09:40:10 +02:00
孙世军
b5a05dd1a2 Update readme (#16501)
Signed-off-by: AllForNothing <sshijun@vmware.com>
2022-03-10 14:54:43 +08:00
Simon Alling
47effb0533 docs: Link to latest/edge docs instead of 2.0.0 (#14945)
I cloned the repo, clicked a link to the build guideline in
`CONTRIBUTING.md` and copied the "Build, install and bring up Harbor
without Notary" command:

    make install GOBUILDIMAGE=golang:1.12.5 COMPILETAG=compile_golangimage

Being unfamiliar with the Harbor project, I didn't realize that said
command was for building version 2.0.0 and that I had cloned a newer,
incompatible version (2.3.0), so I just ran it and was met by errors:

    […]
    # github.com/goharbor/harbor/src/lib/errors
    ../lib/errors/errors.go:26:7: undefined: errors.As
    ../lib/errors/errors.go:28:7: undefined: errors.Is
    note: module requires Go 1.15
    # github.com/hashicorp/go-multierror
    […]
    make: *** [Makefile:369: compile_core] Error 2

It took me a while to figure out what the problem was; then I replaced
`2.0.0` with `latest` in the URL and found this command instead:

    make install GOBUILDIMAGE=golang:1.13.8 COMPILETAG=compile_golangimage

_Et voilà_ – it worked!

I figured `latest` (which currently redirects to 2.2.0) would make the
most sense for end users and `edge` (which doesn't redirect) for
contributors.

Signed-off-by: Simon Alling <alling.simon@gmail.com>
2022-03-10 13:12:55 +08:00
MinerYang
158ce0499e update harbor codacy badge in README.md (#16277)
Signed-off-by: yminer <yminer@vmmware.com>

Co-authored-by: yminer <yminer@vmmware.com>
2022-01-26 18:10:25 +08:00
Steven Zou
10ceaf5bc5 doc(readme): use edge version for compatibility
update the doc version of the compatibility list from 2.0.0 to edge
2021-03-03 13:48:07 +08:00
Josh Soref
dfe360040b Spelling
* addition
* attribute
* auditing
* availability
* available
* bandwidth
* browser
* business
* cadence
* chartmuseum
* client
* column
* content
* demonstrate
* described
* endpoints
* facilitate
* github
* harbor
* information
* instance
* manual
* meaningful
* operation
* overridden
* password
* possible
* project
* refactor
* replication
* requires
* running
* scanned
* settings
* signup
* those
* unsigned
* vulnerability

--
Also removes trailing space from a filename

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-02-19 11:59:15 +08:00
jonasrosland
fbdbf1b4b4 Remove erroneous link in README
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-07-21 12:41:34 -04:00
jonasrosland
e7d1563c6b Moving docs from the harbor to the website repo
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-07-21 12:41:24 -04:00
Steven Zou
77ca209a98 chore(readme):add code scanning badge 2020-07-09 12:19:12 +08:00
xiaoyuchen9
8a3311e38e fix docs
Signed-off-by: xiaoyuchen9 <xiaoyuchen9@creditease.cn>
2020-05-29 14:51:32 +08:00
Steven Zou
8af243d8b2 doc(readme):update readme to fix broken content
- add architecture section
- update API section
- remove additional tools section
- update compatibility list section
- update the relevant compatibility list document
- add OCI confirmance testing report link
- update broken image paths in readme

Signed-off-by: Steven Zou <szou@vmware.com>
2020-05-18 23:30:34 +08:00
xaleeks
c8269e05a5 fixed install guide broken link in readme
Signed-off-by:  xaleeks <xalex@vmware.com>
Signed-off-by: xaleeks <xalex@vmware.com>
2020-05-17 04:48:22 -04:00
xaleeks
d42f8f0039 Merge pull request #11904 from grinnellian/patch-1
Correct "leveraging"
2020-05-15 00:54:46 -04:00
Ian Bone
95c7cbe49e Correct "leveraging"
Signed-off-by: Ian Bone <grinnellian@users.noreply.github.com>
2020-05-14 16:35:56 -07:00
wang yan
54706f2b1b Fix conformance badge name
It needs to use the upper case when to get the badge url

Signed-off-by: wang yan <wangyan@vmware.com>
2020-05-13 19:13:17 +08:00
wang yan
d9773248e2 add conformance test to CI
1, add a specrate git action for conformance test
2, use the OCI testing code to test Harbor master code on push

Signed-off-by: wang yan <wangyan@vmware.com>
2020-04-29 16:08:27 +08:00
Daniel Jiang
775d7d0bbb Update the link of CI badge
Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2020-04-09 16:31:31 +08:00
xaleeks
0891e8877f typos fix
Signed-off-by: xaleeks <xalex@vmware.com>
2020-03-30 07:08:52 -04:00
xaleeks
df537af8d9 fixed some wording
Signed-off-by: xaleeks <xalex@vmware.com>
2020-03-30 06:33:43 -04:00
Ziming
5dd68cdc69 use codecov badge in README (#10988)
Signed-off-by: Ziming Zhang <zziming@vmware.com>
2020-03-09 22:03:24 +08:00
Daniel Jiang
0f0e27179b Remove dependency on travis-ci
Github actions work fine, we no longer needs travi-ci to trigger the
tests.
This commit removes it.

Signed-off-by: Daniel Jiang <jiangd@vmware.com>
2020-03-09 01:30:38 +08:00
lucperkins
d4709066e6 Update Swagger link
Signed-off-by: lucperkins <lucperkins@gmail.com>
2020-02-21 11:27:41 -08:00
Steven Zou
0cf3793297 doc[compatibility]:add doc ref in the README
- refer the harbor compatibility doc in the README
- add .md suffix to the README file under api/harbor

Signed-off-by: Steven Zou <szou@vmware.com>
2019-12-12 18:43:49 +08:00
Steven Zou
855b8cde18 chore[swagger]:add swagger online validation
- validate the API swagger spec with the online validation tool
- introduce the validation badge into the README
2019-12-11 20:37:59 +08:00
Steven Zou
2cd90963ef doc[scanner]:clear scanner spec related
- remove the scanner open API spec from api folder
- update README doc to remove the API reference

Signed-off-by: Steven Zou <szou@vmware.com>
2019-12-09 18:36:02 +08:00
Michael Michael
552c551f6d Update README.md 2019-12-03 10:27:49 -06:00
Michael Michael
87e57ca356 Update README.md 2019-12-03 10:27:02 -06:00
Michael Michael
e0c049a87b Update README.md 2019-12-03 10:23:37 -06:00
Steven Zou
4c82e4a256 remove the KubeCon San Diego event preview section
As the KubeCon has been closed.
2019-11-26 17:42:14 +08:00
Steven Zou
7b6e83090e create API folder to keep API swagger files
- create API folder
- move harbor API swagger file to API/harbor
- add scanner adapter open API swagger file to API/scanner
- update protal build Dockerfile
- update swagger explorer build command in Makefile

Signed-off-by: Steven Zou <szou@vmware.com>
2019-10-30 21:41:03 +08:00
Michael Michael
3f15a38141 Update README.md 2019-10-21 16:01:55 -07:00
DQ
aef93af21f Fix docker-compose version to 1.18.0
Signed-off-by: DQ <dengq@vmware.com>
2019-09-02 18:37:42 +08:00
DQ
131d26c0f8 Docker compose check function need updated to 1.23.0+
Signed-off-by: DQ <dengq@vmware.com>
2019-08-08 14:22:03 +08:00
Maosheng Ren
f72a2613c2 Merge pull request #6601 from royeectu/master
remove duplicate word
2019-08-02 10:24:00 +08:00
Qian Deng
b55f403679 Merge pull request #7894 from ninjadq/update_doc_4_https
Update doc for configure https
2019-06-24 14:52:12 +08:00
Henry Zhang
e619d686b6 Update readme
Signed-off-by: Henry Zhang <haininghenryzh@vmware.com>
2019-06-10 17:35:28 +08:00
Qian Deng
7a0f570e70 Update doc for configure https
update configs for https

Signed-off-by: Qian Deng <dengq@vmware.com>
2019-05-24 16:30:18 +08:00