Getting Started #

# --------------------------------------------------
# Coco Server Docker Deployment Script and Commands
# --------------------------------------------------

# Quick Start Coco Server (using default configuration)
#
# Command Explanation:
#   docker run:       Create and run a new Docker container
#   -d:               Run the container in the background (detached mode)
#   --name cocoserver:  Assign a name to the container (cocoserver)
#   -p 9000:9000:     Map the container's port 9000 to the host's port 9000 (Web UI port)
#   infinilabs/coco:0.2.1-1998:  The Docker image name and tag (version) to use
docker run -d --name cocoserver -p 9000:9000 infinilabs/coco:0.2.1-1998

# Stop and Remove Coco Server Container
#
# Command Explanation:
#   docker stop cocoserver:   Stop the container named cocoserver
#   &&:                     Logical AND operator, ensures the previous command succeeds before executing the next
#   docker rm cocoserver:     Remove the container named cocoserver (only stopped containers can be removed)
docker stop cocoserver && docker rm cocoserver

# Remove Coco Server Docker Image
#
# Command Explanation:
#   docker rmi infinilabs/coco:0.2.1-1998: Remove the image named infinilabs/coco with the tag 0.2.1-1998
#   Note: You can only remove an image if no containers are using it.  If a container is using the image, you must first stop and remove the container.
docker rmi infinilabs/coco:0.2.1-1998

# --------------------------------------------------
# Customized Configuration to Start Coco Server
# (Adjust parameters according to your needs)
# --------------------------------------------------

# Create data and logs directories and set ownership for the Easysearch user (UID/GID 602).
mkdir -p $(pwd)/cocoserver/{data,logs}
sudo chown -R 602:602 $(pwd)/cocoserver

# Command Explanation:
#   docker run:       Create and run a new Docker container
#   -d:               Run the container in the background (detached mode)
#   --name cocoserver:  Assign a name to the container (cocoserver)
#   --hostname coco-server: Set the container's hostname to coco-server
#   --restart unless-stopped:  Set the container's restart policy to "restart unless manually stopped"
#   -m 4g:            Limit the container's memory usage to 4GB
#   --cpus="2":       Limit the number of CPU cores the container can use to 2
#   -p 9000:9000:     Map the container's port 9000 to the host's port 9000 (Web UI port)
#   -v $(pwd)/cocoserver/data:/app/easysearch/data:  Mount the host's ./cocoserver/data directory to the container's /app/easysearch/data directory (for data persistence)
#        - $(pwd) gets the absolute path of the current directory.
#        - Make sure the ./cocoserver/data directory exists. You can create it manually or use the `mkdir -p cocoserver/data` command.
#   -v $(pwd)/cocoserver/logs:/app/easysearch/logs:  Mount the host's ./cocoserver/logs directory to the container's /app/easysearch/logs directory (for storing logs)
#        - Make sure the ./cocoserver/logs directory exists. You can create it manually or use the `mkdir -p cocoserver/logs` command.
#   -e EASYSEARCH_INITIAL_ADMIN_PASSWORD=coco-server: Set the initial password for the Easysearch administrator to coco-server (Important: Change this to a strong password)
#   -e ES_JAVA_OPTS="-Xms2g -Xmx2g":  Set the JVM parameters for Easysearch:
#        - -Xms2g:  Set the initial JVM heap size to 2GB
#        - -Xmx2g:  Set the maximum JVM heap size to 2GB
#   infinilabs/coco:0.2.1-1998: The Docker image name and tag to use

docker run -d \
           --name cocoserver \
           --hostname coco-server \
           --restart unless-stopped \
           -m 4g \
           --cpus="2" \
           -p 9000:9000 \
           -v $(pwd)/cocoserver/data:/app/easysearch/data \
           -v $(pwd)/cocoserver/logs:/app/easysearch/logs \
           -e EASYSEARCH_INITIAL_ADMIN_PASSWORD=coco-server \
           -e ES_JAVA_OPTS="-Xms2g -Xmx2g" \
           infinilabs/coco:0.2.1-1998