Setup packages desktop application guide
This feature is currently in closed testing phase. Contact us if you're interested in participating.
The desktop application provides a visual interface for creating and managing configurations.
Installation
The desktop application provides a visual interface for creating and managing configurations. It can be downloaded via one of the two available package managers:
- Chocolatey
- Scoop
Deployments to chocolatey are currently suspended. For the time being, use scoop.
choco install dimescheduler-setup
scoop bucket add dimescheduler https://github.com/dime-scheduler/setup-packages-distro
scoop install dimescheduler-setup
If you're on macOS, you can install via Homebrew:
brew tap dime-scheduler/setup-packages-distro https://github.com/dime-scheduler/setup-packages-distro
brew install --cask dimescheduler-setup
Pages
Landing page
The starting point with quick access to:
- Create new configuration
- Open existing configuration
- Recent configurations
- Quick-start templates
Wizard
The wizard is a step-by-step guide for creating configurations:
1. Document types
Choose profile, layouts, users, configuration, or bundle
2. Metadata
Set owner and notification email:
- The owner email address refers to a user that already exists in Dime.Scheduler, and this user will be the owner of the new entities
- The notification email will be used to send a report once the import has completed.
3. Profile Settings and Workspace Builder
Configure theme, routing, and planning (for profiles), and a visual layout editor (for profiles)
4. Layouts
Define grid layouts
5. Users
Manage user accounts (for users/bundles)
6. Configuration
Import and export application configuration settings. Configuration documents contain key/value pairs for system-wide settings. See Configuration for the full list of available keys.
7. Summary and deploy
- Review configuration
- Configure merge strategy (for bundles)
- Save or deploy
Configurations
Manage saved configurations:
- View and edit existing configurations
- Duplicate configurations
- Delete configurations
- Export as JSON5 or JSON
Instances
Configure Dime.Scheduler instances for deployment:
- Add production, sandbox, or test instances
- Store API keys securely
- Test connectivity
Deploy
The deploy page allows you to bulk deploy configurations to an instance of choice:
