Running Slycat Server

You can use docker-compose to run an instance of the Slycat server on your local machine. This is a non-production build of the server and is used by the Slycat team for development only.

This procedure has been tested only in a Mac environment.

Requirements

Docker service names

  • haproxy

  • slycat-web-server

  • couchdb

  • sshd

  • slycat-client

Starting slycat services

  1. Clone the repo $ git clone --depth 1 -b master https://github.com/sandialabs/slycat.git

  2. Navigate into the repo to cd slycat/docker/compose/slycat-compose in terminal the following commands control our services and use the docker-compose yaml found in the directory in the repo.

  3. Start the docker services $ docker-compose up this step should take some time on the first load to download the images.

  4. After the slycat-client_1 | 「wdm」: Compiled successfully. displays, then everything has finished building and is running waiting for a connection.

  5. The client is served at https://localhost:9000, NOTE: the browser will show a security warning when navigating to localhost because Slycat generates a self signed certificate.

  6. admin::password is slycat::slycat

List of helpful docker commands

Start the services

$ docker-compose up

Stopping slycat services

$ docker-compose down

Start and build the services

$ docker-compose up --build

Stopping and removing slycat services

$ docker-compose down --remove-orphans

Starting slycat services in the background

$ docker-compose up -d

Attaching to slycat services logs per service

$ docker-compose logs -f <name_of_service>

Building the images separate without using the cache

$ docker-compose build --no-cache

Building the images and starting from cached images

$ docker-compose up --build