diff --git a/.github/assets/footer.png b/.github/assets/footer.png new file mode 100644 index 0000000..5f0feab Binary files /dev/null and b/.github/assets/footer.png differ diff --git a/.github/assets/header.png b/.github/assets/header.png new file mode 100644 index 0000000..720ef1b Binary files /dev/null and b/.github/assets/header.png differ diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index dfa8792..41791f3 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: Build and Release ISOs +name: Release CI on: push: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..7462eca --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,17 @@ +name: Test CI + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Check out the repository + uses: actions/checkout@v4 + + - name: Install Nix + uses: DeterminateSystems/nix-installer-action@main + + - name: Build the flake + run: nix build .#nixosConfigurations.installer.config.system.build.isoImage \ No newline at end of file diff --git a/LICENSE b/LICENSE index 47d43a3..e183352 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 kolyma-labs +Copyright (c) 2024 Kolyma Labs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c8dcd67..0f90500 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ -# installer - | Custom NixOS installer builds for faster initialization +

+ Kolyma's {Installer} +

+ +

+

NixOS images created with Kolyma's specifications.

+

+ +

+ Top Used Language + Release + Test CI +

+ +# About + +When bootstrapping NixOS on a new server machine, using nixos-anywhere itself becomes a bit of a hassle. This repository aims to provide a simple way to create NixOS images with Kolyma's specifications whereas you may write images to attached usb sticks which will later be booted first upon failed main system boot. + +## Features + +- Minimal NixOS installation +- Ready ssh & root password + +## Download + +You can download the latest release from the [releases page](https://github.com/kolyma-labs/installer/releases). + +## Burning the image + +If you have physical access to your server machine, just use etcher. If you are using a remote server, you can use `dd` to write the image to a usb stick: + +```bash +dd if=\ of=/dev/sdX bs=4M status=progress oflag=sync +``` + +## License + +This project is licensed under the MIT License - see the [LICENSE](license) file for details. + +

+ Kolyma's {Installer} +

\ No newline at end of file