linode-nixos-base/README.md
2024-12-29 15:42:43 -05:00

26 lines
769 B
Markdown

# base-nixos-linode
A repository that builds a base NixOS Linode image. The make build
tool is used to build the image and also to manage a Linode instance.
A dotenv file is provided and used to define values to a specific
Linode instance, such as the IP address and admin account name.
## Basics
All repository commands can be found simply by running the make command,
like this: ```make```
Help text should be displayed on the screen with available commands and
what they do.
## Build Instructions
Run the following command: ```make build-image```
## Managing a Linode Instance
Two make targets are defined to manage a Linode instance: nixos-switch
and ssh. Run nixos-switch to build a Linode compatible NixOS image
from the configuration in /nixos-config.