Sandbox

Overview

Sandbox is a repository that serves as a community-driven space for unofficial Saltbox enhancements and is included in a standard Saltbox installation.

---

Update

To pull repository changes, run a standard Saltbox update:

sb update

Usage

Sandbox roles are listed under Applications and by running:

sb list

To deploy a Sandbox role, use sb install, prepending sandbox- to the role tag. For example, to deploy Kometa:

sb install sandbox-kometa

Before deploying a Sandbox role, it is recommended to review its documentation for any required configuration.

App Default Login Credentials

Where possible, the username and password configured in your Saltbox accounts.yml are used to create a default user and password for logging in.

Custom roles

Tags are validated against cached data. To bypass validation if developing your own role, use the --no-cache flag:

sb install sandbox-myapp --no-cache

Deprecated roles

Apps are occasionally pruned from the repository when the upstream project is archived or no longer complies with Saltbox standards. If an app you still use had its role pruned, your app data is left intact, but you can no longer manage it via Saltbox. You may choose to manage it independently by migrating to your own containers.