{"id":13645210,"url":"https://github.com/direktiv/vorteil","last_synced_at":"2025-04-21T13:32:18.369Z","repository":{"id":43548817,"uuid":"294546144","full_name":"direktiv/vorteil","owner":"direktiv","description":"turn your applications and containers into micro virtual machines","archived":true,"fork":false,"pushed_at":"2022-02-27T04:46:11.000Z","size":1771,"stargazers_count":175,"open_issues_count":2,"forks_count":13,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-08-02T01:25:13.850Z","etag":null,"topics":["cloud","containers","linux","micro-virtual-machines","virtual-machine"],"latest_commit_sha":null,"homepage":"https://direktiv.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/direktiv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-10T23:36:11.000Z","updated_at":"2024-07-22T03:46:15.000Z","dependencies_parsed_at":"2022-09-16T23:12:01.475Z","dependency_job_id":null,"html_url":"https://github.com/direktiv/vorteil","commit_stats":null,"previous_names":["vorteil/vorteil"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/direktiv%2Fvorteil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/direktiv%2Fvorteil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/direktiv%2Fvorteil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/direktiv%2Fvorteil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/direktiv","download_url":"https://codeload.github.com/direktiv/vorteil/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223867890,"owners_count":17216973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud","containers","linux","micro-virtual-machines","virtual-machine"],"created_at":"2024-08-02T01:02:31.277Z","updated_at":"2024-11-09T18:30:33.173Z","avatar_url":"https://github.com/direktiv.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/vorteil/vorteil\"\u003e\n    \u003cimg src=\"assets/images/vlogo.png\" alt=\"vorteil\"\u003e\n  \u003c/a\u003e\n  \u003ch3 align=\"center\"\u003evorteil.io\u003c/h3\u003e\n    \u003ch5 align=\"center\"\u003eturn your applications and containers into micro virtual machines\u003c/h5\u003e\n\u003c/p\u003e\n\u003chr/\u003e\n\n[![Build Status](https://travis-ci.com/vorteil/vorteil.svg?branch=master)](https://travis-ci.com/vorteil/vorteil) \u003ca href=\"https://codeclimate.com/github/vorteil/vorteil/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/bb819f04d7550b91f24d/maintainability\" /\u003e\u003c/a\u003e [![Go Report Card](https://goreportcard.com/badge/github.com/vorteil/vorteil)](https://goreportcard.com/report/github.com/vorteil/vorteil) [![](https://godoc.org/github.com/vorteil/vorteil?status.svg)](http://godoc.org/github.com/vorteil/vorteil) [![Discord](https://img.shields.io/badge/chat-on%20discord-6A7EC2)](https://discord.gg/VjF6wn4)\n\nVorteil is an operating system for running cloud applications on micro virtual machines. It takes only the files you need and runs them on a custom Linux kernel without any unnecessary background services: there's no ssh, no shell, and no login; just a toml file that Vorteil's init process (vinitd) uses to configure the system and launch your apps.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/vorteil/vorteil\"\u003e\n    \u003cimg src=\"assets/images/terminal.gif\" alt=\"terminal\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nThe tools that build Vorteil images have been optimized for speed, and can take your project from loose files to a running virtual machine in as little as one second.\n\n## Installation\n\nThe Vorteil binary runs anywhere, just download the archive for your system, extract it, and put the executable on your `PATH`.\n\n### Linux\n```sh\nwget https://github.com/vorteil/vorteil/releases/latest/download/vorteil_linux-x86.tar.gz\ntar -xzf vorteil_linux-x86.tar.gz\n./vorteil version\n```\n### Windows\n\n```sh\nwget https://github.com/vorteil/vorteil/releases/latest/download/vorteil_windows-x86.zip -UseBasicParsing -OutFile .\\vorteil_windows-x86.zip\nExpand-Archive -Path .\\vorteil_windows-x86.zip -DestinationPath .\\\n.\\vorteil.exe version\n```\n\n### Mac\n\n```sh\ncurl -LJO https://github.com/vorteil/vorteil/releases/latest/download/vorteil_darwin-x86.dmg\nhdiutil attach vorteil_darwin-x86.dmg\ncp /Volumes/Vorteil\\ CLI/vorteil ./vorteil\nhdiutil detach /Volumes/Vorteil\\ CLI\n./vorteil version\n```\n\n### Dependencies\n\nTo use the `vorteil run` command you'll need [VirtualBox](https://www.virtualbox.org/wiki/Downloads), [QEMU](https://www.qemu.org/download/), [firecracker](https://github.com/firecracker-microvm/firecracker) or Hyper-V installed on your system and reachable on the `PATH`.\n\nIf you're using Windows, it's recommended that you enable developer mode as well, so that the tools can use Unix-style symlinks.\n\n## Using Vorteil\n\n### Hello World\n\n```sh\nvorteil run https://apps.vorteil.io/file/vorteil/helloworld\n```\n\nThis command downloads our Hello World package from apps.vorteil.io and runs it using one of your local hypervisors.\n\nOur Hello World app is a simple web server that should be reachable via NAT on port 8888 (http://localhost:8888/). If that port was unavailable you should notice a yellow warning message in the logs telling you which port it bound instead.\n\n### Convert from a Container\n\nAn easy way to build Vorteil micro virtual machines is to build them from container images. Vorteil can convert all OCI compliant images from remote repositories or local docker and containerd runtimes. The following command would convert the _hello-world_ application from docker hub.\n\n```sh\n\n# converts hello-world from docker hub into /tmp/hello\nvorteil projects convert-container hello-world /tmp/hello\n\n# converts hello-world from local docker into /tmp/hellolocal\nvorteil projects convert-container local.docker/hello-world /tmp/hellolocal\n\n# run it\nvorteil run /tmp/hellolocal\n\n```\n\n### Deploying an Image\n\nVorteil can deploy the images to different cloud providers. Please read the [documentation](https://docs.vorteil.io/docs/guides/configure-provisioner/) for examples.\n\n\n### Modify an Existing Package\n\n```sh\nwget -O cockroachdb.vorteil https://apps.vorteil.io/file/vorteil/cockroachdb\nvorteil unpack cockroachdb.vorteil cockroachdb\nls cockroachdb\n```\n\nThese commands download a Vorteil package and use the `vorteil unpack` command to extract its contents into a structured Vorteil project directory. Think of this directory like it will become the root directory on your app's virtual machine. You can modify the app's file-system contents by changing the files in this directory.\n\nThere are two types of special files in the project directory: `.vorteilproject` and files that end with the `.vcfg` file extension. These are used by Vorteil to understand how to build the virtual machine and what it should do when it's running.\n\nMake whatever changes you need to make, then repackage them.\n\n```sh\nvorteil pack cockroachdb -o cockroachdb-modified.vorteil\n```\n\nThis `vorteil pack` command packs up your project directory into a package file again.\n\n```sh\nvorteil run cockroachdb-modified.vorteil\n```\n\nTry out your modified package by using the `vorteil run` command on it.\n\n## Building From Source\n\nThese tools are 100% written in Go, which means compiling them is the same as compiling most simple Go programs.\n\n```sh\ngo build github.com/vorteil/vorteil/cmd/vorteil\n```\n\n### Code of Conduct\n\nWe have adopted the [Contributor Covenant](https://github.com/vorteil/.github/blob/master/CODE_OF_CONDUCT.md) code of conduct.\n\n### Contributing\n\nAny feedback and contributions are welcome. Read our [contributing guidelines](https://github.com/vorteil/.github/blob/master/CONTRIBUTING.md) for details.\n\n## License\n\nDistributed under the Apache 2.0 License. See `LICENSE` for more information.\n\n## See Also\n\n* The [Vorteil.io](https://vorteil.io/) website.\n* The Vorteil [documentation](https://docs.vorteil.io/).\n* The free Vorteil [apps repository](http://apps.vorteil.io/).\n* The Vorteil [blog](https://blog.vorteil.io/).\n* The [Godoc](https://godoc.org/github.com/vorteil/vorteil) library documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdirektiv%2Fvorteil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdirektiv%2Fvorteil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdirektiv%2Fvorteil/lists"}