Simoob Documentation

Simoob is a lightweight, real-time server and container monitoring solution. This documentation will guide you through installation, configuration, and usage of the Simoob monitoring platform.

1. System Requirements #

Before installing Simoob, ensure your system meets the following requirements:

2. Quick Start #

Get Simoob up and running in under 5 minutes with these steps:

Step 1: Pull the Docker Image

Download the latest Simoob agent image from Docker Hub:

docker pull gayanpd/simoob Copy

Step 2: Run the Container

Start the Simoob agent with the following command:

docker run -d \
  --name simoob-agent \
  --restart unless-stopped \
  -p 3001:3001 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  gayanpd/simoob Copy

Step 3: Clone the UI

Clone the Simoob user interface repository:

git clone https://github.com/Gayan-98/simoob-ui.git
cd simoob-ui Copy

Step 4: Open the Dashboard

Open index.html in your web browser and enter your server details:

• Server IP: Your server's IP address (e.g., 139.59.248.175)
• Port: 3001

3. Installing the Agent #

The Simoob agent runs as a Docker container and provides a REST API for monitoring system metrics, Docker containers, and services.

3.1. Pulling the Image

Pull the official Simoob agent image:

docker pull gayanpd/simoob Copy

Verify the image was downloaded successfully:

docker images | grep simoob Copy

3.2. Running the Container

Start the agent with the recommended configuration:

docker run -d \
  --name simoob-agent \
  --restart unless-stopped \
  -p 3001:3001 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  gayanpd/simoob Copy

Command Options Explained:

3.3. Verifying the Installation

Check that the container is running:

docker ps | grep simoob-agent Copy

Test the API endpoint:

curl http://localhost:3001/api/system/stats Copy

You should receive a JSON response with system statistics.

4. Setting Up the User Interface #

The Simoob UI is a static web application that connects to the agent API to display real-time monitoring data.

4.1. Clone the Repository

Clone the UI repository to your local machine:

git clone https://github.com/Gayan-98/simoob-ui.git Copy

4.2. Opening the Dashboard

Navigate to the cloned directory:

cd simoob-ui Copy

You have two options to run the dashboard:

Option A: Open Directly

Open index.html in your web browser:

# macOS
open index.html

# Windows
start index.html

# Linux
xdg-open index.html Copy

Option B: Use HTTP Server (Recommended)

Serve the UI through a local HTTP server to avoid CORS issues:

python3 -m http.server 8080 Copy

Then navigate to http://localhost:8080 in your browser.

4.3. Connecting to Your Server

Once the dashboard loads:

1. Enter your server's IP address in the Server IP field
2. Enter 3001 in the Port field
3. Click the Connect button

Connection Examples:

5. Configuration #

5.1. Environment Variables

You can customize the agent behavior using environment variables:

docker run -d \
  --name simoob-agent \
  -p 3001:3001 \
  -e API_PORT=3001 \
  -e LOG_LEVEL=info \
  -v /var/run/docker.sock:/var/run/docker.sock \
  gayanpd/simoob Copy

5.2. Security Considerations

When deploying Simoob in production:

• Use a reverse proxy (nginx, Apache) with SSL/TLS
• Implement firewall rules to restrict port 3001 access
• Consider using Docker networks for internal communication
• Regularly update the Simoob agent to the latest version

5.3. Firewall Setup

Allow incoming connections on port 3001:

UFW (Ubuntu/Debian):

sudo ufw allow 3001/tcp Copy

Firewalld (CentOS/RHEL):

sudo firewall-cmd --permanent --add-port=3001/tcp
sudo firewall-cmd --reload Copy

6. Troubleshooting #

Common Issues and Solutions

Issue: Connection Failed

Symptoms: Dashboard shows "Connection failed" error

Solutions:

1. Verify the container is running: docker ps | grep simoob-agent
2. Test API accessibility: curl http://SERVER_IP:3001/api/system/stats
3. Check firewall rules allow port 3001
4. Ensure the correct IP address is entered in the dashboard

Issue: CORS Error

Symptoms: Browser console shows CORS-related errors

Solution: Use an HTTP server instead of opening the HTML file directly:

python3 -m http.server 8080 Copy

Issue: Container Not Starting

Symptoms: Container exits immediately after starting

Solutions:

1. Check container logs: docker logs simoob-agent
2. Ensure port 3001 is not already in use
3. Verify Docker socket is accessible

6.1. Viewing Logs

View real-time logs from the agent:

docker logs -f simoob-agent Copy

View the last 100 lines of logs:

docker logs --tail 100 simoob-agent Copy

6.2. Updating Simoob

To update to the latest version:

1. Stop and remove the existing container:

docker stop simoob-agent
docker rm simoob-agent Copy

2. Pull the latest image:

docker pull gayanpd/simoob:latest Copy

3. Start a new container with the updated image:

docker run -d \
  --name simoob-agent \
  --restart unless-stopped \
  -p 3001:3001 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  gayanpd/simoob Copy