Skip to content

Commit f158fa8

Browse files
authored
docs: Add APPSMITH_BASE_URL environment variable documentation (#2962)
## Description - Add new Security section to environment-variables.md - Document APPSMITH_BASE_URL for Origin header validation - Explain protection against account takeover attacks - Include configuration options (Admin Settings UI and env var) - Add backward compatibility notes and recommendations This addresses the account takeover vulnerability by documenting the Origin header validation feature for password reset and email verification requests. Related PRs: appsmithorg/appsmith-ee#8448 appsmithorg/appsmith#41426 ## Pull request type Check the appropriate box: - [ ] Review Fixes - [ ] Documentation Overhaul - [ ] Feature/Story - Link one or more Engineering Tickets * - [ ] A-Force - [ ] Error in documentation - [ ] Maintenance ## Documentation tickets Link to one or more documentation tickets: - ## Checklist From the below options, select the ones that are applicable: - [ ] Checked for Grammarly suggestions. - [ ] Adhered to the writing checklist. - [ ] Adhered to the media checklist. - [ ] Verified and updated cross-references or added redirect rules. - [ ] Tested the redirect rules on deploy preview. - [ ] Validated the modifications made to the content on the deploy preview. - [ ] Validated the CSS modifications on different screen sizes.
1 parent a2ddc41 commit f158fa8

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

website/docs/getting-started/setup/environment-variables.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,44 @@ With Appsmith, you can manage user access and authentication methods in your ins
127127
Set to `true` to turn off the default username and password login. Useful for administrators who want to enforce Single Sign-On (SSO) or limit authentication methods for added security and control.
128128
</dd>
129129

130+
### Security
131+
132+
Configure security settings to protect your Appsmith instance against account takeover attacks and ensure secure authentication flows.
133+
134+
##### `APPSMITH_BASE_URL`
135+
136+
<dd>
137+
138+
Specifies the base URL of your Appsmith instance. When configured, this variable enables Origin header validation for password reset and email verification requests, preventing account takeover attacks.
139+
140+
When `APPSMITH_BASE_URL` is set, the system validates that the `Origin` header in password reset and email verification requests matches the configured base URL. Requests with mismatched origins are rejected, preventing attackers from:
141+
142+
- Using arbitrary Origin headers to redirect reset links to malicious domains
143+
- Exploiting the password reset flow to send tokens to attacker-controlled endpoints
144+
- Performing account takeover attacks through email verification redirects
145+
146+
**Configuration:**
147+
148+
You can configure this variable either:
149+
150+
- **Via Admin Settings UI**: Navigate to **Settings → Configuration → Appsmith Base URL**
151+
- **Via environment variable**: Set the `APPSMITH_BASE_URL` environment variable in your configuration file
152+
153+
**Example:**
154+
155+
```yaml
156+
APPSMITH_BASE_URL=https://appsmith.yourdomain.com
157+
```
158+
159+
**Backward compatibility:**
160+
161+
If `APPSMITH_BASE_URL` is not set, the system maintains backward compatibility by skipping validation, ensuring existing deployments continue to function without changes. However, it is strongly recommended to set this variable to enable protection against account takeover attempts.
162+
163+
**Recommendation:**
164+
165+
We strongly recommend setting `APPSMITH_BASE_URL` in your environment configuration to enable this protection. This ensures that sensitive authentication flows are restricted to your trusted domain, significantly reducing the attack surface for account takeover attempts.
166+
167+
</dd>
130168

131169
### Email server
132170

0 commit comments

Comments
 (0)