hosting/selfhostblocks
1
0
Fork 0
Code Issues Activity

revamp manual preface

Browse source
This commit is contained in:
ibizaman 2023-11-30 10:35:33 -08:00
parent 34f2198f40
commit 096acde683
1 changed files with 26 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/manual.xml
View file

@ -10,11 +10,11 @@
<preface> <preface>
<title>Preface</title> <title>Preface</title>
<para> <para>
Some basic documentation of Self Host Blocks. Complete manual for Self Host Blocks, the building blocks for self-hosting with battery included.
</para> </para>
<para> <para>
If you encounter problems or bugs then please report them on the If you encounter problems or bugs then please report them on the
<link xlink:href="https://github.com/nix-community/nix-on-droid/issues">issue tracker</link>. <link xlink:href="https://github.com/ibizaman/selfhostblocks/issues">issue tracker</link>.
</para> </para>
</preface> </preface>
@ -23,26 +23,38 @@
<section xml:id="sec-usage"> <section xml:id="sec-usage">
<title>Usage</title> <title>Usage</title>
<!--
Tags:
<title>
<section xml:id="sec-NAME">
<para> <para>
To use these options, edit the config file in <filename>
<filename>~/.config/nixpkgs/selfhostblocks.nix</filename> or in case of a flake setup, <replaceable>
set the <replaceable>modules</replaceable> value in the <varname>nixOnDroidConfiguration</varname> <varname>
call: <programlisting language="nix">
-->
<para>
To use these options, import Self Host Blocks as a flake input, then import the default module for your system.
<programlisting language="nix"> <programlisting language="nix">
{ {
inputs = { inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05"; nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
sops-nix.url = "github:Mic92/sops-nix";
nix-on-droid = { shb.url = "github:ibizaman/selfhostblocks";
url = "github:nix-community/nix-on-droid/release-23.05"; shb.inputs.nixpkgs.follows = "nixpkgs";
inputs.nixpkgs.follows = "nixpkgs"; shb.inputs.sops-nix.follows = "sops-nix";
};
}; };
outputs = { self, nixpkgs, nix-on-droid }: { outputs = { self, nixpkgs, shb }: {
nixOnDroidConfigurations.deviceName = nix-on-droid.lib.nixOnDroidConfiguration { nixosConfigurations.machine = nixpkgs.lib.nixosSystem {
<replaceable>modules</replaceable> = [ ./nix-on-droid.nix ]; system = "x86_64-linux";
modules = [
shb.nixosModules.x86_64-linux.default
./machine.nix
];
}; };
}; };