fix: logrotate error

[elibosley]

Fixes:

error: skipping "/var/log/unraid-api/unraid-api.log" because parent =
directory has insecure permissions (It's world writable or writable by =
group which is not "root") Set "su" directive in config file to =
tell logrotate which user/group should be used for rotation.

Improvements

No longer indents logrotate.conf for unraid-api

Summary by CodeRabbit

• Chores
  • Updated log rotation configuration to improve system logging management
  • Added user and group specification for log rotation process

[coderabbitai]

Walkthrough

The pull request introduces a modification to the log rotation configuration for the Unraid API. The change involves updating the log rotation setup script to include a new directive specifying the user and group under which log rotation should be performed. The setupLogRotation function's core logic remains consistent, with the primary difference being the updated configuration content written to the /etc/logrotate.d/unraid-api file.

Changes

File	Change Summary
api/src/core/logrotate/setup-logrotate.ts	Added su root root directive to log rotation configuration

Poem

🐰 Logs shall rotate with might and grace,
Under root's watchful, careful embrace
Spinning tales of system's delight
Rotation configured, everything's right!
A rabbit's config, precise and neat 🌀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 7b105d1 and 7a7129a.

📒 Files selected for processing (1)

• api/src/core/logrotate/setup-logrotate.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Build Web App
• GitHub Check: Build and Test API

🔇 Additional comments (4)

api/src/core/logrotate/setup-logrotate.ts (4)

1-4: LGTM! Well-structured imports and function signature.

The code follows good practices with async file operations and clear import organization.

---

Line range hint 6-8: LGTM! Good defensive programming.

The early return prevents unnecessary file operations if the config already exists.

---

19-19: LGTM! Appropriate file permissions set.

The file mode '644' follows the standard security practice for logrotate configuration files.

---

12-17: Configuration addresses the permission issue correctly.

The addition of su root root directly fixes the reported logrotate error by ensuring proper ownership of rotated logs.

Let's verify the configuration syntax and permissions:

✅ Verification successful

Logrotate configuration syntax is valid

The configuration syntax is correct and the su root root directive is properly formatted. Since this is a runtime configuration, the actual directory permissions will need to be verified in the production environment.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify logrotate configuration syntax
logrotate -d /etc/logrotate.d/unraid-api 2>&1 | grep "error"

# Check parent directory permissions
ls -ld /var/log/unraid-api/

Length of output: 153

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL: https://preview.dl.unraid.net/unraid-api/pr/1005/dynamix.unraid.net.staging.plg

[pujitm]

lgtm