Nests
Nests are categories that group related eggs together. For example, you might have a "Minecraft" nest containing eggs for Paper, Vanilla, and Forge servers, a "Source Games" nest for CS2, Garry's Mod, and Team Fortress 2, or a "Voice Servers" nest for Mumble and TeamSpeak.
Nests help keep your egg library organized and are used when assigning eggs to billing products.
Creating a Nest
- Navigate to Admin > Eggs and click New Nest.
- Fill in the following fields:
| Field | Description |
|---|---|
| Name | The display name for the nest (e.g., "Minecraft", "Source Games") |
| Description | A short summary of what this nest contains |
| Author | The person or organization that created or maintains this nest |
| Private | When enabled, the nest and its eggs are hidden from non-admin users during server creation |
- Click Create.
Managing Nests
Editing a Nest
Open a nest from the Admin > Eggs page and click the nest name to access its settings. You can change the name, description, author, and privacy toggle at any time. Changes take effect immediately.
Deleting a Nest
To delete a nest, open its settings and click Delete.
Warning: Deleting a nest permanently removes all eggs within it. Any servers currently using those eggs will retain their existing configuration but can no longer be reinstalled or have their egg settings updated. Make sure to move or re-create any eggs you still need before deleting a nest.
Importing Eggs into a Nest
When importing an egg from a JSON file, you select the target nest during the import process. If you specify a nest name that does not exist yet, BadgerPanel creates it automatically.
To import into an existing nest:
- Navigate to Admin > Eggs and click Import Egg.
- Upload the JSON file or paste the JSON content.
- Select the nest from the dropdown.
- Click Import.
See Eggs for full details on the import process.
Viewing Eggs Within a Nest
On the Admin > Eggs page, each nest is displayed as a collapsible section. Click a nest to expand it and see all eggs it contains, along with their descriptions and server counts. Collapse nests you are not working with to keep the page clean.
Nests in Billing Products
When creating a billing product, you select which nest and egg the product provisions. This means customers purchasing a "Minecraft Paper" plan will automatically get a server created with the Paper egg from the Minecraft nest. Organizing your nests logically makes it easier to set up and manage billing products.
See Billing Products for more on linking eggs to billing plans.
Best Practices
- Group by game or platform - Keep related eggs in the same nest. A "Minecraft" nest for all Minecraft variants is easier to manage than separate nests for each one.
- Use clear names - Nest names appear in the admin panel and in billing product configuration. Use names your team will recognize at a glance.
- Limit the number of nests - A handful of well-organized nests is better than dozens of single-egg nests. Only create a new nest when a group of eggs does not fit an existing category.
- Use the private toggle - If a nest contains eggs that are for internal testing or not yet ready for customers, mark it as private until it is ready.
- Add descriptions - A short description helps other administrators understand what a nest is for without opening it.
Next Steps
- Eggs - creating and configuring game server templates
- Server Management - creating servers from eggs
- Billing Products - linking nests and eggs to billing plans