v4/README.md
2025-03-26 01:03:26 -07:00

55 lines
1.2 KiB
Markdown

# Roleypoly v4
yeah 4 of em..
## Developing
use `nix shell` or `nix-shell` or maybe just run `go run .` or somethin its ok
please run `just precommit` before committing thx, it fixes weird build issues
## Deploying
roleypoly can be deployed as a docker container (built with nix) or nix package right now. more options to come (like prebuilt binaries)
```sh
nix build .#container
docker load -i result
docker run -it --rm -p 8169:8169 localhost/roleypoly/roleypoly
```
or like if in irl nixos
```nix
#== flake.nix
{
inputs = {
roleypoly.url = "git+https://git.sapphic.engineer/roleypoly/v4";
};
}
```
and want to use docker (its ok)
```nix
#== roleypoly.nix
{ inputs, pkgs, ... }: {
virtualisation.oci-containers.containers.roleypoly = {
image = "roleypoly/roleypoly:latest";
imageFile = inputs.roleypoly.packages.${pkgs.system}.container;
ports = [ "8169:8169" ];
# probably include environment and stuff too
};
}
```
or use `inputs.roleypoly.packages.${pkgs.system}.roleypoly` for the actual package for like a systemd thing
<33
## thanks
roleypoly has been a journey and a pleasure to make. thanks to everyone who has used it over the years. there will be no major updates after v4.
as always, with love
-- noe, aki, and aurelia!