dyrectorio

README

dyrector.io is a self-hosted container management platform.

Overview

dyrector.io helps engineer & DevOps teams and individual developers to shift their focus from maintaining and setting up their containerized applications to developing their software. The platform achieves this by offering continuous delivery and version management capabilities to your OCI containers.

Warning The platform is under development, please treat as such. Expect bugs here and there. Early adopters welcome.

Join our Discord and connect with other members to share and learn together. If you like the project, give us a Star.

🌊 Use cases

🚢 Container utilization without commands

Interact with containers in Docker, Podman & Kubernetes without any experience to these technologies. Deploy, start, stop, and restart containers running locally or in remote infrastructures via the platform.

⛴️ Configuration Abstractions & JSON editing

Configuration screen lets you to filter out the unnecessary common, Docker or Kubernetes variables to avoid misconfiguration. JSON editing is still available.

⛵️ Multi-Instance Deployments

Trigger deployments of the same stack to multiple environments from one interface using the same or various configurations.

🛳️ Instant sandbox environments

Turn your local setup into a test & demo environment by deploying your container to it via the platform.

Demo

https://user-images.githubusercontent.com/9247788/219671903-41da385e-4f8f-4fba-a7e4-c6ec4f727b7f.mp4

Key features

• Kubernetes, Docker and Podman support
• Multi-instance deployment
• Instant test environments from any branches
• Environment management
• Secret and configuration management
• Auto-generated changelogs and release notes
• Workflow support
• Scheduled releases
• Audit log
• Container Registry integrations
• Fine-grained RBAC
• ChatOps & notification solutions

Getting Started

Our CLI tool lets you run and manage the entire, fully functional stack on your on-prem or cloud infrastructure.

Stack:

• UI Service (crux-ui)
• Backend Service (crux)
• PostgreSQL database
• Authentication (Ory Kratos)
• Migrations
• SMTP mail test server

Requirements

• Docker or Podman installed on your system.
• Go Compiler to run the CLI from its source code. (Precompiled binaries are in the works.)

Option 1: Go install

1. Execute go install github.com/dyrector-io/dyrectorio/golang/cmd/dyo@develop
2. Execute dyo up
3. After you navigated to localhost:8000 (this is the default Traefik port) you will see a Login screen
4. Register an account with whatever e-mail address you see fit (doesn't have to be valid one)
5. Navigate to localhost:4436 where you will find your mail as all outgoing e-mails will land here
6. Open your e-mail message and using the link inside you can activate your account
7. Happy deploying! 🎬

Option 2: From Source

1. Clone the repository to your local workdir with git clone
2. Execute make up in the project root
3. Open the localhost:8000
4. Happy deploying! 🎬

Development

1. Read the CLI documentation first (See the end of this section)
2. Decide which part of the project you want to work on, in this case it is crux, crux-ui or both
3. Modify the CLI's settings file if necessary
4. Execute the correct CLI command using the appropriate flags to turn off crux or crux-ui services
5. Start crux or crux-ui with the appropriate npm command, usually npm run start
6. After you navigated to localhost:8000 (this is the default Traefik port) you will see a Login screen
7. Register an account with whatever e-mail address you see fit (doesn't have to be valid one)
8. Navigate to localhost:4436 where you will find your mail as all outgoing e-mails will land here
9. Open your e-mail message and using the link inside you can activate your account
10. Fruitful contributing! 🎬

Read more about the CLI in the documentation.

Non-development

You can set up dyrector.io for self-hosting purposes with the docker-compose file located in the root folder.

Hosted version (SaaS)

Besides the self-hosted instance, you can check out the platform's alpha at app.dyrectorio.com. The platform is still in the works, we might reset the database, so it's not recommended for production yet. In case you are interested about using dyrector.io in production, reach out to us via email and we'll set up a stable instance for you.

How it works

dyrector.io consists of an agent (GoLang) and a platform (UI developed in React.js, Next.js. Backend developed in Node.js, Nest.js). There are two types of agents communicating with the platform: one for Docker and another for Kubernetes. Communication takes place in gRPC with TLS encryption. The data is managed in a PostgreSQL database which we use with Prisma ORM.

FAQ

• Can we use dyrector.io without containerization?

  Unfortunately, we're unable to support applications that don't run in a containerization environment.

• Will the tool remain completely free in the future, despite certain features only being accessible with a license key in upcoming versions, despite being open source?

  Our team consists of seven people, and although not all of them work on this project full-time, the majority do. We need to pay our engineers every month, and currently, we generate revenue by providing consultancy services. We are a fully independent team and do not have any investments. Our long-term goal is to work on this project full-time but to achieve this, we require funding.

  Our plan is to make the full project available for free if you choose to self-host it, but we also want to create a SaaS model where users can pay based on their usage. We don't have a complete plan for this yet. At present, we enjoy working on this project, collecting feedback, and making improvements to it.

• What was the motivation behind making this tool?

  We were working on a totally different project that included self-service release management capabilities of containerized apps as a business requirement. Our client made a white labelled product that needed self-service deployments to redistribute the product. While Portainer and Yacht are amazing projects, we just couldn't find one serving our exact needs, so we decided to make our platform.

  After a while, we noticed that this is a bit of a niche use case, so we tried to extend its capabilities into an Internal Developer Platform direction so that it can be valuable to a lot of users. On top of these, we decided to make it open source so users can take a better look at the project before introducing it into their infrastructure.

• How do I get in touch with the Support Team?

  You can contact us directly by reaching out to us via email at help@dyrector.io. Developers can get in touch via our Community Discord server.

Community

Also, follow us on GitHub Discussions, our Blog, and on Twitter. You can chat with the team and other members on Discord.

dyrector.io is Open Source - This repository, and most of our other open source projects, are licensed under the Apache 2.0.

Join our Discord and connect with other members to share and learn together. Send a pull request to any of our open source repositories on Github. Check our contribution guide and our developers guide for more details about how to contribute. We're looking forward to your contribution!

Contributing

The project can only accept contributions which are licensed under the Apache License 2.0. For further information please see our Contribution Guidelines.

Releases

We use semantic versioning, but shifted to the right, we don't bump major versions yet, until we reach beta phase.

Minor version is raised if:

• introduction of a braking API change (proto or HTTP)
• new feature set is completed
• milestone is reached
• agent configuration changes

Patch version is raised if:

• important fixes in develop
• any other reason

Changelog

Install the generator

go get -u github.com/git-chglog/git-chglog/cmd/git-chglog

Usage

git-chglog --next-tag vx.y.z -o CHANGELOG.md

git tag -a vx.y.z
git push --tags

In order to draft a new release:

• create a new release tag on develop
• generate changelogs

See CHANGELOG.md

Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

License

dyrector.io is open source software under the Apache License 2.0. Complete license and copyright information can be found in the source code.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.