Public Repository

Last pushed: 6 months ago
Short Description
IBM Cloudant Developer Edition
Full Description

What is the Cloudant Developer Edition ?

The Cloudant Developer Edition is a fully-featured version of our Cloudant Local product with the following restrictions.

  • Single node instance. No cluster capability
  • Licensed for development purposes only.

Getting Started

Download and install Docker. We require version 1.11 or above. Please see the Docker installation documentation for details on how to upgrade your Docker daemon.

Once Docker is installed, download the image from Docker Hub.

docker pull ibmcom/cloudant-developer

Starting the Cloudant Developer Edition Container

To start the container, run the following:

docker run \
       --privileged \
       --detach \
       --volume cloudant:/srv \
       --name cloudant-developer \
       --publish 8080:80 \
       --hostname \

End User License

Before initializing the data volume, you need to view/accept the End User License. This is required the first time the container is started or if the volume is reinitialized. To do this, run the following:

docker exec -ti cloudant-developer cast license --console

Cloudant Data Volume

A named data volume is used to persist the cloudant database and index files. This volume needs to be initialized the first time you run the container or if you should delete the volume. To do this, run the following:

docker exec cloudant-developer cast database init -v -y -p pass

Cloudant Dashboard

To access to the cloudant dashboard, enter the following URL http://localhost:8080/dashboard.html in your browser. The default login credentials are:

  • username = admin
  • password = pass

Note: If you are running docker on Mac OS X or Windows where docker is run within a virtual machine, you would replace the localhost in the URL with the Docker virtual machines IP address.

Additional Information

Cloudant Support is not available for this offering. For additional information on using the Cloudant API, see the online documentation. For technical issues, post your question on StackOverflow with the tag "cloudant".


The Dockerfile and associated scripts are licensed under the Apache License 2.0. Cloudant-developer is licensed under the IBM International License Agreement for Non-Warranted Programs. This license for Cloudant Developer can be found online. Note that this license does not permit further distribution.

Frequently Asked Questions (FAQs)

Q1. I'm running Docker on a Mac or Windows via VirtualBox. How do I find the IP address of the Docker virtual machine ?
A1. Run the following command from a terminal window.

docker-machine ls

Q2. When I try launching the dashboard via my browser, I get a partial screen with no login prompts.
A2. You most likely have not initialized the data volume the first time.

Q3. How would I run the container on a different port ?
A3. Change the value of the docker run --publish option. For example, if we want to run on port 80, the option to the docker run command would be --publish 80:80 .

Docker Pull Command

Comments (11)
a month ago

3 months ago

The dashboard problem on my windows box is fixed after editing one of the file inside the container.
Instructions :

  1. docker exec -i -t cloudant-developer /bin/bash
  2. vi /etc/haproxy/haproxy.cfg
  3. replace this line "server check inter 7s" to "server check inter 7s"
  4. save and exit from container shell
  5. stop and restart container. (docker stop cloudant-developer , docker start cloudant-developer)
3 months ago

Hi, I installed cloudant on my docker toolbox virtual machine and my dashboard does not do anything. I did run all the instructions listed in this document. Can any one got into this problem.?

4 months ago

Re booted my system. Starting docker terminal. Started ibmcom/cloudant-developer by using container id. Command "docker exec -ti cloudant-developer cast license --console" executed successfully

4 months ago

while running command "docker exec -ti cloudant-developer cast license --console" I m getting error like -rpc error: code = 2 desc = containerd: container did not start before the specified timeout
I verified my docker version its - 1.12.0
Due to this I m unable to initialize the Cloudant Data Volume and unable to proceed further. what could be the issue

5 months ago

I solved the 503 errors in the dashboard. The problem was in /etc/haproxy/haproxy.cfg with the server definition for the dbfarm which is "hardcoded" to "server check inter 7s" in the image it seems. Changing it to "server localhost check inter 7s" solved the problem.

7 months ago

The dashboard.html does not load properly, throwing lot's of 503 errors, so the image is unusable.

7 months ago

1.0.1 throws a lot of 503's and won't properly load the Dashboard. 1.0.0 appears to work. docker history shows a second /usr/sbin/init added about two weeks ago.

7 months ago

Is it possible to run this container via Docker Compose???
When I access http://localhost:5983, which is the port that I've attached to cloudant-developer, it shows a 503 error.

Here follows my docker-compose.json.

version: '2'
    build: ./servers/nodejs
      - "3000:3000"
      - ./servers/nodejs:/var/www/app/current
      - cloudant

      context: ./servers/cloudant/
      - "5983:80"
    privileged: true
      - ./servers/data/cloudant-data:/srv/cloudant

I did run the cast commands, but it keeps showing the 503 error anyways.

8 months ago

Sorry for my previous comment. My docker version was too old(1.7). I have configured it with 1.11, and now I can successfully run cloudant-developer on my local machine. Thanks.