Note
We recommend that you clear your browser cache before doing the setup process. You can find notes and tips on how to do this on different browsers and platforms on this page .
On all platforms you can access the web console by connecting to
the embedded web server on port 8091. For example, if your server
can be identified on your network as servera,
you can access the web console by opening
http://servera:8091/. You can also use an IP
address or, if you are on the same machine,
http://localhost:8091. If you set up Couchbase
Server on another port other than 8091, go to
that port.
Open Couchbase Web Console.
Set the disk storage and cluster configuration.
The Configure Disk Storage option specifies the location of the persistent storage used by Couchbase Server. The setting affects only this node and sets the directory where all the data will be stored on disk. This will also set where the indices created by views will be stored. If you are not indexing data with views you can accept the default setting. For the best performance, you may want to configure two different disks for storing your document and index data.
The Configure Server Memory section sets the amount of physical RAM that will be allocated by Couchbase Server for storage.
If you are creating a new cluster, this is the amount of memory that will be allocated on each node within your Couchbase cluster. The memory for each node in a cluster must be the same amount. You must specify a value that can be supported by all the nodes in your cluster as this setting will apply to the entire cluster.
The default value is 60% of your total free RAM. This figure is designed to allow RAM capacity for use by the operating system caching layer when accessing and using views.
Provide a node IP or hostname under Configure Server Hostname. For more details about using hostnames see Section 2.4, “Using Hostnames with Couchbase Server”.
To join an existing cluster, Click Join a cluster now.
Provide the IP Address or hostname of an existing node, and administrative credentials for that existing cluster.
Click on the name of a sample bucket to load Couchbase Server with sample data. This demonstrates Couchbase Server and help you understand and develop views. If you decide to install sample data, the installer creates one Couchbase bucket for each set of sample data you choose.
For more information on the contents of the sample buckets, see Appendix C, Couchbase Sample Buckets.
Set up a default bucket for Couchbase Server. You can change the bucket settings later. Note that you cannot change the bucket name after you create it.
Best Practice: Default Bucket Should Only for Testing
The default bucket should not be used for storing live application data; you should create a bucket specifically for your application. The default bucket should only be used for testing.
The options are:
Bucket Type
The type of the bucket, either
MemcachedorCouchbase. See Section 1.2.3, “Data Storage” for more information. The remainder of the options differ based on your selection.For
Couchbasebucket type:Memory Size
The amount of available RAM on this server which should be allocated to the bucket.
Replicas
For Couchbase buckets you can enable data replication so that the data is copied to other nodes in a cluster. You can configure up to three replicas per bucket. If you set this to one, you need to have a minimum of two nodes in your cluster and so forth. If a node in a cluster fails, after you perform failover, the replicated data will be made available on a functioning node. This provides continuous cluster operations in spite of machine failure. For more information, see Section 5.5, “Failing Over Nodes”.
You can disable replication by deselecting the Enable checkbox.
To configure replicas, Select a number in Number of replica (backup) copies drop-down list.
To enable replica indexes, Select the Index replicas checkbox. Couchbase Server can also create replicas of indexes. This ensures that indexes do not need to be rebuilt in the event of a node failure. This will increase network load as the index information is replicated along with the data.
Flush
To enable the operation for a bucket, click the Enable checkbox. Enable or disable support for the Flush command, which deletes all the data in an a bucket. The default is for the flush operation to be disabled.
For
Memcachedbucket type:Memory Size
The bucket is configured with a per-node amount of memory. Total bucket memory will change as nodes are added/removed.
For more information, see Section 4.2.1, “RAM Sizing”.
Select Update Notifications, and Couchbase Web Console will communicate with Couchbase nodes and confirm the version numbers of each node. During this process, the client sends the following information to Couchbase Server:
The current version. When a new version of Couchbase Server exists, you get information on where you can download the new version.
Information about the size and configuration of your Couchbase cluster. This information helps us prioritize our development efforts.
Note
As long as you have internet access, the information will be sent. The update notification process provides the information anonymously. Couchbase only uses this information to provide you with updates and information that will help us improve Couchbase Server and related products.
When you provide an email address we will add it to the Couchbase community mailing list, which will provide you with news and update information about Couchbase and related products. You can unsubscribe from the mailing list at any time using the unsubscribe link provided in each email communication.
Enter a username and password. The password must be at least six characters in length. You use these credentials each time you add a new server into the cluster. The are also the same credentials for Couchbase REST API. See, Chapter 8, Using the REST API.
Once you finish this setup, you see Couchbase Web Console with the Cluster Overview page:
Your server is now running and ready to use. After you install your server and finish initial setup you can also optionally configure other settings, such as the port, RAM, using any of the following methods:
Using command-line tools
The command line tools provided with your Couchbase Server installation includes couchbase-cli. This tool provides access to the core functionality of the Couchbase Server by providing a wrapper to the REST API. See cluster initialization.
Using the REST API
Couchbase Server can be configured and controlled using a REST API. In fact, the REST API is the basis for both the command-line tools and Web interface to Couchbase Server.
For more information on using the REST API to provision and setup your node, see Section 8.5.2, “Provisioning a Node”.