Installation with Docker

How to use Docker to install Stoobly

Prerequisite

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

Run

Start the Docker container with the following command:

Linux

docker run -it \
    --net="host" \
    -v ~/.mitmproxy:/home/stoobly/.mitmproxy \
    -v ~/.stoobly:/home/stoobly/.stoobly \
    --name stoobly-agent \
    stoobly/agent

macOS

docker run -it \
    -p 8080:8080 \
    -p 4200:4200 \
    -v ~/.mitmproxy:/root/.mitmproxy \
    -v ~/.stoobly:/root/.stoobly \
    --name stoobly-agent \
    stoobly/agent

The above command will:

1. Download the Docker image from Docker Hub

2. Start the proxy server 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:/root/.stoobly Docker option

After running the command, you should see output lsimilar 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.8/site-packages/stoobly_agent/record.py
Proxy server listening at http://*:8080