diff --git a/docs/my-website/docs/proxy/config_settings.md b/docs/my-website/docs/proxy/config_settings.md index 5db76088fa..6660ed3b71 100644 --- a/docs/my-website/docs/proxy/config_settings.md +++ b/docs/my-website/docs/proxy/config_settings.md @@ -434,9 +434,9 @@ router_settings: | DOCS_URL | The path to the Swagger API documentation. **By default this is "/"** | EMAIL_LOGO_URL | URL for the logo used in emails | EMAIL_SUPPORT_CONTACT | Support contact email address -| EMAIL_SIGNATURE | Custom signature for emails -| EMAIL_SUBJECT_INVITATION | Custom subject template for invitation emails -| EMAIL_SUBJECT_KEY_CREATED | Custom subject template for key creation emails +| EMAIL_SIGNATURE | Custom HTML footer/signature for all emails. Can include HTML tags for formatting and links. +| EMAIL_SUBJECT_INVITATION | Custom subject template for invitation emails. +| EMAIL_SUBJECT_KEY_CREATED | Custom subject template for key creation emails. | EXPERIMENTAL_MULTI_INSTANCE_RATE_LIMITING | Flag to enable new multi-instance rate limiting. **Default is False** | FIREWORKS_AI_4_B | Size parameter for Fireworks AI 4B model. Default is 4 | FIREWORKS_AI_16_B | Size parameter for Fireworks AI 16B model. Default is 16 diff --git a/docs/my-website/docs/proxy/email.md b/docs/my-website/docs/proxy/email.md index 5d5a07b156..0102e6aed5 100644 --- a/docs/my-website/docs/proxy/email.md +++ b/docs/my-website/docs/proxy/email.md @@ -124,9 +124,7 @@ On the Create Key Modal, Select Advanced Settings > Set Send Email to True. /> - - -## Customizing Email Branding +## Email Customization :::info @@ -140,14 +138,61 @@ LiteLLM allows you to customize: - Email signature - Email subject lines for different events -Set the following in your env to customize your emails: +## Environment Variables -```shell -EMAIL_LOGO_URL="https://litellm-listing.s3.amazonaws.com/litellm_logo.png" # public url to your logo -EMAIL_SUPPORT_CONTACT="support@berri.ai" # Your company support email -EMAIL_SIGNATURE="Best regards,\nYour Company Team" # Custom email signature -EMAIL_SUBJECT_INVITATION="Welcome to {company_name}!" # Subject for invitation emails -EMAIL_SUBJECT_KEY_CREATED="Your API Key for {company_name}" # Subject for key creation emails +You can customize the following aspects of emails through environment variables: + +```bash +# Email Branding +EMAIL_LOGO_URL="https://your-company.com/logo.png" # Custom logo URL +EMAIL_SUPPORT_CONTACT="support@your-company.com" # Support contact email +EMAIL_SIGNATURE="

Best regards,
Your Company Team

Visit our website

" # Custom HTML footer/signature + +# Email Subject Lines +EMAIL_SUBJECT_INVITATION="Welcome to Your Company!" # Subject for invitation emails +EMAIL_SUBJECT_KEY_CREATED="Your API Key is Ready" # Subject for key creation emails ``` -If custom subject templates are not provided, the system will use default templates in the format "LiteLLM: {event_message}". +## HTML Support in Email Signature + +The `EMAIL_SIGNATURE` environment variable supports HTML formatting, allowing you to create rich, branded email footers. You can include: + +- Text formatting (bold, italic, etc.) +- Line breaks using `
` +- Links using `` +- Paragraphs using `

` +- Company information and social media links +- Legal disclaimers or terms of service links + +Example HTML signature: +```html +

Best regards,
The LiteLLM Team

+

+ Documentation | + GitHub +

+

+ This is an automated message from LiteLLM Proxy +

+``` + +## Default Templates + +If environment variables are not set, LiteLLM will use default templates: + +- Default logo: LiteLLM logo +- Default support contact: support@berri.ai +- Default signature: Standard LiteLLM footer +- Default subjects: "LiteLLM: \{event_message\}" (replaced with actual event message) + +## Template Variables + +When setting custom email subjects, you can use template variables that will be replaced with actual values: + +```bash +# Examples of template variable usage +EMAIL_SUBJECT_INVITATION="Welcome to \{company_name\}!" +EMAIL_SUBJECT_KEY_CREATED="Your \{company_name\} API Key" +``` + +The system will automatically replace `\{event_message\}` and other template variables with their actual values when sending emails.