Getting Started
The purpose of this page is to help you try out ActiveWorkflow as easily and quickly as possible. If you find something confusing, ambiguous or have any ideas for improvement please let us know!
Depending on what tools you are familiar with there are a few different ways to try out ActiveWorkflow:
An easy way to try out or to start using ActiveWorkflow is by deploying it to Heroku. If you are reading this document in a browser you can click the button bellow, fill in the environment variables for your seed user (admin), and deploy ActiveWorkflow to your Heroku account:
SEED_USERNAME-
SEED_PASSWORD(which must be at least 8 characters long) SEED_EMAIL
Please note that while a free Heroku plan can be used to try out ActiveWorkflow, it wouldn't be sufficient for real use. There is a SINGLE_DYNO environment variable, that when set to '1' forces all the processes (web, scheduler, workers) to run in a single dyno. This is fine for demonstration purposes only. For production use you should unset SINGLE_DYNO (or set to an empty
value) and run the web, scheduler and worker dyno separately.
You can run ActiveWorkflow using docker locally. To do so you need to have Docker and docker-compose installed. If you are on a Mac see Install Docker Desktop on Mac. On Linux please use your package manager, or follow this docker installation guide. To install docker-compose please see Install Docker Compose.
To run ActiveWorkflow (with a PostgreSQL database in a separate container) issue the following command inside the project directory:
docker-compose upThis starts a ActiveWorkflow instance locally at http://localhost:3000 with the login credentials "admin" / "password".
You can stop containers by issuing:
docker-compose downTo run ActiveWorkflow locally without Docker you would effectively follow very similar steps to running it locally for development. Thus, please see Development for more information.