Name Date Size

..11-Feb-20204 KiB

.gitignoreH A D11-Feb-2020550

cbbrowse_logsH A D11-Feb-2020816

cbcollect_infoH A D11-Feb-202043.9 KiB

CHANGESH A D11-Feb-202036.6 KiB

cluster_connectH A D11-Feb-20205.2 KiB

cluster_runH A D11-Feb-202013.1 KiB

cmake_modules/H11-Feb-20204 KiB

CMakeLists.txtH A D11-Feb-20208.7 KiB

configureH A D11-Feb-20202.2 KiB

couchbase-server.sh.inH A D11-Feb-20205.9 KiB

deps/H11-Feb-20204 KiB

doc/H11-Feb-20204 KiB

etc/H11-Feb-20204 KiB

GNUmakefileH A D11-Feb-20201 KiB

include/H11-Feb-20204 KiB

LICENSEH A D11-Feb-202011.1 KiB

priv/H11-Feb-20204 KiB

README.markdownH A D11-Feb-20202.3 KiB

rebar.config.inH A D11-Feb-2020302

scripts/H11-Feb-20204 KiB

src/H11-Feb-202012 KiB

test/H11-Feb-20204 KiB

README.markdown

1# The Couchbase Server
2
3This application represents the top of the hierarchy of all memcached
4smart services.  It is an application in the Erlang OTP sense.
5
6## Building
7
8Build dependencies include:
9
10* erlang R16B03
11
12Building:
13
14You should use top level make file and repo manifest as explained
15here: https://github.com/membase/manifest/blob/master/README.markdown
16
17## Runtime dependencies
18
19Before you start the server, you may need to do the following
20  * Make sure the needed ports are not being used (these include
21    8091, 11211, 11212, etc).
22
23
24## Running
25
26After building everything via top level makefile you'll have
27`couchbase-server` script in your `$REPO/install/bin` (or other prefix if
28you specified so). You can run this script for normal single node
29startup.
30
31During development it's convenient to have several 'nodes' on your
32machine. There's `./cluster_run` script in root directory for achieving
33that. Feel free to ask `--help`. You normally need something like -n2
34where 2 is number of nodes you want.
35
36It'll start REST API on ports 9000...9000+n. memcached on ports
3712000+2*i and 11999-i and moxi ports on 12001+2*i ports. CAPI (which
38was originally expected to be couch-compatible http API
39implementation) is 9500...9500+n
40
41Note that blank nodes are not configured and need to be setup. I
42suggest trying web UI first to get the feeling of what's
43possible. Just visit REST API port(s) via browser. For development
44mode clusters it's port 9000 and higher. For production mode it's port
458091.
46
47Other alternative is setting up and clustering nodes via REST
48API. couchbase-cli allows that. And you can easily write your own
49script(s).
50
51There's `./cluster_connect` script that eases cluster configuration for
52development clusters. Again, ask `--help`.
53
54Sometimes during debugging/development you want smaller number of
55vbuckets. You can change vbuckets number by setting
56`COUCHBASE_NUM_VBUCKETS` environment variable to desired number of vbuckets
57before creating new couchbase bucket.
58
59### Other tools
60
61Couchbase ships with a bunch of nice tools. Feel free to check
62`$REPO/install/bin` (or `$PREFIX/bin`). One of notable tools is
63`mbstats`. It allows you to query buckets for all kinds of internal
64stats.
65
66Another notable tool is `couchbase-cli`.
67
68* * * * *
69Copyright (c) 2016, Couchbase, Inc.
70