forgejo/docs/content/doc/usage/https-support.md

date	title	slug	weight	toc	draft	menu
2018-06-02T11:00:00+02:00	Usage: HTTPS setup	https-setup	12	true	false	sidebar parent name weight identifier usage HTTPS setup 12 https-setup

HTTPS setup to encrypt connections to Gitea

Using the built-in server

Before you enable HTTPS, make sure that you have valid SSL/TLS certificates. You could use self-generated certificates for evaluation and testing. Please run gitea cert --host [HOST] to generate a self signed certificate.

To use Gitea's built-in HTTPS support, you must change your app.ini file:

[server]
PROTOCOL=https
ROOT_URL = `https://git.example.com:3000/`
HTTP_PORT = 3000
CERT_FILE = cert.pem
KEY_FILE = key.pem

To learn more about the config values, please checkout the Config Cheat Sheet.

Setting up HTTP redirection

The Gitea server is only able to listen to one port; to redirect HTTP requests to the HTTPS port, you will need to enable the HTTP redirection service:

[server]
REDIRECT_OTHER_PORT = true
; Port the redirection service should listen on
PORT_TO_REDIRECT = 3080

If you are using Docker, make sure that this port is configured in your docker-compose.yml file.

Using Let's Encrypt

Let's Encrypt is a Certificate Authority that allows you to automatically request and renew SSL/TLS certificates. In addition to starting Gitea on your configured port, to request HTTPS certificates, Gitea will also need to listed on port 80, and will set up an autoredirect to HTTPS for you. Let's Encrypt will need to be able to access Gitea via the Internet to verify your ownership of the domain.

By using Let's Encrypt you must consent to their terms of service.

[server]
PROTOCOL=https
DOMAIN=git.example.com
ENABLE_LETSENCRYPT=true
LETSENCRYPT_ACCEPTTOS=true
LETSENCRYPT_DIRECTORY=https
LETSENCRYPT_EMAIL=email@example.com

To learn more about the config values, please checkout the Config Cheat Sheet.

Using reverse proxy

Setup up your reverse proxy as shown in the reverse proxy guide.

After that, enable HTTPS by following one of these guides:

• nginx
• apache2/httpd
• caddy

Note: Your connection between your reverse proxy and Gitea might be unencrypted. To encrypt it too, follow the built-in server guide and change the proxy url to https://[URL].