Skip to main content
Use this method to run the Arupa Kernel directly on a Linux or macOS host. The release contains one executable file. It does not include a configuration file or plugins, so you create the Kernel directory and its initial files in the following steps.

Before you begin

Released binaries are available for Linux and macOS on both amd64 and arm64 processors. Windows is not currently a binary release target. Find your operating system and processor architecture before downloading a release:
Choose the matching release asset:
uname -suname -mRelease asset suffix
Darwinarm64darwin-arm64
Darwinx86_64darwin-amd64
Linuxaarch64linux-arm64
Linuxx86_64linux-amd64

1. Download the Kernel

Open the Arupa releases page. Select a release, then download the asset whose suffix matches your system. Release files use this format:
For example, an Apple silicon Mac running version v0.2.0 uses:

2. Create the Kernel directory

Keep the executable, configuration, plugin packages, and temporary extraction files together in one directory. The following commands create an arupa directory in your home directory and move the example download into it:
If you downloaded a different release asset, replace only the source file name in the mv command. The final name, arupa, is the executable you will run.

3. Allow the binary to run

Make the downloaded file executable, then confirm that it runs:
The command prints the installed Kernel version. If macOS prevents the binary from opening, review the security prompt and allow the application in System Settings only after confirming that you downloaded it from the official release page.

4. Create the initial configuration

The Kernel reads a TOML configuration file. Create the two directories used by the default plugin settings:
Create a file named config.toml in ~/arupa and add the following content:
Listen is the address and port where the Kernel accepts HTTP and Socket.IO connections. PluginDir holds downloaded .plg plugin packages. The Kernel uses PluginTempDir while it loads those packages. These relative paths are resolved from ~/arupa, because that is the directory where you run the Kernel.

5. Start and verify the Kernel

Start the Kernel from ~/arupa:
Leave this terminal running. In another terminal, verify that the Kernel is responding:
The response includes the Kernel version. Press Control-C in the first terminal to stop the Kernel.

Next steps

The Kernel is now ready for plugin packages. Continue with the Coreplugins documentation, then follow Install a plugin to add a package to the plugins directory. Before exposing the Kernel outside your local machine, configure users and access rules.