Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#16886 closed Bug (fixed)

Memcached socket file usage is undocumented

Reported by: ddbeck Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The Memcached docs do not describe how to use CACHES with Memcached and a Unix socket file. The most Google-able instructions, found in ticket #10168, do not apply the Django 1.3+ method of configuring caches.

Such docs would be particularly useful to users in shared hosting environments, since Memcached does not provide any kind of authentication. With socket file permissions, such users can protect their instance of memcached from unauthorized use.

Attached, you'll find my proposed addition to the docs to make this usage more discoverable.

Attachments (1)

memcached_socket_doc.diff (1.4 KB) - added by ddbeck 4 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 Changed 4 years ago by carljm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Is the double unix: really required for this to work? I know it wasn't with the CACHE_BACKEND setting.

Otherwise (with an added comma to clarify that the unix-path section is separate from the ip:port section) this looks good to me.

Changed 4 years ago by ddbeck

comment:2 Changed 4 years ago by ddbeck

Thank you for the feedback. I tested it without the double unix: and it works appropriately. I updated the patch to remove the double unix: and to add the missing comma.

comment:3 Changed 4 years ago by carljm

  • Triage Stage changed from Accepted to Ready for checkin

Looks great! Thanks for checking that out, and thanks for the contribution!

comment:4 Changed 4 years ago by DrMeers

  • Resolution set to fixed
  • Status changed from new to closed

In [16858]:

Fixed #16886 -- Memcached socket file documentation. Thanks ddbeck for the report and patch.

comment:5 Changed 4 years ago by DrMeers

In [16859]:

[1.3.X] Fixed #16886 -- Memcached socket file documentation. Thanks ddbeck for the report and patch.

Backport of [16858] from trunk.

Note: See TracTickets for help on using tickets.
Back to Top