Stoobly Docs
  • Introduction
  • Use Cases
    • Generate Mock APIs
      • Empower Development
      • Scale API Testing
    • Enable E2E Testing
  • FAQ
    • Recording
    • Mocking
    • Terminology
  • Getting Started
    • Installing the Agent
      • Installation with pipx
      • Installation with Docker
  • Core Concepts
    • Agent
      • Intercept Modes
        • Mocking
        • Recording
      • Lifecycle Hooks
      • Proxy Settings
        • Data Rules
        • Firewall Rules
        • Rewrite Rules
        • Match Rules
    • Context
    • Mock API
      • Request
        • Response
        • Replay History
      • Scenarios
      • Snapshots
      • Fixtures
      • Public Folder
    • Scaffold
      • Service
      • Validation
      • Workflow
  • Guides
    • How to Run the Agent
      • Run with CLI
      • Run with Docker
    • How to Configure the Agent
      • Forward Proxy
        • Enable HTTPS Traffic
      • Reverse Proxy
    • How to Record Requests
      • Recording from the UI
      • Recording from the CLI
      • How to Create Contexts
      • How to Create Scenarios
        • Creating from the UI
        • Creating from the CLI
      • How to Create Requests
      • How to Customize Recordings
        • Customizing with Lifecycle Hooks
    • How to Update Requests
      • Editing from the UI
      • Editing with Snapshots
      • How to Update Scenarios
        • Updating from the UI
        • Updating from the CLI
      • Updating with Replay
        • Replaying from the UI
        • Replaying from the CLI
        • How to Customize Replays
          • Customizing with Lifecycle Hooks
      • Updating with Open API
    • How to Mock APIs
      • How to Enable Mocking
        • Enabling from the UI
        • Enabling from the CLI
      • How to Snapshot Requests
        • Deleting Snapshots
        • Sharing Snapshots
      • How to Use Fixtures
      • How to Customize Mocking
        • Customizing with Lifecycle Hooks
        • Customizing with Request Headers
      • Troubleshooting
    • How to Replay Requests
      • Replay with the UI
      • Replay with the CLI
    • How to Integrate E2E Testing
      • How to Scaffold an App
        • Scaffolding a Service
        • Customizing a Workflow
          • Customizing Container Services
          • Customizing Lifecycle Hooks
          • Customizing Init Scripts
          • Customizing Configure Scripts
          • Customizing Makefile
        • Troubleshooting
      • How to Run a Workflow
        • Running with CLI command
        • Running with Make
        • Troubleshooting
          • Validating
      • How to Stop a Workflow
        • Stopping with CLI command
        • Stopping with Make
      • How to Update a Scaffold
        • Deleting a Service
      • FAQ
  • Developer Guide
    • Installation from Source
    • Submitting Change Requests
    • Releases
  • Experimental
    • Experimental Features
      • Aliases
      • Endpoints
      • API Testing
        • Getting Started
        • Configuration
          • Assign
          • Lifecycle Hooks
          • Trace
      • Optional Components
Powered by GitBook
On this page
  • Prerequisite
  • Running the Agent

Was this helpful?

  1. Guides
  2. How to Run the Agent

Run with Docker

How to use run Stoobly with Docker

PreviousRun with CLINextHow to Configure the Agent

Last updated 28 days ago

Was this helpful?

Prerequisite

Docker must be installed. Refer to the official Docker install instructions .

Running the Agent

Start the Docker container with the following command:

docker run \
    -p 8080:8080 \
    -p 4200:4200 \
    -v ~/.stoobly:/home/stoobly/.stoobly \
    stoobly/agent
docker run -it \
    -p 8080:8080 \
    -p 4200:4200 \
    -v ~/.stoobly:/home/stoobly/.stoobly \
    stoobly/agent

The above command will:

  1. Download the stoobly/agent Docker image from

  2. Start the proxy and UI server

  3. Expose the proxy on port 8080 and the UI on port 4200

  • If the proxy port conflicts, configure it with the --proxy-port INTEGER option

  • If the UI port conflicts, configure it with --ui-port INTEGER option

The command will also mount the ~/.stoobly data directory from your host as a data volume to persist changes. If you don't want to persist changes then remove the -v ~/.stoobly:/home/stoobly/.stoobly Docker option

After running the command, you should see output similar to this to indicate that the agent started up successfully:

UI server listening at http://0.0.0.0:4200

Loading script /usr/local/lib/python3.10/site-packages/stoobly_agent/record.py
Proxy server listening at http://*:8080
here
Docker Hub