import { ExpectedExports } from "https://deno.land/x/embassyd_sdk@v0.3.3.4.0-alpha3/types.ts";
Type Aliases
Actions are used so we can effect the service, like deleting a directory. One old use case is to add a action where we add a file, that will then be run during the service starting, and that file would indicate that it would rescan all the data. | |
For backing up service data though the embassyOS UI | |
These are how we make sure the our dependency configurations are valid and if not how to fix them. | |
Get configuration returns a shape that describes the format that the embassy ui will generate, and later send to the set config | |
Health checks are used to determine if the service is working properly after starting A good use case is if we are using a web server, seeing if we can get to the web server. | |
This is the entrypoint for the main container. Used to start up something like the service that the package represents, like running a bitcoind in a bitcoind-wrapper. | |
Migrations are used when we are changing versions when updating/ downgrading. There are times that we need to move files around, and do other operations during a migration. | |
Properties are used to get values from the docker, like a username + password, what ports we are hosting from | |
For restoring service data that was previously backed up using the embassyOS UI create backup flow. Backup restores are also triggered via the embassyOS UI, or doing a system restore flow during setup. | |
Set configuration is called after we have modified and saved the configuration in the embassy ui. Use this to make a file for the docker to read from for configuration. |