diff --git a/.github/README b/.github/workflows/README similarity index 100% rename from .github/README rename to .github/workflows/README diff --git a/README.md b/README.md index 453d851..86a59f8 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,29 @@ -Hakurei -======= +

+ + + Yukari + + +

-[![Go Reference](https://pkg.go.dev/badge/git.gensokyo.uk/security/hakurei.svg)](https://pkg.go.dev/git.gensokyo.uk/security/hakurei) -[![Go Report Card](https://goreportcard.com/badge/git.gensokyo.uk/security/hakurei)](https://goreportcard.com/report/git.gensokyo.uk/security/hakurei) +

+ Go Reference + Go Report Card +

-Lets you run graphical applications as dedicated subordinate users in a container environment with a nice NixOS -module to configure target users and provide launch scripts and desktop files. +Hakurei is a tool for running sandboxed graphical applications as dedicated subordinate users on the Linux kernel. +It also implements [planterette (WIP)](cmd/planterette), a self-contained Android-like package manager with modern security features. -Why would you want this? +## NixOS Module usage -- It protects the desktop environment from applications. - -- It protects applications from each other. - -- It provides UID isolation on top of the standard application sandbox. - -If you have a flakes-enabled nix environment, you can try out the tool by running: - -```shell -nix run git+https://git.gensokyo.uk/security/hakurei -- help -``` - -## Module usage - -The NixOS module currently requires home-manager to configure subordinate users. - -Full module documentation can be found [here](options.md). +The NixOS module currently requires home-manager to configure subordinate users. Full module documentation can be found [here](options.md). To use the module, import it into your configuration with ```nix { inputs = { - nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05"; + nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11"; hakurei = { url = "git+https://git.gensokyo.uk/security/hakurei"; diff --git a/options.md b/options.md index ef51c5d..7d6fc26 100644 --- a/options.md +++ b/options.md @@ -35,7 +35,7 @@ package *Default:* -` ` +` ` @@ -916,7 +916,7 @@ package *Default:* -` ` +` ` diff --git a/package.nix b/package.nix index c22ad22..bb64517 100644 --- a/package.nix +++ b/package.nix @@ -31,7 +31,7 @@ buildGoModule rec { pname = "hakurei"; - version = "0.0.1"; + version = "0.0.2"; srcFiltered = builtins.path { name = "${pname}-src";