Skip to content

docs(config): document file data source upload limits - #383

Open
s5unanow wants to merge 1 commit into
codemie-ai:mainfrom
s5unanow:docs/EPMCDME-13212-file-datasource-upload-limits
Open

docs(config): document file data source upload limits#383
s5unanow wants to merge 1 commit into
codemie-ai:mainfrom
s5unanow:docs/EPMCDME-13212-file-datasource-upload-limits

Conversation

@s5unanow

@s5unanow s5unanow commented Sep 2, 2026

Copy link
Copy Markdown

Summary

Documents the configurable File data source upload limits introduced by EPMCDME-13212 on the CodeMie API Configuration Reference page (/admin/configuration/codemie/api-configuration/). The page previously did not mention the 10-file cap on File data sources at all; the backend now exposes it, together with two related settings, as environment variables.

Changes

  • Added FILE_DATASOURCE_MAX_UPLOAD_COUNT, FILE_DATASOURCE_MAX_UPLOAD_TOTAL_SIZE and FILE_DATASOURCE_UPLOAD_MAX_WORKERS to the General Storage Settings table (defaults, constraints, and when to raise them)
  • Added a "File data source upload limits" info block explaining where the limits are enforced (POST/PUT /v1/index/knowledge_base/file, HTTP 422), the concurrent upload workers, and that the configured count is advertised as fileDatasourceMaxUploadCount in GET /v1/info and picked up by the UI automatically

Testing

  • Tested locally with npm run build (full production build; npm start was not used)
  • All pages render correctly (verified in the built output)
  • Images display properly (no images in this PR)
  • Internal links work (no new links; build runs with onBrokenLinks: 'throw')
  • Sidebar navigation works (no sidebar changes)

Quality Checks

  • npm run check passes (typecheck + lint + commitlint)
  • No MDX compilation errors
  • No raw angle brackets (<text> must be `<text>`)
  • Sidebar references document IDs (not filenames)
  • Images stored locally next to content (not in static/img/)
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

  • Content is derived from the merged implementations of EPMCDME-13212: backend codemie MR !3939 (settings, validators, /v1/info field) and UI codemie-ui MR !1645 (the UI consumes the advertised limit and falls back to 10).
  • Defaults and constraints were verified against src/codemie/configs/config.py on main. The MR description mentions only the file-count setting, but the merged commit also added the combined-size cap and the worker count, so all three are documented together.
  • The user-guide page "Add and Index File DataSource" still lists only per-file size limits and does not mention the file-count limit; that is a separate gap left for a follow-up.

🤖 Generated with Claude Code

https://claude.ai/code/session_01AxXUhubD1gC1UaeABscyQw

Add the three settings introduced by EPMCDME-13212 (codemie MR !3939) to the
File Storage section of the API configuration reference:

- FILE_DATASOURCE_MAX_UPLOAD_COUNT (default 10) replaces the hardcoded
  10-file cap on File data source create and update
- FILE_DATASOURCE_MAX_UPLOAD_TOTAL_SIZE (default 1 GB) caps the combined
  size of one upload request
- FILE_DATASOURCE_UPLOAD_MAX_WORKERS (default 3) controls concurrent file
  writes to storage

Also note that the configured file count is advertised via GET /v1/info
(fileDatasourceMaxUploadCount) and consumed by the UI (codemie-ui MR !1645).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AxXUhubD1gC1UaeABscyQw
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants