Before you begin
Released binaries are available for Linux and macOS on bothamd64 and
arm64 processors. Windows is not currently a binary release target.
Find your operating system and processor architecture before downloading a
release:
uname -s | uname -m | Release asset suffix |
|---|---|---|
Darwin | arm64 | darwin-arm64 |
Darwin | x86_64 | darwin-amd64 |
Linux | aarch64 | linux-arm64 |
Linux | x86_64 | linux-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: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 anarupa
directory in your home directory and move the example download into it:
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:4. Create the initial configuration
The Kernel reads a TOML configuration file. Create the two directories used by the default plugin settings: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:
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 theplugins
directory.
Before exposing the Kernel outside your local machine, configure users
and access rules.