A newer version of this documentation is available.

View Latest

Start and Stop Couchbase Server

      +
      Start and stop the Couchbase Server service and application.

      Linux

      On Linux, Couchbase Server is installed as a standalone application with support for running as a background (daemon) process during startup. The startup script is automatically installed when you use any of the packaged releases of Couchbase Server for Linux. By default, Couchbase Server is configured to start automatically at run levels 2, 3, 4, and 5, and explicitly shut down at run levels 0, 1, and 6.

      Start and Stop Couchbase Server
      sudo systemctl start couchbase-server
      sudo systemctl stop couchbase-server

      Legacy Linux

      The instructions in the previous section are meant to be used on modern versions of Linux that use systemd for init processing. For versions of Linux that use SysV for init processing, you need to use the service command for starting and stopping Couchbase Server.

      Start and Stop Couchbase Server (Legacy)
      sudo service couchbase-server start
      sudo service couchbase-server stop

      Windows

      On Windows, Couchbase Server is installed as a Windows service. By default, the Couchbase Server service automatically starts when the system boots.

      You can manage the service using the Windows Services app, the net command, or with Couchbase-supplied batch scripts. You need to be logged into a user account that has administrator privileges, or one that has separately granted rights to manage the Couchbase Server service.

      Start and Stop Couchbase Server with the Windows Services App
      1. Open the Services app.

        You can search for services.msc in Windows to find the app quickly.

      2. Find CouchbaseServer in the list of services and right-click on it.

        Right-Clicking on Couchbase Server service

        You can start and stop the service from this menu, or select menu:[Properties] to configure how the service runs, such as whether it starts at system boot.

        If CouchbaseServer isn’t in the list, then you should attempt to start the service using the batch script method below.
      Start and Stop Couchbase Server with the net Command
      net start CouchbaseServer
      net stop CouchbaseServer
      Start and Stop Couchbase Server with Batch Scripts
      1. In File Explorer, go to C:\Program Files\Couchbase\Server\bin\install\.

        The scripts are named something similar to cb_winsvc_start_<version>.bat.

      2. Right-click on the script that you want to use and select menu:[Run as administrator].

        A User Account Control prompt may ask for your permission to run Windows Command Processor. Click Yes.

        A terminal window will open and display the Couchbase Server startup and shutdown progress. The window will automatically close if the process is successful.

      macOS

      On macOS, Couchbase Server is installed as a standard application that resides in the system Applications folder. Starting and stopping Couchbase Server is controlled by launching and quitting the application.

      • UI

      • Terminal

      Start Couchbase Server

      Go to the Applications folder and double-click on Couchbase Server.app. Couchbase Server runs as a background application, and when it starts, the Couchbase Server icon Couchbase Server menu bar icon will appear in the menu bar.

      Stop Couchbase Server

      Click Couchbase Server menu bar icon and select menu:[Quit Couchbase Server]. The menu bar icon will disappear when Couchbase Server shuts down.

      Start Couchbase Server
      open -a Couchbase\ Server
      Stop Couchbase Server
      osascript -e 'quit app "Couchbase Server"'

      You may receive the following error: 0:27: execution error: Couchbase Server got an error: User canceled. (-128). You can ignore this error.