ibizaman
a2b274ca80
mod: do not import sops module in the default module
2025-10-28 19:50:37 +01:00
ibizaman
ac5df335ba
doc: better info on how to setup selfhostblocks
2025-10-28 19:50:37 +01:00
ibizaman
6b7a6c6748
karakeep: configure meilisearch with master key and auto update
2025-10-24 01:54:26 +02:00
ibizaman
79197592aa
karakeep: add doc to build output
2025-10-22 21:25:27 +02:00
ibizaman
139ceca768
authelia: add extraOidcAuthorizationPolicies option
...
This is needed for example to only authorize users of a given group to access a service.
Usually, the application itself enforces this but some don't.
2025-10-22 03:33:17 +02:00
ibizaman
0822ed680f
doc: move implementation guide under contributing
2025-10-15 01:56:46 +02:00
ibizaman
6e64c7f8cf
mod: merge shb functions into lib
2025-10-15 01:20:00 +02:00
ibizaman
283e12d87d
test: merge functions into lib and set backdoor everywhere
2025-10-15 01:20:00 +02:00
ibizaman
9892f55ae2
mod: make imports explicit and remove system
2025-10-12 00:24:52 +02:00
ibizaman
02b73d2dce
open-webui: init
2025-09-27 21:25:40 +02:00
ibizaman
5b31645afa
docs: sort order
2025-09-27 21:25:40 +02:00
ibizaman
98b4cc32b6
pinchflat: init
2025-09-17 10:59:12 +02:00
ibizaman
a8eb543846
docs: update links from pre-RFC to RFC
2025-08-26 22:57:07 +02:00
ibizaman
a431aed3dd
docs: add how to serve static web pages
2025-08-26 22:57:07 +02:00
ibizaman
fad46e420a
docs: add how to expose a service recipe
2025-08-26 22:57:07 +02:00
ibizaman
ebd39bbe73
nextcloud: fix ldap and sso integration and add playwright tests
2025-08-25 11:50:06 +02:00
ibizaman
5f995e82df
add back info into authelia id token
2025-08-19 15:09:37 +02:00
ibizaman
b2c5637cfc
add debug output to authelia with mitmdump module
2025-08-19 13:36:46 +02:00
ibizaman
485e7474c4
lldap: only enforce groups
2025-08-19 00:55:07 +02:00
ibizaman
c9ee41b1d4
fine grained logging with mitmdump logger addon
2025-08-04 01:22:25 +02:00
ibizaman
67c2705f98
add mitmdump block
2025-07-31 23:21:57 +02:00
ibizaman
91580421be
add playwright test with ldap for forgejo
2025-07-24 23:12:33 +02:00
ibizaman
b50f45e17e
add declarative lldap using secrets contract
2025-07-18 23:51:27 +02:00
ibizaman
af8e8bf582
expose fine grained modules and overlay
2025-07-14 00:41:37 +02:00
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
ibizaman
11728af05f
more docs
2024-02-02 12:19:16 -08:00
ibizaman
b1343d7f86
move big part of readme in the manual
2024-02-01 22:38:36 -08:00
ibizaman
bccd6a1181
add more info for nextcloud
2024-01-28 22:37:30 -08:00
ibizaman
33fae657c9
enhance usage docs
2024-01-28 14:36:18 -08:00
ibizaman
a669fce572
improve usage manual
2024-01-20 20:25:55 -08:00
ibizaman
adc09acc49
use contract for ssl block
2024-01-19 10:48:10 -08:00
ibizaman
4a7e42abaa
add declarative configuration of LDAP in Nextcloud
...
refs #17
2024-01-06 00:12:48 -08:00
ibizaman
7a62b5b89c
add usage chapter in the manual
2023-12-25 23:26:50 -08:00
ibizaman
e6aca776e7
refactor readme to link more to the manual
2023-12-25 01:19:26 -08:00
ibizaman
d908ae31c5
add nextcloud manual
2023-12-25 00:51:44 -08:00
ibizaman
86e72534fc
improve the manual preface
2023-12-19 22:43:27 -08:00
ibizaman
e92e534789
use sub-chapters for blocks documentation
2023-12-19 22:11:36 -08:00
ibizaman
ca2f7039cc
add some sections to block backup chapter
2023-12-08 22:48:06 -08:00
ibizaman
49913ca4b6
add manual page for configuring backups
2023-12-08 11:52:00 -08:00
ibizaman
3c9f71da0e
allow to stagger backup jobs
2023-12-08 11:13:37 -08:00
ibizaman
f417372fdc
move monitoring docs close to source
2023-12-08 10:41:15 -08:00
ibizaman
a755529879
add homeassistant demo document to manual
2023-12-07 10:08:11 -08:00
ibizaman
5a3e072f34
use chapters instead of parts to allow sub-headings
2023-12-07 10:08:11 -08:00
ibizaman
13b756b09c
fix static files link
...
Before, the links in <head> were pointing to the /nix/store path.
2023-12-04 00:45:03 -08:00
Pierre Penninckx
a63b0a6e2e
switch to nixos-render-docs ( #34 )
...
fixes #33
2023-12-04 00:33:16 -08:00
Pierre Penninckx
4a8a7d686c
build docs and deploy to github pages
2023-11-30 10:38:35 -08:00
Pierre Penninckx
7d9dedb845
provision grafana datasources and some dashboards ( #23 )
...
fixes #22
This commit introduces:
- A few more optional options for the monitoring module, in particular
an SMTP option to setup sending alerts with an STMP server.
- 2 required options for adding a secure key for signing and for an
initial admin password. The latter is nice because at least you can
choose securely the initial admin password instead of it being just
"admin", adding a bit more security to the install process.
- Provisioning Grafana with dashboards, datasources, alerts, contact
points and notification policies.
- Documentation for monitoring in
[docs/blocks/monitoring.md](docs/blocks/monitoring.md).
- A NixOS test that makes sure provisioning did go well as expected.
2023-11-26 09:56:08 -08:00
ibizaman
c4938abceb
move code using disnix into separate hidden folder
2023-07-11 23:26:50 -07:00
ibizaman
5db376a330
make letsencrypt use sops for secret
2023-04-08 22:08:05 -07:00
ibizaman
36c9fe23c3
add vaultwarden example
2023-04-04 00:07:58 -07:00
ibizaman
c261fd8750
add start of documentation to deploy on Linode
2023-04-04 00:07:15 -07:00
