search

numtide / system-manager

Manage system config using nix on any distro
MIT License
666 stars 17 forks source link

This utility needs better documentation #21

Open dnkmmr69420 opened 1 year ago

dnkmmr69420 commented 1 year ago

Can this tool have better documentation please. I have no idea how to use this tool

a-h commented 11 months ago

I've built a walkthrough of using system-manager to deploy a simple service on local virtual machines at https://github.com/a-h/system-manager-test/

It uses Canonical's multipass to run Ubuntu VMs. The README contains a series of steps used to deploy the example service to a remote virtual machine.

@numtide - I could turn this into a walkthrough and port the code over to this repo where it can be maintained along with the product?

I tested it on an x86-64 Linux machine, and also from my M1 Mac, where Multipass creates aarch64 Linux VMs. The only change required was to set this field https://github.com/a-h/system-manager-test/blob/33765ac34b9f3b25f16098a565d0cadd8903d5eb/machines/worker-001/modules/default.nix#L5 - I expect it's possible for that to be a parameter, but wasn't sure on the best way.

ShalokShalom commented 5 months ago

I think the README is missing the path to the config file. Am I supposed to use /etc/nix/nix.conf?

I will add that, then.

OJarrisonn commented 1 month ago

Agreed, i'm looking for using this so i can install docker using nixpkgs on my debian machine but didn't understood so far how to use it

zimbatm commented 1 month ago

For some reason, this issue has escaped my attention.

We have other priorities at the moment, but I added this to our backlog.

@a-h absolutely. I'm not sure exactly what the issue is with nixpkgs.hostPlatform but we can work this out if you send a PR.