Permalink
Browse files

explain queue names.

  • Loading branch information...
1 parent 733d334 commit d6199a93276a15ec323db57d311a0b8453b3a9f3 Robey Pointer committed Jul 27, 2009
Showing with 6 additions and 0 deletions.
  1. +6 −0 docs/guide.md
View
6 docs/guide.md
@@ -11,6 +11,12 @@ also the filename of that queue's journal file (usually in
binary data. Usually this data is in some serialized format like JSON or
ruby's marshal format.
+Generally queue names should be limited to alphanumerics `[A-Za-z0-9]`, dash
+(`-`) and underline (`_`). In practice, kestrel doesn't enforce any
+restrictions other than the name can't contain slash (`/`) because that can't
+be used in filenames, squiggle (`~`) because it's used for temporary files,
+and dot (`.`) because it's reserved for future use.
+
A cluster of kestrel servers is like a memcache cluster: the servers don't
know about each other, and don't do any cross-communication, so you can add as
many as you like. Clients have a list of all servers in the cluster, and pick

0 comments on commit d6199a9

Please sign in to comment.