A newer version of this documentation is available.

View Latest

Initial server setup using UI

To set up Couchbase Server after installation use the Couchbase Web Console, CLI, or REST API.

Open Couchbase Web Console and click on Setup.

Step 1: Configure Server

setup 01
  1. Configure Disk Storage

    • Database Path: Shows the default location where the database files will be stored:

      /Users/user_name/Library/Application Support/Couchbase/var/lib/couchbase/data.

      and points to the current amount of free space for this location.

    • Indices Path: Shows the default locations where indices will be stored:

      /Users/user_name/Library/Application Support/Couchbase/var/lib/couchbase/data

      and points to the current amount of free space for this location.

    For the production environment, it is recommended to use different file locations.
  2. Configure Server Hostname.

    • Provide a node IP or a hostname. The provided hostname survives node restart.

      For more details about hostnames, see Using hostnames.

  3. Join Cluster/Start new Cluster The Configure Server Memory section sets the amount of physical RAM that will be allocated by the Couchbase Server for storage.

    If you are creating a new cluster, this is the amount of memory that is allocated on each node within your Couchbase Server cluster. The same amount of memory is allocated to each node in the cluster. Since the same setting applies to the whole cluster, specify a value that can be supported by all nodes. The default value is 60% of your total free RAM and is calculated to provide a RAM capacity for use by the operating system caching layer when accessing and using views.

    • Start a new cluster

      If you select this option, the following setup fields will be displayed:

      • RAM Available

      • Services: Select one of the service types for the production environment; select one to three service types for the development environment.

      • Data RAM Quota: 256 MB or more.

      • Index RAM Quota: 256 MB or more.

      • Total Per Server: RAM quota per server represents total RAM used by the data and index services.

    • Join a cluster now:

      If you select this option, the following setup fields will be displayed:

      • The IP address of the cluster you are joining.

      • The username of the Couchbase Server administrator who is managing this cluster.

      • The password of the Couchbase Server administrator who is managing this cluster.

      • Services: Select one of the service types for the production environment; select one to three service types for the development environment.

  4. Click Next.

Step 2:

A screen appears where you can select the sample data buckets you want to load.

setup 02
  1. Click the names of sample buckets to load to the Couchbase Server. These data sets demonstrate Couchbase Server’s features 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.

  2. Click Next.

Step 3: Create default bucket

setup 03

For the default bucket, you can configure the following:

Bucket Settings

Bucket Name: The name of the Default bucket is pre-set.

Bucket Type: Couchbase (preset) or Memcached

Memory Size

Per Node RAM Quota

Total bucket size

Cache Metadata: Value Ejection (preset) or Full Ejection

Replicas

Enable (preset): select the number of replica backup copies.

View index replicas

Disk I/O Optimization

Set the bucket disk I/O priority: Low (the default) or High.

Flush

Enable

  • Click Next.

Step 4: Notifications

setup 04
Update Notifications

Select Update Notifications. The Couchbase Web Console communicates with Couchbase Server nodes and confirms the version numbers of each node.

As long as you have Internet access this information will be sent anonymously to Couchbase corporate, which uses this information only to provide you with updates and information to help improve Couchbase Server and related products. When you provide an email address, it is added to the Couchbase community mailing list for news and update information about Couchbase Server and related products. You can unsubscribe from the mailing list at any time using the Unsubscribe link provided in each newsletter.

Product Registration

Register your product with your information.

Step 5: Configure server

setup 05 To secure the server, you must create an administrative account and then use these credentials to join other servers and form a cluster.

  1. Provide the administrative credentials: username and password

  2. Click Next.

Couchbase Server is now running and ready to use.

  1. The starting screen for the new Couchbase Server will appear.

    setup 06

    Check the installation for example, whether you have properly installed the travel-sample application under Data buckets.

    setup 07