{"id":13928778,"url":"https://github.com/vpsfreecz/vpsadminos","last_synced_at":"2025-12-24T13:18:03.467Z","repository":{"id":44438159,"uuid":"109335108","full_name":"vpsfreecz/vpsadminos","owner":"vpsfreecz","description":"Host for Linux system containers based on NixOS, ZFS and LXC","archived":false,"fork":false,"pushed_at":"2024-10-29T18:38:22.000Z","size":15154,"stargazers_count":161,"open_issues_count":5,"forks_count":27,"subscribers_count":13,"default_branch":"staging","last_synced_at":"2024-10-29T20:39:02.316Z","etag":null,"topics":["containers","linux","lxc","nix","nixos","zfs"],"latest_commit_sha":null,"homepage":"https://vpsadminos.org","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vpsfreecz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-03T01:02:00.000Z","updated_at":"2024-10-29T18:38:26.000Z","dependencies_parsed_at":"2024-03-20T14:31:20.967Z","dependency_job_id":"7f3cbd00-8d90-4f4d-be32-29e18d301c59","html_url":"https://github.com/vpsfreecz/vpsadminos","commit_stats":null,"previous_names":[],"tags_count":81,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpsfreecz%2Fvpsadminos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpsfreecz%2Fvpsadminos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpsfreecz%2Fvpsadminos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpsfreecz%2Fvpsadminos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vpsfreecz","download_url":"https://codeload.github.com/vpsfreecz/vpsadminos/tar.gz/refs/heads/staging","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226588823,"owners_count":17655794,"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":["containers","linux","lxc","nix","nixos","zfs"],"created_at":"2024-08-07T18:01:40.736Z","updated_at":"2025-12-24T13:18:03.461Z","avatar_url":"https://github.com/vpsfreecz.png","language":"Ruby","readme":"# vpsAdminOS\n\nvpsAdminOS is a small OS serving as a host for unprivileged Linux system\ncontainers. It is based on [NixOS](https://nixos.org) and\n[not-os](https://github.com/cleverca22/not-os/). It is designed to run full\ndistributions inside unprivileged containers which look and feel as much as\na virtual machine as possible.\n\nvpsAdminOS is developed and used in production by [vpsFree.cz](https://vpsfree.cz),\na non-profit organization which provides virtual servers to its members.\nSee [vpsfree-cz-configuration](https://github.com/vpsfreecz/vpsfree-cz-configuration)\nfor example cluster configuration.\n\n## Links\n\n* IRC: #vpsadminos @ irc.libera.chat\n* Documentation: \u003chttps://vpsadminos.org/\u003e\n* Man pages: \u003chttps://man.vpsadminos.org/\u003e\n* OS and program references: \u003chttps://ref.vpsadminos.org/\u003e\n* ISO images: \u003chttps://iso.vpsadminos.org/\u003e\n\n## Components\n\nvpsAdminOS uses:\n\n- [LTS kernel with a mix of out-of-tree patches](https://github.com/vpsfreecz/linux)\n  to improve container experience,\n- runit as an init system,\n- ZFS for storage,\n- our own tools for system container management called [osctl](https://man.vpsadminos.org/man8/osctl.8.html),\n- LXC is used to run the containers,\n- BIRD for network routing.\n\n## Building OS\n\nOur kernel live-patch facility requires [ccache](https://wiki.nixos.org/wiki/CCache)\nto build the OS.\n\n```bash\ngit clone https://github.com/vpsfreecz/vpsadminos/\ncd vpsadminos\n```\n\nvpsAdminOS is developed on top of the latest NixOS release, so make sure that\nthe correct version of nixpkgs is in `NIX_PATH`, or set it as follows:\n\n```bash\ngit clone https://github.com/NixOS/nixpkgs --branch nixos-25.11\nexport NIX_PATH=`pwd`\n```\n\nvpsAdminOS can now be built and run:\n\n```\n# Build the OS\nmake\n\n# Run under qemu\nmake qemu\n```\n\nThe QEMU runner creates two disk images - `sda.img` and `sdb.img` which are added\nas QEMU ATA drives and can be used to create a mirrored ZFS pool that persists\nacross reboots.\n\n## Usage\n\n```bash\n# Login via ssh or use qemu terminal with autologin\nssh -p 2222 localhost\n\n# Configure osctld:\nosctl pool install tank\n\n# Create a container:\nosctl ct new --distribution alpine myct01\n\n# Configure container networking:\n# Bridged veth\nosctl ct netif new bridge --link lxcbr0 myct01 eth0\n\n# Routed veth\nosctl ct netif new routed myct01 eth1\nosctl ct netif ip add myct01 eth1 1.2.3.4/32\n\n# Start the container:\nosctl ct start myct01\n\n# Work with containers:\nosctl ct ls\nosctl ct attach myct01\nosctl ct console myct01\nosctl ct exec myct01 ip addr\n\n# More information:\nman osctl\n\n# https://vpsadminos.org/user-guide/setup/\n# https://vpsadminos.org/containers/administration/\n```\n\n## Binary cache\n\nvpsAdminOS has its own binary cache which contains builds of vpsAdminOS\nwith the current NixOS stable branch. Using it can save a lot of time building\nthe kernel.\n\n```nix\n{ config, ... }:\n{\n  nix.settings = {\n    substituters = [ \"https://cache.vpsadminos.org\" ];\n    trusted-public-keys = [ \"cache.vpsadminos.org:wpIJlNZQIhS+0gFf1U3MC9sLZdLW3sh5qakOWGDoDrE=\" ];\n\n    # Enable fallback in case the binary cache is unreachable\n    fallback = true;\n    connect-timeout = 15;\n  };\n}\n```\n\n## Docs\n\n* [vpsAdminOS documentation](https://vpsadminos.org)\n* [Manual pages](https://man.vpsadminos.org)\n* [Reference documentation](https://ref.vpsadminos.org)\n* https://linuxcontainers.org/\n","funding_links":[],"categories":["Ruby","linux"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvpsfreecz%2Fvpsadminos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvpsfreecz%2Fvpsadminos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvpsfreecz%2Fvpsadminos/lists"}