To setup a new Couchbase Server you have a number of different solutions available. All of the solutions require you to set the username and password. You can also optionally configure other settings, such as the port, RAM configuration, and the data file location, as well as creating the first bucket by using any of the following methods:
Using command-line tools
The command line toolset provided with your Couchbase Server installation includes couchbase-cli. This command provides access to the core functionality of the Couchbase Server by providing a wrapper to the REST API. See cluster initialization for more information.
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.8, “Provisioning a Node”.
Using Web Setup
You can use the web browser setup to configure the Couchbase Server installation, including setting the memory settings, disk locations, and existing cluster configuration. You will also be asked to create a password to be used when logging in and administering your server.
The remainder of this section will provide you with information on using this method.
We recommend that you clear your browser cache before starting the setup process. You can find notes and tips on how to do this on different browsers and platforms on this page.
To start the configuration and setup process, you should open the
Couchbase Web Console. On Windows this is opened for you
automatically. 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
http://servera:8091/ . You can also use
an IP address or, if you are on the same machine,
Once you have opened the web console for the first time immediately after installation you will be prompted with the screen shown below.
Click thebutton to start the setup process.
First, you must set the disk storage and cluster configuration.
Configure Disk Storage
The Configure Disk Storage option specifies the location of the persistent (on-disk) storage used by Couchbase Server. The setting affects only this server and sets the directory where all the data will be stored on disk.
Join Cluster/Start New Cluster
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, you specify the memory that will be allocated on each node within your Couchbase cluster. You must specify a value that will be supported on all the nodes in your cluster as this is a global setting.
If you want to join an existing cluster, select the radio button. This will change the display and prompt the IP address of an existing node, and the username and password of an administrator with rights to access the cluster.
Clickto continue the installation process.
Couchbase Server stores information in buckets. You should set up a default bucket for Couchbase Server to start with. You can change and alter the bucket configuration at any time.
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:
Specifies the type of the bucket to be created, either
Couchbase . See
Section 1.3.4, “Buckets”
for more information.
The remainder of the options differ based on your selection.
When selecting the
This option specifies the amount of available RAM configured on this server which should be allocated to the default bucket.
For Couchbase buckets you can enable replication to support multiple replicas of the default bucket across the servers within the cluster. You can configure up to three replicas. Each replica receives copies of all the documents that are managed by the bucket. If the host machine for a bucket fails, a replica can be promoted to take its place, providing continuous (high-availability) cluster operations in spite of machine failure.
You can disable replication by setting the number of replica copies to zero (0).
When selecting the
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 1.3.3, “Memory Quotas” .
Clickto continue the setup process.
You can optionally enable the notification system within the Couchbase Web Console.
If you select the Update Notifications option, the Web Console will communicate with Couchbase servers to confirm the version number of your Couchbase installation. During this process, the client submits the following information to the Couchbase Server:
The current version of your Couchbase Server installation. When a new version of Couchbase Server becomes available, you will be provided with notification of the new version and information on where you can download the new version.
Basic information about the size and configuration of your Couchbase cluster. This information will be used to help us prioritize our development efforts.
The process occurs within the browser accessing the web console, not within the server itself, and no further configuration or internet access is required on the server to enable this functionality. Providing the client accessing the Couchbase Server console has internet access, the information can be communicated to the Couchbase Servers.
The update notification process provides the information anonymously, and the data cannot be tracked. The information is only used to provide you with update notifications and to provide information that will help us improve the future development process for Couchbase Server and related products.
You can also register your product from within the setup process.
Supplying your email address will add you 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.
Clickto continue the setup process.
The final step in the setup process is to configure the username and password for the administrator of the server. If you create a new cluster then this information will be used to authenticate each new server into the cluster. The same credentials are also used when using the Couchbase Management REST API. Enter a username and password. The password must be at least six characters in length.
Clickto complete the process.
Once the setup process has been completed, you will be presented with the Couchbase Web Console showing the Cluster Overview page.
Your Couchbase Server is now running and ready to use.