Claudify

gitea/README.md

@@ -30,16 +30,37 @@ This addon is based on the [docker image](https://hub.docker.com/r/gitea/gitea).
 
 ## Configuration
 
+Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
+Configurations can be done through the app webUI, except for the following options.
+
+### Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `ssl` | bool | `false` | Enable HTTPS for the web interface |
+| `certfile` | str | `fullchain.pem` | SSL certificate file (must be located in /ssl) |
+| `keyfile` | str | `privkey.pem` | SSL key file (must be located in /ssl) |
+| `APP_NAME` | str | | Name of the Gitea application |
+| `DOMAIN` | str | | Domain to be reached (default: homeassistant.local) |
+| `ROOT_URL` | str | | Customize root URL (for specific routing needs) |
+
+### Example Configuration
+
 ```yaml
-certfile: fullchain.pem #ssl certificate, must be located in /ssl
-keyfile: privkey.pem #sslkeyfile, must be located in /ssl
-ssl: should the app use https or not
-APP_NAME: name of the app
-DOMAIN: domain to be reached # default : homeassistant.local
-ROOT_URL: customize root_url, should not be needed unless specific needs
+ssl: false
+certfile: "fullchain.pem"
+keyfile: "privkey.pem"
+APP_NAME: "Gitea for Homeassistant"
+DOMAIN: "homeassistant.local"
+ROOT_URL: "http://homeassistant.local:3000"
 ```
 
-Webui can be found at `<your-ip>:port`.
+### Custom Scripts and Environment Variables
+
+This addon supports custom scripts and environment variables:
+
+- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
+- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
 
 ## Installation