Adding egg repositories

Egg repositories is like the Blueprint extension Eggify, but integrated into Calagopus Panel. It allows you to install eggs from a Git repository by scraping all the available eggs and making them available in a page for you to download.

INFO

You can now add egg repositories directly from the OOBE when setting up Calagopus Panel, all you have to do is select the egg repositories you would like to import, then click on the Import button.

How do egg repositories work?

An egg repository works by storing lots of eggs on a Git repository. They are often organized by seperating games, softwares, programming languages, etc. into their own Git repository.

But do they work with regular Pterodactyl eggs?

Yes! Calagopus has backwards compability for Pterodactyl eggs, making migration easier. This guide will use Pterodactyl's 3 egg repositories:

• Their games repo
• Their applications repo
• Their generic (programming languages) repo

Prerequisites

To setup egg repositories, all you need is Calagopus Panel setup that is fully functional. You will also need a nest to store your eggs.

Adding a egg repository

For this guide, we will be adding the Pterodactyl's games repository, although you can also use any egg repository you want.

First, head over to the admin panel, click on Egg Repositories on the sidebar, and then click on the Create button.

Then, fill out theses fields:

• Name: This is the name used to distinguish this egg repository from others. This can be whatever you want.
• Git Repository: This is the Git repository that the eggs are stored. This can be a GitHub repository, or any Git source such as GitLab. For this guide, I'm using Pterodactyl's games repository, so I will put https://github.com/pterodactyl/game-eggs in this field.
• Description: This is a long description that is used to identify the egg repository.

Once you're done, click on the Save button. Then, click on the Sync button to start syncing the eggs to the panel.

WARNING

This will not add the eggs directly to the panel, it will only put the full list of eggs on the Eggs tab, which then you have to import them to the egg.

You should now see a little green callout saying that the egg repository is synchronised.

Importing the eggs

WARNING

It is currently not possible to import all eggs at once. However, you can import the eggs by dragging them and clicking on the Install button below.

Click on the Eggs tab, and you should be redirected to a page like this:

Here, it's up to you to decide which egg(s) would you like! If you would like documentation for what egg does what, head to the same directory as the egg in the Git repository.

On the egg you would like to import, click on the little import icon on the right of the egg like shown:

You should now be brought to a popup to select which nest would you like to import the egg to. Select the egg and click on the Install button.

And you're done! You can now create a server with the egg(s) you imported! If you want to import multiple eggs, just select them, and then click on the Install button below.

Updating the eggs

In case an egg has been updated, you can follow this guide to update the egg imported via the repository. You must first resync the egg repository.

To do so, head into the Egg Repositories tab in the admin panel and click on the egg repository you want to update.

Then, simply click on the Sync button to sync the updated eggs to the list.

To update an egg, first head to the Nests tab and click on the nest where your egg is located at.

Then, click on the egg you want to update.

Once in the egg settings, scroll down until you see the Update button, then the from Repository button.

The egg should now be updated from the repository. Keep in mind you may need to update your servers according to the changes done.

Mass-updating the eggs

In case you want to update multiple eggs, you can follow this guide to update the eggs imported via the repository. You must first resync the egg repository.

To do so, head into the Egg Repositories tab in the admin panel and click on the egg repository you want to update.

Then, simply click on the Sync button to sync the updated eggs to the list.

To update an egg, first head to the Nests tab and click on the nest where your eggs is located at.

Then, select the eggs you want to update, by either dragging it or searching for them manually, and then click on the Update from Repository button at the action bar.

The selected eggs should now be updated from the repository. Keep in mind you may need to update your servers according to the changes done.