Skip to content

docs(admin): clarify SYS_NICE capability is Docker-specific#14905

Merged
skjnldsv merged 1 commit into
masterfrom
fix/imaginary-sys-nice-docker-context
May 19, 2026
Merged

docs(admin): clarify SYS_NICE capability is Docker-specific#14905
skjnldsv merged 1 commit into
masterfrom
fix/imaginary-sys-nice-docker-context

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

☑️ Resolves

Summary

The warning about adding the SYS_NICE capability for Imaginary HEIC preview support
(--cap-add=sys_nice / cap_add: - SYS_NICE) is a Docker-only instruction, but it was
written as if it applied universally. Users running Imaginary as a native binary were
confused by a Docker-specific step that is irrelevant to their setup.

Changes:

  • Added "if running Imaginary in Docker" qualifier
  • Changed "the capability" to "the Docker container capability" for clarity
  • Named both Docker CLI (--cap-add=sys_nice) and Compose (cap_add: - SYS_NICE) explicitly
  • Added a closing sentence confirming this does not apply outside Docker

🖼️ Screenshots

No visual layout change — text-only edit to an existing warning block.

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes (N/A — text only)
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

The existing warning about adding SYS_NICE for HEIC preview generation
did not make clear this only applies to Docker deployments. Users running
Imaginary outside Docker were confused by a Docker-specific instruction
that is irrelevant to their setup.

Rewrites the sentence to explicitly mention Docker, names both the CLI
flag and Compose key, and adds a note that this does not apply outside
Docker.

Fixes #11083

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

📖 Documentation Preview

🔍 Open preview →

📄 1 changed documentation page

Last updated: Tue, 19 May 2026 10:47:04 GMT

Copy link
Copy Markdown
Contributor

@szaimen szaimen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@skjnldsv skjnldsv merged commit 2095788 into master May 19, 2026
25 of 26 checks passed
@skjnldsv skjnldsv deleted the fix/imaginary-sys-nice-docker-context branch May 19, 2026 12:59
@skjnldsv
Copy link
Copy Markdown
Member Author

/backport to stable33

@skjnldsv
Copy link
Copy Markdown
Member Author

/backport to stable32

@skjnldsv
Copy link
Copy Markdown
Member Author

/backport to stable34

@backportbot

This comment was marked as resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

documentation enhancement: capability SYS_NICE

2 participants