Skip to content

Strengthen smb backend's PHP smbclient recommendation (#9428) - #14514

Merged
skjnldsv merged 1 commit into
nextcloud:masterfrom
mvanhorn:osc/9428-smb-docs-recommend-php-smbclient
Apr 24, 2026
Merged

Strengthen smb backend's PHP smbclient recommendation (#9428)#14514
skjnldsv merged 1 commit into
nextcloud:masterfrom
mvanhorn:osc/9428-smb-docs-recommend-php-smbclient

Conversation

@mvanhorn

Copy link
Copy Markdown
Contributor

Closes #9428.

The current SMB/CIFS prerequisite note says "PHP smbclient module is preferred, but either will work." The linked upstream report (nextcloud/server#31308) is admins repeatedly running into a 512 MB download cliff on external SMB shares because they did not install the PHP module — `smbclient` alone does not handle that path well. The note as written underplays that.

This PR makes three small improvements to that one note in `admin_manual/configuration_files/external_storage/smb.rst`:

  1. Names the actual package (`php-smbclient` / `libsmbclient-php`) — current text says "the PHP smbclient module" without the install name, so admins have to guess what to apt/yum install.
  2. Explains why the PHP module is preferred. Strengthens "preferred" to "strongly preferred" and notes the concrete failure mode (downloads of files larger than ~512 MB can fail).
  3. Links the upstream issue so an admin who lands on [Bug]: Download file > 512MB from SMB external storage not possible (NC 23.0.2) server#31308 from a search engine can find this advice.

Leaves the second "improved reliability and performance" note further down the page alone — it sits in the configuration-options section and reads fine in that context.

@mvanhorn
mvanhorn force-pushed the osc/9428-smb-docs-recommend-php-smbclient branch from 616504d to 30cb4f4 Compare April 23, 2026 16:26
Updates the prerequisite note in admin_manual/.../smb.rst to:

- name the actual package (php-smbclient / libsmbclient-php) so
  admins know what to apt/yum install;
- explain *why* the PHP module is preferred (without it the backend
  falls back to the smbclient binary, which can fail to download
  files larger than ~512 MB from external SMB shares — the bug
  reported in nextcloud/server#31308);
- link to that upstream issue so admins hitting the failure mode
  can find this advice from the issue tracker.

Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
@skjnldsv
skjnldsv merged commit 0883225 into nextcloud:master Apr 24, 2026
19 of 20 checks passed
@welcome

welcome Bot commented Apr 24, 2026

Copy link
Copy Markdown

Thanks for your first pull request and welcome to the community! Feel free to keep them coming! If you are looking for issues to tackle then have a look at this selection: https://github.com/nextcloud/documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22

@skjnldsv

Copy link
Copy Markdown
Member

Thank you @mvanhorn !

@mvanhorn

Copy link
Copy Markdown
Contributor Author

Thanks for tightening the smbclient recommendation, @skjnldsv.

@github-actions

github-actions Bot commented May 8, 2026

Copy link
Copy Markdown
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

improve the smb docs to recommend the php-smbclient

2 participants