SMB
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 7.4k
- Forks
- 1.9k
- PR merge metrics
- No merged PRs in 30d
Description
Documentation
There are inconsistencies between the SMB and FULL examples examples:
- https://github.com/nextcloud/docker/tree/master/.examples/dockerfiles/smb
- https://github.com/nextcloud/docker/tree/master/.examples/dockerfiles/full
The former appears to be out-dated while the latter appears to better match the PHP image's recommended approach.
Some problems have been reported by others trying to use the SMB examples - e.g.
- https://github.com/nextcloud/server/issues/41114#issuecomment-1779285006 (this Issue isn't specific to the Docker image, but some of the comments in it highlight challenges noted by users trying to utilize the examples from here)
- https://github.com/nextcloud/docker/issues/1638
- https://github.com/icewind1991/SMB/issues/109#issuecomment-1249150031
Tasks (preliminary):
- Review PHP image's recommended approach for adding things
- Assess whether our FULL example follows the PHP image model and otherwise seems reasonable
- Confirm native rather than wrapped SMB mode is detected/used by External Storage
- Test FULL example against a "typical" SMB server
- Port tested FULL example to SMB only example
Out of scope but worth mentioning:
- Upstream docs in this area could probably use some clarity (and I don't mean specific to Docker)
Image
Worth a revisit of whether to include/why we're not including smbclient in the image by default
Context:
- Community snap does not contain smbclient even though requested for years
- Community snap recommends using SMB/CIFS FUSE + Local mount
- SMB/CIFS FUSE is another option (possibly even preferred)
- Official Nextcloud GmbH AIO does contain smbclient
Tasks
- ... TBD
- If not including, document why as a FAQ/Known Issue in the README
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing .examples/dockerfiles/smb with .examples/dockerfiles/full and reviewing the PHP image's recommended approach for adding components. Test the FULL example against a typical SMB server, confirm native SMB mode is detected by External Storage, and then assess whether the SMB-only example and README explain the resulting approach and smbclient decision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, php
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100