Name Date Size

..11-Feb-20204 KiB

.gitignoreH A D11-Feb-2020748

bucket_engine.cH A D11-Feb-202091 KiB

bucket_engine.hH A D11-Feb-2020867

bucket_engine.specH A D11-Feb-20201 KiB

bucket_engine_internal.hH A D11-Feb-20204.4 KiB

config/H11-Feb-20204 KiB

configure.acH A D11-Feb-20202.5 KiB

COPYINGH A D11-Feb-20201.1 KiB

docs/H11-Feb-20204 KiB

genhash.cH A D11-Feb-20207.7 KiB

genhash.hH A D11-Feb-20206.1 KiB

genhash_int.hH A D11-Feb-2020416

m4/H11-Feb-20204 KiB

Makefile.amH A D11-Feb-20201 KiB

management/H11-Feb-20204 KiB

mock_engine.cH A D11-Feb-202018.8 KiB

python_wrapper.inH A D11-Feb-2020221

README.markdownH A D11-Feb-20202.1 KiB

testapp.cH A D11-Feb-202063.6 KiB

topkeys.cH A D11-Feb-20204.8 KiB

topkeys.hH A D11-Feb-20202.4 KiB

win32/H11-Feb-20204 KiB

README.markdown

1# Bucket Engine
2
3This memcached engine provides multi-tenancy and isolation between
4other memcached engine instances.
5
6It is designed to have minimal overhead while providing few
7constraints of its own.
8
9That said, the ACL facilities are currently very limited and thus
10require SASL support and two security levels (admin, and everybody
11else).
12
13## Building
14
15You will need a storage-engine capable memcached and its included
16headers. In addition to that you'll need some type definitions from
17ep-engine.
18
19The easiest way to build bucket_engine is to use repo:
20
21For example, assume you keep all of your projects in `~/prog/`, you
22can do this:
23
24    cd ~/prog/couchbase
25    repo init -u git://github.com/membase/manifest.git -m branch-2.0.xml
26    gmake make-install-bucket_engine
27
28## Running
29
30An example invocation using the bucket engine from your dev tree
31allowing every connecting user to automatically have his own isolated
32namespace within the default engine is as follows:
33
34    ~/prog/couchbase/memcached/memcached -v -S \
35        -E ~/prog/couchbase/bucket_engine/.libs/bucket_engine.so \
36        -e engine=$HOME/prog/couchbase/memcached/.libs/default_engine.so
37
38## Configuration
39
40The following configuration options are available for this engine.
41
42### admin
43
44An administrative user can be specified using the `admin` parameter.
45
46This is the SASL authenticated user permitted to execute
47administrative commands (see scripts in the [management][management]
48directory for examples).
49
50### auto\_create
51
52With `auto-create` enabled, buckets are created automatically when
53users first attempt to use them.
54
55### default
56
57If true, a default bucket exists for unauthenticated users, or users
58who don't have buckets created for them when `auto_create` is disabled.
59
60### default\_bucket\_config
61
62The "default_bucket_config" parameter specifies a parameter to
63send to the default engine (ex: default_bucket_engine=tap_keepalive=500).
64
65### engine
66
67The contained engine is configured using the `engine` parameter (see
68the example above).
69
70[management]: http://github.com/northscale/bucket_engine/tree/master/management/
71