InEngine

A plugin-based, distributed command queuing and scheduling server.

InEngine runs commands directly, publishes them to a queue for a server to consume, or runs them on a cron schedule. Commands come from built-in commands, from external programs that you allow in the configuration, and from WebAssembly plugins. The queue stores messages in Redis or in files on disk.

Usage

A command queuing and scheduling server

Usage: inengine [OPTIONS] [COMMAND]

Commands:
  echo      
  exec      
  queue     
  schedule  
  plugin    
  help      Print this message or the help of the given subcommand(s)

Options:
  -s, --server                  Run InEngine server
  -c, --configuration <CONFIG>  Path to the configuration file [default: ./inengine.toml]
  -h, --help                    Print help

For example, publish a command to the queue and then start the server to consume it:

inengine queue publish --plugin inengine-core --command echo --args "text=Hello, world"
inengine -s

InEngine reads its settings from inengine.toml in the working directory. Copy inengine.example.toml to get started, because it lists every setting at its default value.

Documentation

The guide in docs covers commands, configuration, queuing, scheduling, the server, and plugins. If you want to read it in a browser, run mdbook serve docs and open the address it prints.

The sample plugin in sample-plugin shows how to write a plugin, and its README walks through the steps.

Build

You need a stable Rust toolchain and just. To build a release binary at target/release/inengine, run:

just build-release

Each CI run on main also builds static Linux binaries for x86_64-unknown-linux-musl and aarch64-unknown-linux-musl. You can download them from the artifacts of the run.

Develop

Run just to list the recipes.

Before your first build, run just install-tools to install the cargo tools and the WebAssembly target that the recipes use.

The integration tests need a Redis-compatible server on port 6390. Docker must be installed as just integration-test starts Valkey in Docker from compose.yaml and then runs the tests. The container keeps running after the tests. just valkey-down stops the container.

To use another port, set INENGINE_TEST_REDIS_PORT. just valkey-up and the test recipes all read it. If you already run Redis or Valkey yourself, set the variable to its port and run just integration-test-only, which does not start a container.

To run the server against the Docker Valkey, set queue_driver = "redis" and port = 6390 under [queue.redis] in inengine.toml.

Before you open a pull request, run:

just validate

It checks formatting, lints, docs, unused dependencies, and the dependency policy in deny.toml. It also runs every test, builds the sample plugin, and checks that the plugin fixtures in inengine-core/tests/fixtures match their source. If you change fixture-plugin, run just build-fixture-plugin to rebuild the fixtures.

CI runs the same recipes on each pull request and once a week.

License

InEngine is licensed under the Apache License, Version 2.0.