Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

This utility needs better documentation #21

Open
dnkmmr69420 opened this issue Jun 23, 2023 · 5 comments
Open

This utility needs better documentation #21

dnkmmr69420 opened this issue Jun 23, 2023 · 5 comments
Labels
enhancement New feature or request

Comments

@dnkmmr69420
Copy link

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

@dnkmmr69420 dnkmmr69420 added the enhancement New feature or request label Jun 23, 2023
@a-h
Copy link
Contributor

a-h commented Sep 25, 2023

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
Copy link

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
Copy link

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
Copy link
Member

zimbatm commented Jul 25, 2024

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.

@Endle
Copy link

Endle commented Sep 25, 2024

Can we add a list of examples, so current system-manager users can share their nix config files?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants