mirror of
https://github.com/unraid/api.git
synced 2026-01-25 18:08:43 -06:00
d07aa42063
fix context menu trigger area and dropdown styles
implement 'move to folder'
implement 'start / stop' bulk & row actions
implement pause / resume
implement column visibility customization
fix(organizer): over-eager addition of untracked containers to root folder
scaffold docker form service
docker container management prototype
use compacted table as sidebar tree
add drag and drop for re-ordering containers & folders
right click to reame & delete folders
add bottom padding to container to make it easier to drag items to bottom in sidebar
click overview row to open details
track active container in query param
refactor: extract composables
refactor: simplify organizer operations
refactor!: rm intermediate tree resolution of organizers
BREAKING CHANGE: ResolvedOrganizerView -> root is replaced by rootId +
flatEntries.
`root` resolved a tree representation of an organizer, but this required
clients to defined and use their own tree operations, thus increasing
client complexity.
Instead, `flatEntries` is more suitable for client operations and only
requires an initial mapping step on the client for efficiency.
fix: rm extra Root layer in table
map containers to their template files
feat: icon support
fix: container state badge
chore: fix formatting
fix: search filtering
fix: context menu
feat: filtering & bulk actions in compact mode
feat: critical notifications
feat: notifyIfUnique service method
tmp: critical notifications system
fix: nuxt ui portal styling
fix: notifications type check
fix api tests
fix: css
Revert "fix: css"
This reverts commit 234c2e2c65.
add docker constants
flatten css scopes
feat: file modification for replacing docker overview table
feat: navigate to container update page
feat: implement manage settings action
fix: column visibility toggle
fix: move update to a badge + popover
feat: save column visibility preferences across visits
fix: add feature flag to containers file mod
fix: circular dependency in docker service
add a flag to opt out of version check in super.shouldApply in file mods
fix: optimistic column toggle update
refactor: optimistic column toggle
feat: container start & stop order
feat: bulk toggle auto-start
fix: add background style reset, apply to button:hover as well
feat: add ENABLE_NEXT_DOCKER_RELEASE=true to staging environment
chore(api): add dev/notifications to gitignore
feat: container update actions
fix: container update logic
feat: bulk container updates
feat: container sizes
fix: container sizes modla overlay
fix: checkbox alignment
fix: revert color in main css
chore: ignore build output in lint & fix
feat: server-side container ip
add docker feature flag to .env.production
fix: container port duplication
feat: multi-value copyable badges
feat: make lanIpPorts a list, not a csv
feat: visit button
feat: include indexed search fields in filter input title
feat: sync userprefs.cfg for rollback compat
feat: port conflicts
refactor: port conflict frontend stuff
feat: update all containers bulk action
feat: docker logs
fix: use container name instead of id in 'view logs' modal
make webgui iframable
feat: re-add compact mode
manage settings > compact view
fix styles
feat: container stats
refactor: docker autostart service
refactor: docker log, event, and port services
@unraid/api
Installation
Install the production plugin via the apps tab (search for "Unraid Connect")
Manual install can be done with the following routes: production staging
CLI
If you're on a unraid v6.9.2 or later machine this should be available by running unraid-api in any directory.
root@Devon:~# unraid-api
Unraid API
Thanks for using the official Unraid API
Usage:
$ unraid-api command <options>
Commands:
start/stop/restart/version/status/report/switch-env
Options:
-h, --help Prints this usage guide.
-d, --debug Enabled debug mode.
-p, --port string Set the graphql port.
--environment production/staging/development Set the working environment.
--log-level ALL/TRACE/DEBUG/INFO/WARN/ERROR/FATAL/MARK/OFF Set the log level.
Copyright © 2024 Lime Technology, Inc.
Key
To create and work with Unraid API keys, used for the local API, run the following command to view all available options. These options may change over time.
unraid-api key --help
Report
To view the current status of the unraid-api and its connection to mothership, run:
unraid-api report
To view verbose data (anonymized), run:
unraid-api report -v
To view non-anonymized verbose data, run:
unraid-api report -vv
Secrets
If you found this file you're likely a developer. If you'd like to know more about the API and when it's available please join our discord.
Internationalization
- Run
pnpm --filter @unraid/api i18n:extractto scan the Nest.js source for translation helper usages and updatesrc/i18n/en.jsonwith any new keys. The extractor keeps existing translations intact and appends new keys with their English source text.
Developer Documentation
For detailed information about specific features:
- API Plugins - Working with API plugins and workspace packages
- Docker Feature - Container management, GraphQL API, and WebGUI integration
- Feature Flags - Conditionally enabling functionality
- Repository Organization - Codebase structure
- Development Workflows - Development processes
License
Copyright Lime Technology Inc. All rights reserved.