Commit graph

83 commits

Author SHA1 Message Date
ibizaman
d78d0912ac add documentation for jellyfin 2025-07-12 23:11:02 +02:00
ibizaman
99c0a10b93 update deprecated argument 2025-07-12 22:50:41 +02:00
ibizaman
41d037206d add documentation for lldap and authelia blocks 2025-07-12 22:50:41 +02:00
ibizaman
1a5ecc9328 update documentation on how to implement a service 2025-07-12 21:54:26 +02:00
ibizaman
13f4064e93 rename ldap block to lldap 2025-07-12 21:47:55 +02:00
ibizaman
00cfdf243c use variables to define what module to generate documentation for 2025-07-12 21:26:32 +02:00
ibizaman
674043d83f provide patch nixpkgs function 2025-06-16 11:26:04 +02:00
ibizaman
4047321f81 add wip documentation for arr service 2025-06-09 00:31:00 +02:00
ibizaman
7dd7f41622 add documentation for home-assistant 2025-06-09 00:31:00 +02:00
ibizaman
7f86a7541a add more info in the preface 2025-06-09 00:31:00 +02:00
ak2k
16fcec4d40 feat: add documentation infrastructure and service implementation guide
## Documentation Infrastructure & Service Implementation Guide

This PR introduces documentation tooling and contributor resources to help maintain and expand the SelfHostBlocks project:

### Service Implementation Guide
- Add comprehensive guide for implementing new SHB services
- Covers contracts, testing, documentation, and integration patterns
- Provides step-by-step instructions and best practices for contributors

### Redirect Management Tool
- Add automated update-redirects tool to maintain documentation links
- Extracts heading IDs from markdown files across docs/, modules/, demo/
- Maps source files to target HTML pages using project routing logic
- Generates missing redirects in format expected by nixos-render-docs
2025-06-08 01:28:07 +02:00
ibizaman
0f22b8c2a3 revamp documentation 2025-06-06 14:10:45 +02:00
ibizaman
3cc1c870ab add exposed lib to usage manual 2025-06-06 04:33:08 +02:00
ibizaman
9a7419d247 fix selfhostblocks name 2025-06-03 14:55:02 +02:00
ibizaman
53371ba2e7 revamp readme and fix update command 2025-04-01 00:10:38 +02:00
ibizaman
c7a915a9a6 fix home-assistant basic login test 2025-03-19 16:40:11 +01:00
ibizaman
5e613b1aaf add SHB nixpkgs patches to demo 2025-03-17 23:07:21 +01:00
ibizaman
d13ed1c0ef update forgejo documentation 2025-01-26 23:04:24 +01:00
ibizaman
d5293825e9 add option to create forgejo users declaratively 2025-01-26 22:39:27 +01:00
ibizaman
b34f2e3cca replace version in usage doc 2025-01-26 22:39:27 +01:00
ibizaman
2c713ae9ad add playwright test for forgejo 2025-01-26 22:39:27 +01:00
ibizaman
bf73cb69a4 add documentation for nextcloud memories and recognize apps 2025-01-10 00:00:05 +01:00
ibizaman
83a3d54cf7 add recognize nextcloud app 2025-01-09 23:23:32 +01:00
ibizaman
0ef061f4d6 add nextcloud dashboard 2024-12-25 13:05:59 +01:00
ibizaman
9a7bcd374b add phpfpm prometheus exporter 2024-12-23 01:20:05 +01:00
Pierre Penninckx
2f4bbdd061
improve documentation (#392)
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
2024-12-05 22:37:45 +00:00
Pierre Penninckx
ab86c6e133
add dashboard for deluge (#389)
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
2024-12-02 22:02:04 +00:00
Pierre Penninckx
70de9efa21
check manual builds successfully (#373)
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
2024-11-26 12:22:11 -08:00
Pierre Penninckx
47dffd2a2f
switch backup contract to new contract style (#367)
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
2024-11-26 19:59:07 +00:00
Pierre Penninckx
ba1e60a45e
rename backup hook attributes (#371)
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
2024-11-26 19:15:36 +00:00
Pierre Penninckx
0155cad392
add missing entry in redirect.json (#369) 2024-11-25 22:43:52 +00:00
Pierre Penninckx
dde0d49a84
improve contract documentation (#365) 2024-11-23 21:34:26 +00:00
Pierre Penninckx
47d1db98df
[other] show how to pin flake input to a tag (#364) 2024-11-22 23:41:13 +00:00
Pierre Penninckx
7a10a805c2
use version file in generated manual (#362) 2024-11-22 22:35:34 +00:00
Pierre Penninckx
5056d203d9
update secret contract and add sops module (#356)
I find these `mkProvider` and `mkRequester` functions really nice.

Also fixes doc generation related to  https://github.com/NixOS/nixpkgs/pull/353513
2024-11-21 12:51:57 -08:00
Pierre Penninckx
a04dca9973
use secrets contract for restic (#349) 2024-11-17 21:12:14 +00:00
Pierre Penninckx
442c948a1a
more contracts usage in Nextcloud and docs enhancement (#345) 2024-11-13 21:43:12 +00:00
Pierre Penninckx
431dd058c5
Backup contracts for files and databases (#344)
This PR continues the work started in
https://github.com/ibizaman/selfhostblocks/pull/314

I had to create my own PR since I couldn't add commits on the fork.

---------

Co-authored-by: sivertism <10866270+sivertism@users.noreply.github.com>
2024-11-12 20:40:52 +00:00
ibizaman
7610097a74 add secret contract and use it in ldap block 2024-09-21 23:57:19 -07:00
ibizaman
d7136b52e5 update readme 2024-09-18 08:00:30 +02:00
ibizaman
11033d35fb fix link in docs to forgejo 2024-09-13 00:01:43 +02:00
ibizaman
253ec980d9 add forgejo service 2024-09-12 13:10:20 -07:00
Pierre Penninckx
eb791b3019
flake.lock: Update (#244)
Automated changes by the
[update-flake-lock](https://github.com/DeterminateSystems/update-flake-lock)
GitHub Action.

```
Flake lock file updates:

• Updated input 'nixpkgs':
    'github:nixos/nixpkgs/9ca3f649614213b2aaf5f1e16ec06952fe4c2632?narHash=sha256-7EXDb5WBw%2Bd004Agt%2BJHC/Oyh/KTUglOaQ4MNjBbo5w%3D' (2024-05-27)
  → 'github:nixos/nixpkgs/71e91c409d1e654808b2621f28a327acfdad8dc2?narHash=sha256-GnR7/ibgIH1vhoy8cYdmXE6iyZqKqFxQSVkFgosBh6w%3D' (2024-08-28)
```

### Running GitHub Actions on this PR

GitHub Actions will not run workflows on pull requests which are opened
by a GitHub Action.

To run GitHub Actions workflows on this PR, run:

```sh
git branch -D update_flake_lock_action
git fetch origin
git checkout update_flake_lock_action
git commit --amend --no-edit
git push origin update_flake_lock_action --force
```

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-08-31 07:57:21 +00:00
ibizaman
6aed5ee6a5 add backup contract 2024-08-20 00:33:26 -07:00
ibizaman
5d5cd6b87b remove dependency on sops-nix
fixes #24
2024-08-14 21:42:40 -07:00
ibizaman
d2a018ceec add docs for vaultwarden service 2024-08-12 06:51:24 -07:00
ibizaman
21ac10946a add documentation on how to get patched nixpkgs 2024-06-10 16:30:11 -07:00
ibizaman
3809201e8d add instructions to use public cache 2024-05-29 20:46:12 -07:00
Pierre Penninckx
38105f3a87
refactor some of the contracts docs (#227) 2024-04-14 23:07:37 -07:00
Pierre Penninckx
43f19a871a
add contract documentation (#225) 2024-04-14 15:21:20 -07:00