Upgrading Sandfly

You will receive announcements about new versions of Sandfly from the mailing list if you subscribed to it. Additionally, you can check our website for announcements about new versions.

📘

Keep Your System Updated!

We are constantly adding in new sandfly investigative capabilities and features. You will want to make sure you keep your system updated.

To update Sandfly, do the following steps.

Step 1: Pause Scheduled Tasks

Go into the UI and pause the scheduled tasks. We want to ensure no scheduled tasks are kicking off during the install. You will need to un-pause these scheduled tasks in again after the upgrade.

Step 2: Make Sure All Tasks Have Completed

In the Sandfly UI, check the Dashboard and make sure the task queue is at 0. It's important that we do not stop nodes in the middle of scans because it can leave orphaned files on the remote hosts. If the nodes are allowed to finish then everything is cleaned up correctly.

Step 3: Option 1: Pull Latest Setup Scripts with Git

If you pulled the original setup from github you can do the following sequence. If you used the tarball you should proceed to the next step.

Go to the sandlfy-setup directory on your server and nodes. Then do a pull for the latest setup scripts with the commands below:

cd ~/sandfly-setup

Then do a git pull to pull over any changes.

git pull origin

Step 3: Option 2: Pull Latest Setup Tarball

If you did not install the setup scripts with git initially, you'll have to pull the latest from this URL and untar it over the sandfly-setup directory:

https://github.com/sandflysecurity/sandfly-setup/releases

Step 4: Delete Docker Images

Once all tasks have been cleared out, we can run our scripts to stop and delete all Docker containers on the server and node instances.

Run the following command on both the server and node.

Server:

cd ~/sandfly-setup/setup
./clean_docker.sh

be5e5caf816b
db7a5567a8f1
b5ba80831a5d
be5e5caf816b
db7a5567a8f1
b5ba80831a5d
Untagged: sandfly/sandfly-rabbit:latest
Untagged: sandfly/sandfly-server-mgmt:latest
Untagged: sandfly/sandfly-server:latest
...

Node:

cd ~/sandfly-setup/setup
./clean_docker.sh

a8c3b80228c4
9ecc25cdaae7
0106c87dbfd3
fb25ff348c30
a8c3b80228c4
9ecc25cdaae7
0106c87dbfd3
fb25ff348c30
Untagged: sandfly/sandfly-node:latest
...

You will see a large list of container hashes go by. Then you will be back at the prompt. That means the script completed and the Docker containers have been removed.

Step 5: Run Start Scripts Again On Server and Node

On the server and nodes you simply run the start script again. They will pull over the latest version of Sandfly and run it.

On server:

cd ~/sandfly-setup/start_scripts/
./start_sandfly.sh
*** Starting ElasticSearch.
...
*** Starting RabbitMQ server.
...
Waiting for RabbitMQ to configure and start. This will take about 45 seconds.
......
*** Starting Sandfly Server.
...

<server is started>

On the node you need to run the start script:

cd ~/sandfly-setup/start_scripts/
./start_node.sh
Unable to find image 'sandfly/sandfly-node:latest' locally
latest: Pulling from sandfly/sandfly-node
...

And again on the node you can run the start scripts multiple times to start multiple containers depending on your RAM and CPU capacity.

Finished

You can run docker ps on the server and node to make sure everything is running.

Server:

[email protected]:~/sandfly-setup/start_scripts# docker ps
CONTAINER ID        IMAGE                                                 COMMAND                  CREATED             STATUS              PORTS                    NAMES
caad0e18aeef        sandfly/sandfly-server:latest                         "/usr/local/sandfly/…"   5 minutes ago       Up 5 minutes        0.0.0.0:443->8443/tcp    sandfly-server
26c9df0d5c5b        sandfly/sandfly-rabbit:latest                         "/bin/sh -c /usr/loc…"   6 minutes ago       Up 6 minutes        0.0.0.0:5673->5673/tcp   sandfly-rabbit
3393a92b1a1a        docker.elastic.co/elasticsearch/elasticsearch:6.5.3   "/usr/local/bin/dock…"   6 minutes ago       Up 6 minutes        9200/tcp, 9300/tcp       elasticsearch

Node:

[email protected]:~/sandfly-setup/start_scripts# docker ps
CONTAINER ID        IMAGE                         COMMAND                  CREATED              STATUS              PORTS               NAMES
2d08ee113488        sandfly/sandfly-node:latest   "/usr/local/sandfly/…"   2 seconds ago        Up 1 second                             nostalgic_villani
059f71acec24        sandfly/sandfly-node:latest   "/usr/local/sandfly/…"   3 seconds ago        Up 3 seconds                            heuristic_agnesi
bd36bbb28944        sandfly/sandfly-node:latest   "/usr/local/sandfly/…"   5 seconds ago        Up 5 seconds                            elegant_jennings
bea2bc10800e        sandfly/sandfly-node:latest   "/usr/local/sandfly/…"   About a minute ago   Up About a minute                       trusting_roentgen

You can log into the UI on the server and check the Audit Log. You will see an entry near the top that shows the server and version timestamp:

Un-Pause Your Schedules

You now can un-pause your schedules and Sandfly will take up where it left off.