Quick start guide

When you have Docker

1. If you know exact uri of websummoner - just specify it with --websummoner-uri. No matter this is the same host or not.

   docker run -d --name websummoner-ui -p 8080:8080 websummoner/websummoner-ui --websummoner-uri http://${WEBSUMMONER_HOST}:4444

   Tip

   It can’t be localhost or 127.0.0.1 until the UI is started in the same container as websummoner.

2. When the UI and WebSummoner on the same host you need to determine websummoner uri accessible from UI container. Usually it can be the docker gateway address.

   If you use default network mode, firstly:

   DOCKER_GATEWAY_ADDR=`docker inspect websummoner -f {{.NetworkSettings.Gateway}}`
   echo $DOCKER_GATEWAY_ADDR
   172.17.0.1 # May be different

   Caution

   For MacOS you should determine interface with help of netstat. Remember that gateway address and host address is not the same in this case.

   You can also try magic command ifconfig | grep -E "([0-9]{1,3}\.){3}[0-9]{1,3}" | grep -v 127.0.0.1 | awk '{ print $2 }' | cut -f2 -d: | head -n1

   Then run WebSummoner UI:

   docker run -d --name websummoner-ui -p 8080:8080 websummoner/websummoner-ui --websummoner-uri http://${DOCKER_GATEWAY_ADDR}:4444

3. On the same host you can just link with websummoner container. Assumed you have websummoner container already up and running:

   docker ps
   
   CONTAINER ID        IMAGE                  COMMAND                  CREATED             STATUS              PORTS                                                   NAMES
   fc479233071d        websummoner/websummoner      "/usr/bin/websummoner..."   10 minutes ago      Up 10 minutes       0.0.0.0:4444->4444/tcp                                  websummoner

   Just run linked UI:

   docker run -d         \
       --name websummoner-ui  \
       --link websummoner     \
       -p 8080:8080        \
       websummoner/websummoner-ui --websummoner-uri=http://websummoner:4444

   websummoner is name of the WebSummoner container, and the --websummoner-uri value should be the same as the link name.

   Note

   UI will think that http://websummoner:4444 is real address of websummoner. But it’s true only inside of UI container.

With Docker Compose

With docker compose remember to use the same network with websummoner and browser containers. For now this is only bridge network mode.

version: '3'
services:
  websummoner:
    image: "websummoner/websummoner"
    network_mode: bridge
    ports:
      - "4444:4444"
    volumes:
      - "$PWD:/etc/websummoner/" # assumed current dir contains browsers.json
      - "/var/run/docker.sock:/var/run/docker.sock"
  websummoner-ui:
    image: "websummoner/websummoner-ui"
    network_mode: bridge
    links:
      - websummoner
    ports:
      - "8080:8080"
    command: ["--websummoner-uri", "http://websummoner:4444"]

When you don’t have Docker

Or just want to dramatically simplify all the things :)

1. Download WebSummoner UI binary from releases page.

2. Start it:

   ./websummoner-ui --websummoner-uri http://<websummoner-host-or-ip>:4444