eryph
by

Introduction

Getting started with eryph

Eryph is your local cloud platform where VMs inherit from each other. Deploy dev, test, staging, and POC environments 90% faster with catlets - our approach to cloud-speed VM management.

Introduction

Introduction on what eryph is and how to use it for virtual machine management.

Working with the powershell

A deeper dive into using eryph with powershell commands.

The eryph genepool

A description of the eryph genepool and how you can use it to share your machines and configuration.

References

References of specification files, configuration files and commands.

Introduction

Catlets are virtual machines specifications that contain both settings and configuration instructions.

This adds standardization of machine configurations, allowing the same base configuration to be reused for multiple purposes, similar to tools such as Vagrant or containerization platforms.
This is built around the concept of genesets, which are like packages for your virtual machine artifacts (we call them genes) such as volumes and configurations.

Eryph provides cloud-like capabilities on your hardware - handling storage management, virtual networking and VM configuration. Deploy any workload in minutes with full control and data sovereignty.

The name "catlet" refers to the pets vs. cattle concept in DevOps.

Installation

Currently, eryph comes in one flavor - eryph-zero - which is our standalone version for building catlets and running them on Hyper-V. Eryph-zero is free and the source code is available on github ( BSL license ).

You can install eryph-zero with the eryph App (recommended) or with an installation script on all Windows versions that support Hyper-V. See downloads for both installation options.

Note

A complete description of eryph-zero requirements and installation options can be found in the eryph-zero description.

Install from eryph App

Get started by installing the eryph App first.
When the eryph App is started, you have the option to either install eryph-zero locally or to connect to an existing eryph-zero installation.
Continue with the local installation of eryph-zero. During the installation, the eryph App will automatically make sure that all requirements are met.

First steps

After installing eryph-zero with the eryph App you can create your first virtual machines as catlets.

For a complete step-by-step guide to creating your first catlet, see our interactive tutorials. The Gene Mastery tutorial covers:

  • Creating catlets from parent genesets
  • Understanding the gene inheritance system
  • Deploying and accessing your VMs
  • Working with fodder configurations

Quick Start

For the fastest path to your first VM, follow our 10-minute quickstart guide.

Next Steps

Explore more advanced topics and real-world examples:

  • Interactive Tutorials - Step-by-step guides for gene mastery and advanced workflows
  • Example Configurations - Production-ready templates and sample setups including:
    • PowerShell automation examples
    • SQL Server deployments
    • Chef/configuration management integration
    • Complete infrastructure landscapes
  • GitHub Samples - Full source code for all examples

eryph-zero

A more detailed description of eryph-zero and its features and options.

Working with the powershell

A deeper dive into using eryph with powershell commands.

The eryph Genepool

A description of the eryph genepool and how you can use it to share your machines and configuration.

References

References of specification files, configuration files and commands.

Getting Help

Reset to Initial State

If you ever get stuck, you can simply remove all catlets, projects (if any) and (optional) genes.


# remove all projects except default project (which cannot be deleted)
Get-EryphProject | where Name -ne "default" | Remove-EryphProject

# remove all catlets
Get-Catlet | Remove-Catlet

#optional: remove genes (this will cause them to be downloaded again)
Remove-CatletGene -Unused

Reinstalling / Uninstalling

If something completely breaks and you can no longer use eryph, you can reinstall it. However, we encourage you to post your problem on either Github, Reddit, or our support site - see the next topic for support options.

You can uninstall eryph-zero using the Windows Add/Remove Programs control panel applet. The uninstaller gives you the option to remove the entire configuration, which is recommended if something is not working.

Feedback

Any feedback provided in the uninstaller is very valuable and we monitor the feedback from the uninstaller carefully. Feel free to add your email contact to the feedback in case we are allowed to contact you.

Support

Eryph-zero is free and our sources are available on github. Support should be provided by public communities (at least for eryph-zero, in the long run). However, since it is new, the community still needs to grow up. So if you post in one of the communities below, you can be pretty sure that a maintainer will answer you.

Communities:
GitHub: https://github.com/orgs/eryph-org/discussions
Reddit: https://www.reddit.com/r/eryph/

Support ticket:
In addition, we also offer the option to submit support requests directly to our support website https://support.dbosoft.eu or via email support@dbosoft.eu.
Please use this option only if you do not want to disclose your support request, as issues posted in the communities may help others to solve their problems.

Contributing

If you are a developer and have identified a issue in our code or have a feature request - feel free to contribute to the project. See https://github.com/eryph-org for eryph repositories.

Our main programming language is C# on .NET Core and almost all repositories are MIT licensed (except the main repository which is Business Source licensed which restricts also forks to non-clustered usage!). Feel free to fork and create your own clients, add-ons, or whatever!

Next
eryph-zero