Getting Started¶

To get Ocelescope running docker compose. To run ocelescope you can just use the below docker compose script.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

services:
  backend:
    image: grkmr/ocelescope_backend:latest
    ports:
      - "8000:8000"
    volumes:
      - plugins_store:/plugins
    restart: unless-stopped

  frontend:
    image: grkmr/ocelescope_frontend:latest
    ports:
      - "3000:3000"
    restart: unless-stopped

volumes:
  plugins_store:

Download

Starting the Services¶

Run the following command in the same directory as your docker-compose.yml:

1

docker compose up -d

This will start both the backend (API) and frontend (web interface).

Accessing Ocelescope¶

• Frontend (Web UI): http://localhost:3000
• Backend (API): http://localhost:8000

Uploading Plugins¶

You can upload plugins directly from the web interface at:

👉 http://localhost:3000/plugins

Uploaded plugins will be stored in the plugins_store volume and made available for execution.

Stopping Ocelescope¶

To stop the services, run:

1

docker compose down

Example Plugins¶

Here are some example plugins you can explore and use with Ocelescope