SpiffWorkflow Introductory Articles

https://www.spiffworkflow.org/posts/articles
Admin
A collection of articles and videos designed to introduce SpiffWorkflow and guide users on how to...
Tokens:6,039
Snippets:70
Trust Score:6.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Download and Start SpiffArena using Docker Compose (Linux/MacOS/Windows)

Source: https://www.spiffworkflow.org/posts/articles/get_started_docker

These commands set up the SpiffWorkflow environment locally using Docker. They create a directory, download the docker-compose.yml configuration file, pull the necessary Docker images, and start the services in detached mode. Ensure Docker and Docker-Compose are installed prior to execution.

```bash
mkdir spiffworkflow
cd spiffworkflow
wget https://raw.githubusercontent.com/sartography/spiff-arena/main/docker-compose.yml
docker-compose pull
docker-compose up -d
```

--------------------------------

### Download docker-compose.yml using curl (MacOS)

Source: https://www.spiffworkflow.org/posts/articles/get_started_docker

This command is an alternative for MacOS users who may not have `wget` installed. It downloads the `docker-compose.yml` file from the specified URL, saving it with the correct filename. This file is essential for configuring and launching the SpiffArena Docker environment.

```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/sartography/spiff-arena/main/docker-compose.yml
```

--------------------------------

### Jinja Templating for SpiffWorkflow Task Output

Source: https://www.spiffworkflow.org/posts/articles/get_started_docker

This example demonstrates how to use Jinja templating within a Manual Task's 'Instructions' field in SpiffWorkflow. It utilizes the `my_name` variable defined in a preceding Script Task to create a personalized greeting message.

```jinja
Hello {{my_name}}!

Welcome to SpiffWorkflow!
```

--------------------------------

### Docker Container Listing Command

Source: https://www.spiffworkflow.org/posts/articles/get_started_docker

This command lists all currently running Docker containers. It's useful for verifying that the SpiffWorkflow services (or any other Docker containers) have been stopped after running `docker-compose down`.

```bash
docker ps
```

--------------------------------

### Docker Compose Shutdown Command

Source: https://www.spiffworkflow.org/posts/articles/get_started_docker

This command is used to stop and remove all containers, networks, and volumes defined in a Docker Compose project. It's typically used to clean up the environment after running SpiffWorkflow or other Dockerized applications.

```bash
docker-compose down
```

--------------------------------

### Python Script for SpiffWorkflow Task

Source: https://www.spiffworkflow.org/posts/articles/get_started_docker

This Python code snippet is intended to be placed within a Script Task in a SpiffWorkflow process model. It defines a variable `my_name` which can be used in subsequent tasks, such as those employing Jinja templating.

```python
my_name = "World"
```
Tokens:
Raw