Improve reverse-proxy document and fix nginx config bug (#24616)
Close #23711, thanks to @ghnp5 ! Close #24612, thanks to @DanielGibson ! Major changes: * the default value of nginx's client_max_body_size is too small, so put a 512M here * move `Resolving Error: 413 Request Entity Too Large` to a sub-section of `Nginx` section * make nginx use unescaped the URI and keep "%2F" as is when using sub-path * add details for General sub-path configuration
This commit is contained in:
parent
c355728a6f
commit
cf1a7b08eb
|
@ -25,12 +25,13 @@ menu:
|
||||||
|
|
||||||
If you want Nginx to serve your Gitea instance, add the following `server` section to the `http` section of `nginx.conf`:
|
If you want Nginx to serve your Gitea instance, add the following `server` section to the `http` section of `nginx.conf`:
|
||||||
|
|
||||||
```apacheconf
|
```
|
||||||
server {
|
server {
|
||||||
listen 80;
|
listen 80;
|
||||||
server_name git.example.com;
|
server_name git.example.com;
|
||||||
|
|
||||||
location / {
|
location / {
|
||||||
|
client_max_body_size 512M;
|
||||||
proxy_pass http://localhost:3000;
|
proxy_pass http://localhost:3000;
|
||||||
proxy_set_header Host $host;
|
proxy_set_header Host $host;
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
@ -40,23 +41,32 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Resolving Error: 413 Request Entity Too Large
|
||||||
|
|
||||||
|
This error indicates nginx is configured to restrict the file upload size,
|
||||||
|
it affects attachment uploading, form posting, package uploading and LFS pushing, etc.
|
||||||
|
You can fine tune the `client_max_body_size` option according to [nginx document](http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size).
|
||||||
|
|
||||||
## Nginx with a sub-path
|
## Nginx with a sub-path
|
||||||
|
|
||||||
In case you already have a site, and you want Gitea to share the domain name, you can setup Nginx to serve Gitea under a sub-path by adding the following `server` section inside the `http` section of `nginx.conf`:
|
In case you already have a site, and you want Gitea to share the domain name, you can setup Nginx to serve Gitea under a sub-path by adding the following `server` section inside the `http` section of `nginx.conf`:
|
||||||
|
|
||||||
```apacheconf
|
```
|
||||||
server {
|
server {
|
||||||
listen 80;
|
listen 80;
|
||||||
server_name git.example.com;
|
server_name git.example.com;
|
||||||
|
|
||||||
# Note: Trailing slash
|
# Note: Trailing slash
|
||||||
location /git/ {
|
location /gitea/ {
|
||||||
# Note: Trailing slash
|
client_max_body_size 512M;
|
||||||
proxy_pass http://localhost:3000/;
|
|
||||||
proxy_set_header Host $host;
|
# make nginx use unescaped URI, keep "%2F" as is
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
rewrite ^ $request_uri;
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
rewrite ^/gitea(/.*) $1 break;
|
||||||
proxy_set_header X-Forwarded-Proto $scheme;
|
proxy_pass http://127.0.0.1:3000$uri;
|
||||||
|
|
||||||
|
# other common HTTP headers, see the "Nginx" config section above
|
||||||
|
proxy_set_header ...
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -132,14 +142,6 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Resolving Error: 413 Request Entity Too Large
|
|
||||||
|
|
||||||
This error indicates nginx is configured to restrict the file upload size.
|
|
||||||
|
|
||||||
In your nginx config file containing your Gitea proxy directive, find the `location { ... }` block for Gitea and add the line
|
|
||||||
`client_max_body_size 16M;` to set this limit to 16 megabytes or any other number of choice.
|
|
||||||
If you use Git LFS, this will also limit the size of the largest file you will be able to push.
|
|
||||||
|
|
||||||
## Apache HTTPD
|
## Apache HTTPD
|
||||||
|
|
||||||
If you want Apache HTTPD to serve your Gitea instance, you can add the following to your Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
|
If you want Apache HTTPD to serve your Gitea instance, you can add the following to your Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
|
||||||
|
@ -387,3 +389,13 @@ gitea:
|
||||||
This config assumes that you are handling HTTPS on the traefik side and using HTTP between Gitea and traefik.
|
This config assumes that you are handling HTTPS on the traefik side and using HTTP between Gitea and traefik.
|
||||||
|
|
||||||
Then you **MUST** set something like `[server] ROOT_URL = http://example.com/gitea/` correctly in your configuration.
|
Then you **MUST** set something like `[server] ROOT_URL = http://example.com/gitea/` correctly in your configuration.
|
||||||
|
|
||||||
|
## General sub-path configuration
|
||||||
|
|
||||||
|
Usually it's not recommended to put Gitea in a sub-path, it's not widely used and may have some issues in rare cases.
|
||||||
|
|
||||||
|
If you really need to do so, to make Gitea works with sub-path (eg: `http://example.com/gitea/`), here are the requirements:
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
Loading…
Reference in a new issue