Introduction
The eryph genepool
The eryph genepool provides a public, searchable index of genesets that you can use to breed and feed your catlets.
You don't need an account to use public genesets.
Discovering Genesets
Go to genepool.eryph.io and enter a search string to search for a geneset.
When you find a geneset, click on its name to learn more about it.
Hint
Only the first 5 genesets are displayed. If there are more hits, click "more results" to search with more filters.
When you're ready to use it, copy the name, e.g. "dbosoft/ubuntu-22.04" and use it either as a parent (for genesets with catlets) or as a source (for fodder genes or volumes).
Inspecting gene content
For catlets and fodder genes you can review and copy their content on the genepool.
For example, if you browse to dbosoft/winsrv2022-standard/tags/starter-1.0 you will see a small catlet which contains both a catlet parent reference and a fodder reference. You can click on both to follow the reference to the corrresponding gene content.
Instead of using a gene reference, you can also just copy the content and use it directly in your catlet.
Who can be trusted?
The genepool is a public repository where anyone can create content.
Therefore, you should never trust content without checking it.
Download count
Normally, download numbers are also a good indication of a trustworthy geneset. However, since genepool and eryph are quite new, the download numbers are still very low. On the other hand, most of the content is currently only available in the dbosoft organization, which can be considered safe ;-)
Catlet and fodder content can be viewed on the genepool. Volumes are a bit trickier.
As a rule of thumb, you should only test an unknown volume in an overlay network so that there is no risk of it interfering with your physical network. Please report any harmful content to support@dbosoft.eu.
Creating your own genesets
If you signup to the genepool, you can create your own genesets. These genesets can also be private for your organization.
Create a genepool organization
To sign up, click on "Sign in" in the top right corner of the genepool. Choose "Sign up now" in the logon dialog and go trought the account creation process.
Return to the genepool and click on your user avatar icon in the top right corner and select "Manage Organizations".
Create a new organization.
Organization Name
When creating the organization, you can specify two names:
- Genepool organization name:
This is the unique name to identify your organization in the Genepool (likedbosoft
). A good choice is your company name or (for private users) something unique like your github name. - Identity Organization Name:
This organization will be used to manage your members and (if any) customer accounts.
Brands
Do not use a brand name for the genepool organization name that you don't own. Any dispute may result in your organization being removed from the genepool.
Upload and manage genesets
Now you can use eryph-packer to create and publish your own genesets on the genepool.
Once uploaded, you cannot change geneset tags. To remove an existing geneset tag, go to your organization management page and open the corresponding geneset. When you select a tag, you will see a "delete" button in the table header.
Deleted geneset tags are initially placed in your organization's recycle bin. If you want to delete them permanently, you must also go to the recycle bin and remove the geneset tag from there.
Access private genesets
Private genesets can only be accessed by users within the organization. Public genesets are available to everyone.
To access private genesets from eryph-zero, you need to login to the geneset with eryph-zero:
eryph-zero genepool login
.
This command creates an API key that will be used instead of your user to access the genepool from the eryph-zero instance.
Invite other users
You can create multiple organizations and be a member of multiple organizations. Organization membership can be managed on my.dbosoft.eu.
All members of a organization can access and upload genesets to the organization. Only owners can order subscriptions.
Managing API keys
Each instance of eryph-zero with private access to your organizations needs an API key. You can also manually create API keys or delete keys that are no longer needed in the organization settings.
Limits and subscription
Without a genepool subscription, your organization is limited to
- up to 5 private genesets
- up to 1000 public genesets (fair use limit)
- up to 10 GiB of storage for public genesets
- up to 1 GiB of storage for private genesets
- up to 5 API keys
If you have a subscription, you are only limited by the fair use limits.
Subscription Beta Access
The subscription is currently in private beta. To sign up for the eryph zero subscription, apply for beta access at sales@dbosoft.eu.
Pricing
Usage beyond the free limits will be charged at the following rates.
- 5 EUR per API key per month
- 2 EUR per GiB of storage (private and public) per month
We have special agreements for open source projects. If you have an open source project and need more public storage than the free limit offers, please contact us at sales@dbosoft.eu.
Usage is counted hourly and then aggregated to a daily average. You will be charged by 5 EUR / 30 * daily usage
for API keys and 2 EUR / 30 * daily usage
for each GiB of storage.
You can review your usage in the organization settings.