Skip to content
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

Add docs section for sub-paths with the container registry #27505

Merged
merged 3 commits into from
Oct 9, 2023

Conversation

KN4CK3R
Copy link
Member

@KN4CK3R KN4CK3R commented Oct 7, 2023

Fixes #21092

suggested by #21092 (comment)

@KN4CK3R KN4CK3R added type/docs This PR mainly updates/creates documentation topic/packages labels Oct 7, 2023
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 7, 2023
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 7, 2023
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Oct 7, 2023
@pull-request-size pull-request-size bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 8, 2023
@delvh delvh removed the kind/docs label Oct 8, 2023
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Oct 8, 2023

## Docker / Container Registry

The container registry uses a fixed sub-path `/v2` which can't be changed.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The container registry uses a fixed sub-path `/v2` which can't be changed.
The docker container registry uses a fixed sub-path `/v2` which can't be changed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Mentioning Docker just because that's the more common name. The correct form would be "OCI Registry" or such but then knowbody knows what's that section is about. On all other places we just use "Container Registry".

Copy link
Member

@silverwind silverwind Oct 8, 2023

Choose a reason for hiding this comment

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

The "docker" name is very ingrained in the community, but I could see renaming it to "OCI containers" may be more correct. Just "containers" may be ambigous as there are other types of containers as well, like LXC.

@@ -381,3 +381,9 @@ If you really need to do so, to make Gitea works with sub-path (eg: `http://exam
1. Set `[server] ROOT_URL = http://example.com/gitea/` in your `app.ini` file.
2. Make the reverse-proxy pass `http://example.com/gitea/foo` to `http://gitea-server:3000/foo`.
3. Make sure the reverse-proxy not decode the URI, the request `http://example.com/gitea/a%2Fb` should be passed as `http://gitea-server:3000/a%2Fb`.

## Docker / Container Registry
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Docker / Container Registry
## Docker container Registry

Copy link
Member

Choose a reason for hiding this comment

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

I think the original text means docker or other container registry like podman and etc. since the protocol is compatible.

Copy link
Contributor

Choose a reason for hiding this comment

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

Docker / Container Registry is the right wording.

@KN4CK3R KN4CK3R changed the title Add docs section for reverse proxies Add docs section for sub-paths with the container registry Oct 8, 2023
@wxiaoguang wxiaoguang merged commit e94a4ad into go-gitea:main Oct 9, 2023
24 checks passed
@GiteaBot GiteaBot added this to the 1.22.0 milestone Oct 9, 2023
@KN4CK3R KN4CK3R deleted the docs-container-prefix branch October 9, 2023 11:20
zjjhot added a commit to zjjhot/gitea that referenced this pull request Oct 10, 2023
* giteaofficial/main:
  Respect SSH.KeygenPath option when calculating ssh key fingerprints (go-gitea#27536)
  Remove max-width and add hide text overflow (go-gitea#27359)
  Fix `environment-to-ini` inherited key bug (go-gitea#27543)
  Improve docs about register/run as a service (go-gitea#27461)
  api: GetPullRequestCommits: return file list (go-gitea#27483)
  switch to using official AWS step in release nightly (go-gitea#27532)
  Improve file history UI and fix URL escaping bug (go-gitea#27531)
  Improve dropdown's behavior when there is a search input in menu (go-gitea#27526)
  Simplify `contrib/backport` (go-gitea#27520)
  Add docs section for sub-paths with the container registry (go-gitea#27505)
  Document our new labeling strategy (go-gitea#27523)
  [skip ci] Updated translations via Crowdin
  Restore warning commit status (go-gitea#27504)
  Update labeler to match new labeling system (go-gitea#27525)
  Apply to become a maintainer (go-gitea#27522)
  Remove unnecessary desc for openssh key cron task (go-gitea#27515)
  Tweak labeler config (go-gitea#27502)
  Add hover background to wiki list page (go-gitea#27507)
  [FIX] missing ctx in new_form (go-gitea#27514)
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Jan 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docker Package Registry not working with sub directory?
7 participants