Welcome to WALKOFF’s documentation!¶
This documentation is intended as a reference for app and workflow developers as well as project contributors and operators. Here you will find walkthroughs, tutorials and other useful information about applications that are shipped with Walkoff, our changelog, and how to interact with Walkoff using its RESTful API.
What is WALKOFF?¶
WALKOFF is a flexible, easy to use, automation framework allowing users to integrate their capabilities and devices to cut through the repetitive, tedious tasks slowing them down,
- WHAT WE OFFER
- Easy-to-use: Drag-and-drop workflow editor. Sharable apps and workflows.
- Flexbility: Deployable on Windows or Linux.
- Modular: Plug and play integration of almost anything with easy-to-develop applications.
- Visual Analytics: Send workflow data to custom dashboards (and soon, Elasticsearch & Kibana!)
Ensure that Docker, Docker Compose 3+, and git are installed!
- Docker CE: https://docs.docker.com/install/#supported-platforms
- Docker Compose: https://docs.docker.com/compose/install/
- Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
If you do not already have a Docker Swarm initialized or joined, run the following command to create one:
docker swarm init
Note: If you have multiple NICs you will need to use –advertise-addr to pick an address from which the swarm will be accessible.
Open a terminal and clone WALKOFF:
git clone -b development https://github.com/nsacyber/WALKOFF.git
Move into the WALKOFF directory:
Launch WALKOFF with the bootloader, building components as well. If you are on Windows, be sure to use PowerShell and not Command Prompt.
# Windows PowerShell .\walkoff.ps1 up --build # If verbose output is desired: .\walkoff.ps1 up --build --debug
# Unix shell ./walkoff.sh up --build # If verbose output is desired: ./walkoff.sh up --build --debug
Navigate to the default IP and port. The default port can be changed by altering the port NGINX is exposed on (the right-hand port) in bootloader/walkoff-compose.yml. Note that you should use HTTPS, and allow the self-signed certificate when prompted.
The default username is “admin” and password is “admin”. These can and should be changed upon initial login.
To stop WALKOFF, use the bootloader:
# Windows PowerShell .\walkoff.ps1 down # If removing encryption key, stored images, verbose output, and postgres volume is desired: .\walkoff.ps1 down --key --registry --debug --volume
# Unix shell ./walkoff.sh down # If removing encryption key, stored images, verbose output, and postgres volume is desired: ./walkoff.sh down --key --registry --debug --volume
- Interface Overview
- Walkoff Development
- Prepackaged Applications
- Application Development
- API Gateway