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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 3 commits into from
Oct 9, 2023
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5faac2e
Add section for reverse proxies.
KN4CK3R Oct 7, 2023
a12b938
Moved docs.
KN4CK3R Oct 8, 2023
4d8e38b
Merge branch 'main' into docs-container-prefix
wxiaoguang Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/content/administration/reverse-proxies.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


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 •
edited
Loading

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.

Even if you deploy Gitea with a different sub-path, `/v2` will be used by the `docker` client.
Therefore you may need to add an additional route to your reverse proxy configuration.