Syncloop Deployment & Hosting

Docker • Private Cloud • ACS — build, test, and scale anywhere.

Prerequisites

Before running Syncloop on Docker, ensure the following

Docker Installation

• Install Docker CLI on your system.
  • Get Docker
• Network Access
  • Docker images are pulled from a centralized public repository.
  • Ensure that your system allows outbound network access to Docker Hub.

Docker Images

Syncloop provides two Docker image variants:

Run on Docker CLI

Run the Enterprise Version

Execute the following command in your terminal or command prompt:

docker run -d -p 8080:8080 -p 80:80 nature9/syncloop

Explanation:

Run on custom ports

Syncloop supports configuring server ports via environment variables inside the container:

When you change these container-side ports, you must map a host port to the same container port using -p.

Example: Map host ports 80 and 443 to the container (HTTP + HTTPS)

docker run -d \
  -e SERVER_PORT=80 \
  -e WEB_PORT=8080 \
  -e SECURE_SERVER_PORT=8443 \
  -p 80:80 -p 443:443 -p 8080:8080 \
  nature9/syncloop

Verify Syncloop is Running

After running the command, verify that the container is active:

docker ps

You should see a running container with the image name **nature9/syncloop**

Run Syncloop Using the Browser

Once the container is up and running:

1. Open a web browser on your local machine.
2. Navigate to the following URL:

http://localhost:8080

Copy
3. You will be greeted with the Syncloop Web Interface (login or setup screen). From here, you can:
   • Log in to the Syncloop dashboard.
   • Create and manage APIs.
   • Configure agents and workflows.
   • Access system health and runtime metrics.

If you are running Syncloop on a remote server, replace localhost with the server’s IP address or domain name, for example:

http://<your-server-ip>:8080

Container Management Commands

1. View Running Containers

   docker ps

   Copy

2. Stop Syncloop

   docker stop 

   Copy

3. Restart Syncloop

   docker start 

   Copy

4. Remove the Container

   docker rm 

   Copy

Next Steps

• To configure your environment, users, and API endpoints, visit the Syncloop Configuration Guide.
• For persistent storage, environment variable setup, or connecting external databases, refer to the Advanced Docker Setup Guide.
• To access Syncloop’s API endpoints directly, you can use any REST client (e.g., Postman) with base URL:

http://localhost:8080/api/

Run Docker Compose

You can deploy and manage multi-container applications defined in the compose file. Create a file called docker-compose.YAML and add the following content:

version: '2.1'
services:
  syncloop:
    image: nature9/syncloop
    environment:
      
LOGGING_FILE=/logs/server.log
WEB_PORT=80
SERVER_PORT=8080
SECURE_SERVER_PORT=8443
ports:
"8080:8080"
"8443:8443"
"80:80"
volumes:
eka_vol:/eka

volumes:
  eka_vol:api/

Environmental variables:

**LOGGING_FILE:** This sets the path where Syncloop will save its log file. By default, it's set to /logs/server.log.

Use the following command to run docker.

docker compose up

Workspace default credentials

The default username and password for the workspace are:

Troubleshooting Syncloop on Docker

Common Errors and Fixes