Skip to content

Commit

Permalink
improve documentation (#392)
Browse files Browse the repository at this point in the history
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
  • Loading branch information
ibizaman and ibizaman authored Dec 5, 2024
1 parent ab86c6e commit 2f4bbdd
Show file tree
Hide file tree
Showing 5 changed files with 1,314 additions and 55 deletions.
24 changes: 15 additions & 9 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,28 @@ jobs:
path-filter:
runs-on: ubuntu-latest
outputs:
changed: ${{ steps.filter.outputs.changed }}
changed: ${{ steps.filter.outputs.any_changed }}

steps:
- name: Checkout repository
uses: actions/checkout@v4

- uses: dorny/paths-filter@v3
- uses: tj-actions/changed-files@v45
id: filter
with:
filters: |
changed:
- 'lib/**'
- 'modules/**'
- '!modules/**/docs/**'
- 'test/**'
- '.github/workflows/build.yaml'
files: |
lib/**
modules/**
!modules/**/docs/**
test/**
.github/workflows/build.yaml
separator: "\n"

- env:
ALL_CHANGED_FILES: ${{ steps.filter.outputs.all_changed_files }}
run: |
echo $ALL_CHANGED_FILES
build-matrix:
needs: [ "path-filter" ]
Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,10 @@ that is not like the other server management tools.
> production server, this is really just a one person effort for now and there are most certainly
> bugs that I didn't discover yet.
### Flake Module

Self Host Blocks is available as a flake.
To use it in your project, add the following flake input:
To use it in your existing project, add the following flake input:

```nix
inputs.selfhostblocks.url = "github:ibizaman/selfhostblocks";
Expand Down Expand Up @@ -70,6 +72,25 @@ Then, to actually configure services, you can choose which one interests you in
Head over to the [matrix channel](https://matrix.to/#/#selfhostblocks:matrix.org)
for any remaining question, or just to say hi :)

### Installation From Scratch

I do recommend for this my sibling project [Skarabox][]
which bootstraps a new server and sets up a few tools:

- Creating a bootable ISO, installable on an USB key.
- [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) to install NixOS headlessly.
- [disko](https://github.com/nix-community/disko) to format the drives using native ZFS encryption with remote unlocking through ssh.
- [sops-nix](https://github.com/Mic92/sops-nix) to handle secrets.
- [deploy-rs](https://github.com/serokell/deploy-rs) to deploy updates.

[Skarabox]: https://github.com/ibizaman/skarabox

### Full Example

See [full example][] in the manual.

[full example]: https://shb.skarabox.com/usage.html#usage-complete-example

## Server Management

Self Host Blocks provides a standardized configuration for [some services](https://shb.skarabox.com/services.html) provided by nixpkgs.
Expand Down
6 changes: 6 additions & 0 deletions docs/redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1673,9 +1673,15 @@
"usage": [
"usage.html#usage"
],
"usage-complete-example": [
"usage.html#usage-complete-example"
],
"usage-example-colmena": [
"usage.html#usage-example-colmena"
],
"usage-example-deployrs": [
"usage.html#usage-example-deployrs"
],
"usage-example-nixosrebuild": [
"usage.html#usage-example-nixosrebuild"
],
Expand Down
Loading

0 comments on commit 2f4bbdd

Please sign in to comment.