Skip to main content

Getting Started

This documentation provides everything you need to configure, manage, and optimize your YakSoft infrastructure. You’ll find detailed guidance on fine-tuning your team’s workflows, as well as configuration examples and helpful scripts to streamline your operations.

If you have any questions not covered in this documentation, please contact our support team at support@yaksoft.org

What is the Yak?​

The Yak is a task orchestration platform built for teams. Its core principle is simplicity — designed so that you don’t need to be a senior data or DevOps engineer to operate your infrastructure with confidence.

It can schedule jobs at specific times or automatically trigger scripts when new files appear on your server. Its multi-node architecture makes it easy to connect multiple servers and coordinate complex workflows across your entire environment.

With the Yak dashboard, your team can monitor the health and status of your systems at a glance, ensuring smooth and efficient operations.

What you will need​

  • A valid YakSoft login
    • Create a login on our Signup page
    • Verify your email
  • A valid API key and secret
    • After signing up at YakSoft you can Login and reteieve your API keys

How to start your Yak​

1️⃣ Signup

  • Visit our Signup page to create an account. You will need to verify your email.

2️⃣ Get API Keys

  • After verifying your email, Login to retrieve your API keys

3️⃣ Download

  • Once you’ve signed up and received your API key and secret, you’re ready to launch your Yak! Download the executables for your target operating system from the Downloads page. Your download will include two files:

    • yak.exe
      • The master node. Hosts the dashboard and coordinates workflows across all connected nodes.
    • yaknode.exe
      • The worker node. Executes tasks as orchestrated by the master node.

4️⃣ Execute

  • Launching Yak is simple and can be done with a single command in your terminal or command prompt.

    • Windows:

      yak.exe --api_key YOUR_KEY --api_secret YOUR_SECRET

    • Unix:

      ./yak --api_key YOUR_KEY --api_secret YOUR_SECRET

5️⃣ Login

Once the Yak is started, you will see an indication that the system is online and ready.

The user interface is hosted by the master node. By default, you can access it at:

http:\\127.0.0.1:3501

The default username and password to login to the yak are below:

  • Username: yak
  • Password: yaksoft