-
Notifications
You must be signed in to change notification settings - Fork 224
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Configure File Size Limit (#2543)
## Description Provide a concise summary of the changes made in this pull request - [Added a new document for configuring large files](https://appsmith-docs-git-feat-allow-large-files-co-9bacc2-get-appsmith.vercel.app/getting-started/setup/instance-configuration/file-size-limit) - [updated environment variable doc to add the missing environment variable for configuring file size limit](https://appsmith-docs-git-feat-allow-large-files-co-9bacc2-get-appsmith.vercel.app/getting-started/setup/environment-variables#file-size-limit) - updated Filepicker document to add correct property names - added the file size config under instance configuration ## Pull request type Check the appropriate box: - [ ] Review Fixes - [ ] Documentation Overhaul - [x] 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: - [x] Checked for Grammarly suggestions. - [x] 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.
- Loading branch information
Showing
8 changed files
with
129 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -151,4 +151,4 @@ functionality | |
DigitalOcean | ||
AWS ECS EC2 | ||
Droplet | ||
|
||
Validation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
website/docs/getting-started/setup/instance-configuration/file-size-limit.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Upload File Size Limit | ||
|
||
In self-hosted Appsmith instances, the default file size limit is 150 MB. You can adjust the limit to support larger files. This page explains how to update the file size limit and configure reverse proxies or load balancers, if used, to ensure the new limits are applied. | ||
|
||
## Change file size limit | ||
|
||
To accommodate large files, update the Appsmith instance configuration by setting the `APPSMITH_CODEC_SIZE` environment variable in your deployment configuration. When installed on: | ||
|
||
- **Docker**: Update the `docker.env` file. | ||
- **Kubernetes**: Update the `values.yaml` file. | ||
|
||
For example, to increase the file size limit to 500 MB, use the following configuration: | ||
|
||
```bash | ||
APPSMITH_CODEC_SIZE=500MB | ||
``` | ||
|
||
## Change reverse proxy or load balancer limit | ||
|
||
If your Appsmith instance is behind a reverse proxy or load balancer, you also need to configure the file size limits in the proxy or load balancer settings. Below are example configurations: | ||
|
||
* **Nginx**: Add or update the following directive in your Nginx configuration file. For example, to set a size limit of 500 MB, update the configuration as below: | ||
|
||
```bash | ||
client_max_body_size 500M; | ||
``` | ||
|
||
* **Caddy**: Set the `max_request_body` directive in your Caddy configuration file. For example, to set a size limit of 500 MB, update the configuration as below: | ||
|
||
```bash | ||
max_request_body 500M; | ||
``` | ||
|
||
* **Load balancers**: Configure the `proxy-body-size` or similar directive in your load balancer settings. For example, to set a size limit of 500 MB, update the configuration as below: | ||
|
||
```bash | ||
proxy-body-size 500M; | ||
``` | ||
|
||
## Important considerations | ||
|
||
- Ensure you have configured all relevant components: Appsmith instance, reverse proxy, and load balancer to handle the desired file size limits. | ||
- If you’re using the FilePicker widget, make sure that the limits set for the [Max number of files](/reference/widgets/filepicker#max-no-of-filesnumber) and [Max file size](/reference/widgets/filepicker#max-file-sizenumber) properties fall within the file size limits configured for your Appsmith instance. | ||
|
||
## Troubleshooting | ||
|
||
After updating configurations, review your reverse proxy logs for errors if you encounter any issues. Use the chat widget at the bottom of the page to contact the support team if you need help. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters