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 nature9/syncloop

Run the Community Version (Optional)

If you wish to run the Community Edition, use:

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

Explanation:

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** or **nature9/syncloop-community.**

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
    ports:
      - "8080:8080"
    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

Run on AWS ECS

Developers can also deploy a docker container to the AWS ECS service from their local command tool. To do this read more in detail about how docker offers integration with AWS ECS.

To run Syncloop on AWS ECS follow these easy steps:

CS Architecture Diagram

• Create an IAM user with the following permissions
  • ec2:AuthorizeSecurityGroupIngress
  • application-autoscaling:*
  • elasticfilesystem:*
  • route53:GetHostedZone
  • logs:*
  • route53:GetHealthCheck
  • iam:CreateRole
  • iam:AttachRolePolicy
  • iam:PutRolePolicy
  • route53:ListHostedZonesByName
  • ecs:DeregisterTaskDefinition
  • servicediscovery:*
  • ecs:UpdateService
  • iam:GetRole
  • iam:PassRole
  • ecs:CreateService
  • iam:DetachRolePolicy
  • ec2:CreateSecurityGroup
  • ecs:ListTasks
  • iam:DeleteRolePolicy
  • ecs:RegisterTaskDefinition
  • ecs:DescribeServices
  • route53:DeleteHostedZone
  • logs:FilterLogEvents
  • ec2:DescribeRouteTables
  • ecs:DescribeTasks
  • route53:CreateHostedZone
  • logs:DescribeLogGroups
  • logs:DeleteLogGroup
  • ec2:CreateTags
  • ecs:CreateCluster
  • ecs:DeleteService
  • ecs:DeleteCluster
  • cloudformation:*
  • iam:DeleteRole
  • elasticloadbalancing:*
  • logs:CreateLogGroup
  • ec2:DescribeSecurityGroups
  • ecs:DescribeClusters
  • ec2:RevokeSecurityGroupIngress
  • ecs:ListAccountSettings
  • ec2:DescribeVpcs
  • ec2:DeleteSecurityGroup
  • ec2:DescribeSubnets
• Create aws ecs context by using command
  

  docker context create ecs Syncloop-platform

  Copy
• Select the created context
  

  version: '2.1'
      services:
        syncloop:
          image: nature9/syncloop
          environment:
            - LOGGING_FILE=/logs/server.log
          ports:
            - "8080:8080"
          deploy:
            resources:
              limits:
                cpus: '0.5'
                memory: 1024M
            x-aws-autoscaling:
              min: 1
              max: 10 #required
              cpu: 75
  
          volumes:
            - eka_vol:/eka
  
      volumes:
        eka_vol:
      #    external: true
      #    name: fs-0d1781ddc5d739570
  
      x-aws-cloudformation:
        Resources:
          SyncloopTCP80TargetGroup:
            Properties:
              HealthCheckPath: /tenant/default/files/gui/middleware/pub/server/ui/welcome/onboarding/login.html
              Matcher:
                HttpCode: 200-499
          SyncloopTCP80Listener:
            Properties:
              Certificates:
                - CertificateArn: "arn:aws:acm:ap-south-1:776625503031:certificate/7a2b32cd-e894-4afd-b212-26f91ad31ce9"
              Protocol: HTTPS
              Port: 443
          Default80Ingress:
            Properties:
              FromPort: 443
              ToPort: 443

  Copy Download file

Deploy docker compose on ecs cluster.

docker compose up

• When the above command is successful. Go to aws ec2 load balancer.
• Select the newly created aws elb and option the DNS name in the browser.
• Syncloop will support both http & https. Read the docker ecs document to use your SSL certificate.