Add Quota Documentation #186
Conversation
Added detailed instructions on creating a custom egg for Pelican Panel, including configuration, features, and variable management.
Added imports for Admonition, Tabs, and TabItem components.
Updated the documentation for creating a custom egg.
Added a comprehensive tutorial on creating a custom Docker image, including Dockerfile structure, dependency installation, and entrypoint script details.
Corrected grammatical errors and improved clarity in the documentation.
Updated the section on Docker images to clarify terminology and guide references.
Removed the Table of Contents section from the tutorial.
Corrected typos and improved clarity in documentation.
Corrected typos and improved clarity in the documentation.
Added link to Yolk repository for pre-made images.
Corrected capitalization and hyphenation in the documentation.
Updated the Docker base image from openjdk:8-jdk-alpine to eclipse-temurin:8-jdk-noble for improved Java support.
Updated the Docker base image from 'eclipse-temurin:8-jdk-noble' to 'eclipse-temurin:8-jdk-alpine' for a smaller footprint.
Added section on referencing egg variables in various contexts.
Updated Dockerfile base image from 'eclipse-temurin:8-jdk-alpine' to 'eclipse-temurin:8-jdk-noble' and corrected spelling errors.
Updated descriptions for steam_disk_space and Stop Command. Changed references to environment variables for consistency.
Updated LABELs to use new format based upon Feedback.
Updates the container width to fill more of the screen. This is better for the standard widescreen layouts. Add docker to the additionalLanguages for prism. Adds an "About Quotas" page with warnings. Adds documentation on enabling filesystem based quotas for EXT4. Adds Docs on advanced quota management section that covers EXT4. Adds empty pages for other filesystems is support is added.
✅ Deploy Preview for pelica ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughAdds multiple new and updated documentation pages (disk quotas, eggs, yolks, panel guides), updates sidebar navigation, enables Docker syntax highlighting in Docusaurus, tweaks Wings install guidance, and sets explicit CSS container width variables. Changes
Sequence Diagram(s)(Skipped — changes are documentation/configuration only; no new multi-component control flow.) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 🧹 Recent nitpick comments
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🪛 LanguageTooldocs/guides/disk-quotas/about.mdx[style] ~10-~10: Consider using a synonym to be more concise. (A_LOT_OF) ✏️ Tip: You can disable this entire section by setting Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Fix all issues with AI agents
In @docs/guides/disk-quotas/about.mdx:
- Line 28: Update the heading "## Filesystem specific docs" to hyphenate the
compound modifier as "## Filesystem-specific docs" so the phrase correctly reads
"filesystem-specific" when modifying "docs" (change the heading text exactly
where "Filesystem specific docs" appears).
In @docs/guides/disk-quotas/ext4-xfs.mdx:
- Line 183: Replace the incorrect fragment "The should be the server UUID as
shown in the examples below" with the corrected sentence "This should be the
server UUID as shown in the examples below." to fix the grammar and complete the
phrase.
- Line 177: Change the phrase "The built in quota management uses blocks by
default." to hyphenate the compound adjective by replacing "built in quota
management" with "built-in quota management" so the line reads "The built-in
quota management uses blocks by default."; update the single occurrence where
the phrase appears (search for "built in quota management" in
docs/guides/disk-quotas/ext4-xfs.mdx).
- Line 10: The sentence "Both EXT4 and XFS use the built in quota management
services in linux." uses an unhyphenated compound adjective; change "built in"
to "built-in" so it reads "Both EXT4 and XFS use the built-in quota management
services in linux.", updating the phrase in the
docs/guides/disk-quotas/ext4-xfs.mdx content where the original sentence
appears.
- Line 38: Update the option description for the `E` flag to fix the spelling:
replace "Extented Options" with "Extended Options" in the bullet that reads "*
The `E` flag is for Extented Options" so it correctly says "* The `E` flag is
for Extended Options".
- Line 25: The sentence "We do not recommended this!" contains a grammar error;
change "recommended" to the base verb "recommend" so the sentence reads "We do
not recommend this!" by editing that exact string in the document.
- Line 140: Typo fix: change the misspelled word "assinged" to "assigned" in the
sentence "Limits for the servers are managed on a "project" level so they can be
assinged per-directory." in docs/guides/disk-quotas/ext4-xfs.mdx (the line
referencing "project" level).
- Line 204: Change the phrase "human readable format" to the hyphenated compound
adjective "human-readable format" in the sentence that describes the
`--human-readable` flag (the line containing "* The `--human-readable` flag sets
the limits to be displayed in a human readable format. By default that is
Megabytes"). Ensure only the adjective is hyphenated so the line reads "* The
`--human-readable` flag sets the limits to be displayed in a human-readable
format. By default that is Megabytes".
🧹 Nitpick comments (1)
docs/guides/disk-quotas/about.mdx (1)
10-10: Consider more concise wording.The phrase "a lot of" could be replaced with "many" for a more concise and professional tone in the documentation.
✍️ Suggested improvement
-## There are a lot of notices here for a reason! +## There are many notices here for a reason!
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
docs/guides/disk-quotas/about.mdxdocs/guides/disk-quotas/btrfs.mdxdocs/guides/disk-quotas/ext4-xfs.mdxdocs/guides/disk-quotas/lvm.mdxdocs/guides/disk-quotas/zfs.mdxdocs/wings/install.mdxdocusaurus.config.tssidebars.tssrc/css/custom.scss
🧰 Additional context used
🪛 LanguageTool
docs/guides/disk-quotas/about.mdx
[style] ~10-~10: Consider using a synonym to be more concise.
Context: ...artition. ## There are a lot of notices here for a reason! <Admonition...
(A_LOT_OF)
[grammar] ~28-~28: Use a hyphen to join words.
Context: ... partition. ## Filesystem specific docs <Link to="/docs/guides/dis...
(QB_NEW_EN_HYPHEN)
docs/guides/disk-quotas/ext4-xfs.mdx
[grammar] ~10-~10: Use a hyphen to join words.
Context: ...T4/XFS. Both EXT4 and XFS use the built in quota management services in linux. ...
(QB_NEW_EN_HYPHEN)
[grammar] ~140-~140: Ensure spelling is correct
Context: ...ged on a "project" level so they can be assinged per-directory. ### Add A New Project...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~177-~177: Use a hyphen to join words.
Context: ...cf9a ``` ### set quota limits The built in quota management uses blocks by defau...
(QB_NEW_EN_HYPHEN)
[grammar] ~204-~204: Use a hyphen to join words.
Context: ...ts the limits to be displayed in a human readable format. By default that is Mega...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (4)
docusaurus.config.ts (1)
112-112: LGTM! Docker syntax highlighting enabled.The addition of "docker" to Prism's additionalLanguages array properly enables syntax highlighting for Docker code blocks in the new quota documentation.
src/css/custom.scss (1)
22-24: LGTM! Container width customization for widescreen layouts.The custom properties correctly override Infima's default container widths to utilize more screen space on larger displays, aligning with the PR objectives.
docs/wings/install.mdx (1)
9-12: LGTM! Helpful operational guidance.This tip appropriately warns users about partition management best practices, which directly relates to the quota documentation being added in this PR. The placement at the beginning of the installation guide ensures visibility.
sidebars.ts (1)
59-67: LGTM! Sidebar navigation properly updated.The new "Disk Quotas" category is correctly structured and appropriately placed under the Guides section. The document references match the new files being added in this PR.
Removed warning about editing existing eggs to streamline instructions.
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Fix all issues with AI agents
In @docs/guides/disk-quotas/ext4-xfs.mdx:
- Line 38: The bullet text "* The `E` flag is for Extented Options" contains a
spelling mistake; update the string to read "* The `E` flag is for Extended
Options" (locate and edit the list item containing `E` flag in the
docs/guides/disk-quotas/ext4-xfs.mdx content).
- Line 177: The phrase "built in quota management" should be corrected to use a
hyphenated compound adjective: replace "built in quota management" with
"built-in quota management" wherever it appears (for example in the sentence
currently reading "The built in quota management uses blocks by default.") to
ensure proper hyphenation.
- Line 29: Replace the misspelled word "formated" with "formatted" in the
sentence referencing `/dev/sdb` and EXT4 so it reads "`/dev/sdb` as the device
formatted as EXT4 enabling only project quotas."
- Line 10: Update the phrase "built in quota management" to use the compound
adjective form "built-in quota management" so the sentence reads "Both EXT4 and
XFS use the built-in quota management services in linux."; locate the exact
string "built in quota management" in the docs/guides/disk-quotas/ext4-xfs.mdx
content and replace it with "built-in quota management" ensuring only the
hyphenation is changed.
- Line 204: The phrase "human readable format" in the documentation should be
hyphenated as a compound adjective; update the sentence containing
"`--human-readable` flag sets the limits to be displayed in a human readable
format. By default that is Megabytes`" to use "human-readable format" (i.e.,
replace "human readable format" with "human-readable format") so it reads
"`--human-readable` flag sets the limits to be displayed in a human-readable
format. By default that is Megabytes`".
- Line 183: Replace the typo "The should be the server UUID as shown in the
examples below" with "This should be the server UUID as shown in the examples
below"—update the sentence text in docs/guides/disk-quotas/ext4-xfs.mdx where
that exact phrase appears.
🧹 Nitpick comments (1)
docs/guides/disk-quotas/ext4-xfs.mdx (1)
186-187: Improve article usage for clarity.The phrase "set in the Pelican" sounds awkward. Consider "set in Pelican" or "set in the Pelican panel/interface" for better readability.
📝 Suggested improvement
-* The hard limit is set to the disk resource limit set in the Pelican +* The hard limit is set to the disk resource limit set in Pelican
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/disk-quotas/ext4-xfs.mdx
🧰 Additional context used
🪛 LanguageTool
docs/guides/disk-quotas/ext4-xfs.mdx
[grammar] ~10-~10: Use a hyphen to join words.
Context: ...T4/XFS. Both EXT4 and XFS use the built in quota management services in linux. ...
(QB_NEW_EN_HYPHEN)
[grammar] ~177-~177: Use a hyphen to join words.
Context: ...cf9a ``` ### set quota limits The built in quota management uses blocks by defau...
(QB_NEW_EN_HYPHEN)
[grammar] ~204-~204: Use a hyphen to join words.
Context: ...ts the limits to be displayed in a human readable format. By default that is Mega...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (2)
docs/guides/disk-quotas/ext4-xfs.mdx (2)
1-5: LGTM!The imports are appropriate for the MDX documentation with tabs, admonitions, and internal links.
224-226: TODO is tracked and appropriate for this PR.The TODO note is acceptable given the PR description mentions adding "empty/placeholder pages for other filesystems to be filled if support is added." This aligns with the incremental documentation approach.
Updated variable syntax in installation scripts from double curly brackets to dollar sign notation for consistency.
Clarify variable syntax usage in different contexts. Recommended from bot
* add info about routes to plugin docs * small fix
Add Egg Docs
* Fix link path for SSL certificates documentation * Fix link to SSL certificates documentation
Updates the container width to fill more of the screen. This is better for the standard widescreen layouts. Add docker to the additionalLanguages for prism. Adds an "About Quotas" page with warnings. Adds documentation on enabling filesystem based quotas for EXT4. Adds Docs on advanced quota management section that covers EXT4. Adds empty pages for other filesystems is support is added.
…vanced_configs_quotas
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@docs/eggs/creating-a-custom-egg.mdx`:
- Around line 197-210: In the "## List of Default Variables" section replace the
incorrect sentence "Below are an example of a few" with a grammatically correct
phrasing (e.g., "Below are a few examples." or "Below is an example of a few.")
so the subject-verb agreement is fixed; locate the sentence immediately
following the heading and update it accordingly.
In `@docs/guides/php-upgrade.mdx`:
- Around line 68-70: The sed command in the docs uses an incorrect character
class "[7|8]" which matches a literal pipe; update the sed expression used in
the PHP upgrade guide (the string "sed -i -e
's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile") to use
"[78]" instead of "[7|8]" so it properly matches PHP 7.x or 8.x socket
filenames.
- Around line 44-46: The sed commands using the regex pattern
"php[7|8].[0-9]-fpm.sock" (seen in the nginx replacement) and the analogous
Caddy sed command use a character class with a literal pipe; change the
character class from [7|8] to [78] so the pattern becomes
"php[78].[0-9]-fpm.sock" to correctly match PHP 7 or 8 versions.
🧹 Nitpick comments (5)
docs/panel/advanced/plugins.mdx (1)
214-236: Code example is missingusestatements forRoutefacade andTestController.Users following this example will encounter errors since the
Routefacade andTestControllerclass are referenced but not imported. Consider adding the necessary imports for completeness:📝 Suggested improvement
```php use Illuminate\Foundation\Support\Providers\RouteServiceProvider; +use Illuminate\Support\Facades\Route; class MyPluginRoutesProvider extends RouteServiceProvider { public function boot(): void { $this->routes(function () { - // Single new endpoint with Controller - Route::get('test', [TestController::class, 'test'])->name('my-plugin.test'); + // Single new endpoint with Controller (replace with your actual controller) + Route::get('test', [\MyPlugin\Http\Controllers\TestController::class, 'test'])->name('my-plugin.test'); // Load routes from filedocs/guides/php-upgrade.mdx (1)
19-20: Minor style suggestion: simplify phrasing.Per static analysis, "In order to install" could be simplified to "To install" for conciseness.
Suggested change
-In order to install PHP 8.5, you will need to run the following commands. Please keep in mind different operating systems +To install PHP 8.5, you will need to run the following commands. Please keep in mind different operating systemsdocs/eggs/creating-a-custom-yolk.mdx (1)
81-104: Minor inconsistency: text saysapt-getbut code usesapt.Line 83 mentions "Ubuntu's package manager:
apt-get" but the code block showsaptcommands. While both work, the documentation should be consistent with the code example.📝 Suggested fix
-The next thing we do is install the dependencies we will need using Ubuntu's package manager: `apt-get`. To keep things clean everything is being contained in a single [`RUN`](https://docs.docker.com/engine/reference/builder/#run) block. +The next thing we do is install the dependencies we will need using Ubuntu's package manager: `apt`. To keep things clean everything is being contained in a single [`RUN`](https://docs.docker.com/engine/reference/builder/#run) block.sidebars.ts (2)
48-55: Indentation inconsistency.The Eggs category block uses 3-space indentation for the opening brace, while other categories (Panel, Wings, Guides) use 4-space indentation. Consider aligning for consistency.
📝 Suggested fix
- { + { type: 'category', label: 'Eggs', items: [ 'eggs/creating-a-custom-egg', 'eggs/creating-a-custom-yolk', ], },
67-75: Extra whitespace before nested category.Line 67 has trailing whitespace before the Disk Quotas category definition. Minor cleanup opportunity.
📝 Suggested fix
'guides/uninstalling', - { type: 'category', label: 'Disk Quotas',
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
docs/eggs/creating-a-custom-egg.mdxdocs/eggs/creating-a-custom-yolk.mdxdocs/guides/php-upgrade.mdxdocs/panel/advanced/plugins.mdxdocs/panel/getting-started.mdxdocs/panel/panel-setup.mdxdocs/panel/update.mdxdocs/panel/webserver-config.mdxdocs/wings/install.mdxdocusaurus.config.tssidebars.ts
✅ Files skipped from review due to trivial changes (1)
- docs/panel/panel-setup.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/wings/install.mdx
- docusaurus.config.ts
🧰 Additional context used
🪛 LanguageTool
docs/guides/php-upgrade.mdx
[style] ~18-~18: Consider a more concise word here.
Context: ...| 8.2, 8.3, 8.4, 8.5 | ## Install PHP In order to install PHP 8.5, you will need to run t...
(IN_ORDER_TO_PREMIUM)
docs/eggs/creating-a-custom-egg.mdx
[style] ~57-~57: Try moving the adverb to make the sentence clearer.
Context: ...ame implies, this should be the command used to safely stop the server. For some games, this is stop or `end...
(SPLIT_INFINITIVE)
[style] ~69-~69: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...scriptor. Wings will process this block prior to booting the server to ensure all of the...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~69-~69: Consider removing “of” to be more concise
Context: ...k prior to booting the server to ensure all of the required settings are defined and set c...
(ALL_OF_THE)
[style] ~191-~191: Consider an alternative for the often overused word ‘important’.
Context: ...file to perform actions, thus it is not important for the user to see. Finally, you will...
(NOT_IMPORTANT)
[style] ~193-~193: Consider removing “of” to be more concise
Context: ...10 characters in length. You can find all of the available validation rules in the [Lara...
(ALL_OF_THE)
docs/eggs/creating-a-custom-yolk.mdx
[grammar] ~5-~5: Ensure spelling is correct
Context: ...ks) docker image, which can be found on GitHub. This tutorial also assumes some knowle...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~12-~12: Consider a more concise word here.
Context: ...org) as much as possible for our images in order to keep their size down. But for my exampl...
(IN_ORDER_TO_PREMIUM)
[style] ~151-~151: Consider an alternative adverb to strengthen your wording.
Context: ...ccumulating when child processes aren't properly cleaned up :::warning Sometimes you ma...
(PROPERLY_THOROUGHLY)
[style] ~158-~158: Consider a more concise word here.
Context: ... is located. ::: ## Entrypoint Script In order to complete this Dockerfile, we will nee...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (14)
docs/panel/advanced/plugins.mdx (2)
370-373: LGTM!The License admonition content is clear and provides helpful guidance on licensing options for plugin developers.
210-212: Good addition of the Routes documentation section.The Routes subsection fills an important gap in the plugin documentation by showing how to register custom routes. The three example patterns (single endpoint, file-based routes, and API client routes) cover common use cases well.
docs/panel/getting-started.mdx (1)
48-49: LGTM!PHP 8.5 released on November 20, 2025, so recommending it as the primary version with 8.4/8.3/8.2 as alternatives is appropriate and consistent with the other documentation updates in this PR.
docs/panel/update.mdx (1)
15-17: LGTM!The version requirements table is properly updated to include PHP 8.5 alongside existing supported versions. This is consistent with the other documentation changes in this PR.
docs/panel/webserver-config.mdx (3)
15-15: LGTM!The Nginx configuration updates correctly reference php8.5-fpm.sock with proper
unix:/run/php/php8.5-fpm.socksyntax.Also applies to: 78-78, 128-128
233-241: LGTM!The Apache configuration updates are consistent, updating both the admonition warning and the
a2enmod php8.5command.
253-256: LGTM!The Caddy configuration updates correctly use
unix//run/php/php8.5-fpm.socksyntax (Caddy's unix socket format differs from Nginx'sunix:prefix).Also applies to: 284-284, 337-337
docs/guides/php-upgrade.mdx (3)
13-15: LGTM!The PHP version table correctly lists all supported versions (8.2, 8.3, 8.4, 8.5) for Panel Version 1.0.0+.
30-31: LGTM!The installation commands correctly reference php8.5 and the required extensions.
55-59: LGTM!The Apache configuration instructions correctly update from disabling all previous PHP versions to enabling php8.5.
docs/eggs/creating-a-custom-yolk.mdx (1)
1-215: Well-structured Docker documentation.The documentation thoroughly covers the yolk creation process with clear explanations of:
- Platform architecture considerations with
TARGETOS/TARGETARCH- The required
containeruser setup and/home/containerdirectory- Tini as init process with proper signal handling
- The startup command variable substitution mechanism
docs/eggs/creating-a-custom-egg.mdx (2)
139-173: Excellent variable reference documentation.The clear distinction between variable syntax in different contexts (startup commands vs configuration parsers vs install scripts) is very helpful for users. The note block on lines 168-173 effectively summarizes the key differences.
259-263: Important warning about install container path.Good call highlighting that install scripts run in
/mnt/serverrather than/home/container. This is a common source of confusion for new egg developers.sidebars.ts (1)
48-75: Sidebar structure additions look good.The new Eggs category and Disk Quotas subcategory are properly structured and correspond to the new documentation files added in this PR.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| ## List of Default Variables | ||
|
|
||
| The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser. Below are an example of a few. | ||
|
|
||
| | Variable | Description | Example | | ||
| | ------------------------- | ------------------------------------------- | -------------------------------------------------------------- | | ||
| | TZ | Time Zone | `Etc/UTC` | | ||
| | STARTUP | Startup command of the egg | `java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}` | | ||
| | SERVER_MEMORY | Memory available for the server in MB | `512` | | ||
| | SERVER_IP | Default IP of the server | `127.0.0.1` | | ||
| | SERVER_PORT | Primary Server Port | `27015` | | ||
| | P_SERVER_LOCATION | Location of the server | `Example City` | | ||
| | P_SERVER_UUID | UUID of the server | `539fdca8-4a08-4551-a8d2-8ee5475b50d9` | | ||
| | P_SERVER_ALLOCATION_LIMIT | Limit of allocations allowed for the server | `0` | |
There was a problem hiding this comment.
Grammatical fix needed: subject-verb agreement.
Line 199 has "Below are an example of a few" — the plural verb "are" doesn't agree with the singular "an example."
📝 Suggested fix
-The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser. Below are an example of a few.
+The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser. Below are a few examples.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## List of Default Variables | |
| The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser. Below are an example of a few. | |
| | Variable | Description | Example | | |
| | ------------------------- | ------------------------------------------- | -------------------------------------------------------------- | | |
| | TZ | Time Zone | `Etc/UTC` | | |
| | STARTUP | Startup command of the egg | `java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}` | | |
| | SERVER_MEMORY | Memory available for the server in MB | `512` | | |
| | SERVER_IP | Default IP of the server | `127.0.0.1` | | |
| | SERVER_PORT | Primary Server Port | `27015` | | |
| | P_SERVER_LOCATION | Location of the server | `Example City` | | |
| | P_SERVER_UUID | UUID of the server | `539fdca8-4a08-4551-a8d2-8ee5475b50d9` | | |
| | P_SERVER_ALLOCATION_LIMIT | Limit of allocations allowed for the server | `0` | | |
| ## List of Default Variables | |
| The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser. Below are a few examples. | |
| | Variable | Description | Example | | |
| | ------------------------- | ------------------------------------------- | -------------------------------------------------------------- | | |
| | TZ | Time Zone | `Etc/UTC` | | |
| | STARTUP | Startup command of the egg | `java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}` | | |
| | SERVER_MEMORY | Memory available for the server in MB | `512` | | |
| | SERVER_IP | Default IP of the server | `127.0.0.1` | | |
| | SERVER_PORT | Primary Server Port | `27015` | | |
| | P_SERVER_LOCATION | Location of the server | `Example City` | | |
| | P_SERVER_UUID | UUID of the server | `539fdca8-4a08-4551-a8d2-8ee5475b50d9` | | |
| | P_SERVER_ALLOCATION_LIMIT | Limit of allocations allowed for the server | `0` | |
🤖 Prompt for AI Agents
In `@docs/eggs/creating-a-custom-egg.mdx` around lines 197 - 210, In the "## List
of Default Variables" section replace the incorrect sentence "Below are an
example of a few" with a grammatically correct phrasing (e.g., "Below are a few
examples." or "Below is an example of a few.") so the subject-verb agreement is
fixed; locate the sentence immediately following the heading and update it
accordingly.
| ``` bash | ||
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.4-fpm.sock/' /etc/nginx/sites-available/pelican.conf | ||
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/nginx/sites-available/pelican.conf | ||
| ``` |
There was a problem hiding this comment.
Regex pattern issue in sed command.
The character class [7|8] treats | as a literal pipe character, not as an OR operator. This means it would match 7, |, or 8 instead of just 7 or 8. While functionally this won't cause issues (a | in the filename is unlikely), the correct pattern should be [78].
The same issue exists in the Caddy sed command on line 69.
Suggested fix
- sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/nginx/sites-available/pelican.conf
+ sed -i -e 's/php[78].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/nginx/sites-available/pelican.conf📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` bash | |
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.4-fpm.sock/' /etc/nginx/sites-available/pelican.conf | |
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/nginx/sites-available/pelican.conf | |
| ``` |
🤖 Prompt for AI Agents
In `@docs/guides/php-upgrade.mdx` around lines 44 - 46, The sed commands using the
regex pattern "php[7|8].[0-9]-fpm.sock" (seen in the nginx replacement) and the
analogous Caddy sed command use a character class with a literal pipe; change
the character class from [7|8] to [78] so the pattern becomes
"php[78].[0-9]-fpm.sock" to correctly match PHP 7 or 8 versions.
| ``` bash | ||
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.4-fpm.sock/' /etc/caddy/Caddyfile | ||
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile | ||
| ``` |
There was a problem hiding this comment.
Same regex pattern issue as the Nginx sed command.
The [7|8] should be [78] to correctly match PHP 7.x or 8.x versions without including the literal pipe character.
Suggested fix
- sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile
+ sed -i -e 's/php[78].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` bash | |
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.4-fpm.sock/' /etc/caddy/Caddyfile | |
| sed -i -e 's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile | |
| ``` |
🤖 Prompt for AI Agents
In `@docs/guides/php-upgrade.mdx` around lines 68 - 70, The sed command in the
docs uses an incorrect character class "[7|8]" which matches a literal pipe;
update the sed expression used in the PHP upgrade guide (the string "sed -i -e
's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile") to use
"[78]" instead of "[7|8]" so it properly matches PHP 7.x or 8.x socket
filenames.
Updates the container width to fill more of the screen. This is better for the standard widescreen layouts.
Add docker to the additionalLanguages for prism.
Adds an "About Quotas" page with warnings.
Adds documentation on enabling filesystem based quotas for EXT4.
Adds Docs on advanced quota management section that covers EXT4.
Adds empty pages for other filesystems is support is added.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.