ovk / silverbox

Guide describing how to setup compact, silent and energy-efficient GNU/Linux home server
https://ovk.github.io/silverbox
Other
60 stars 4 forks source link
apache docker docker-compose firefly-iii guide linux nextcloud nfs privacy selfhosted server

Guide on how to build compact, silent and energy-efficient GNU/Linux home server that runs:

The server also runs:

The latest HTML version of the guide is hosted online using GitHub Pages and can be viewed here: https://ovk.github.io/silverbox

Compiling

The guide is written in AsciiDoc format and can be compiled into different output formats, such as HTML or PDF.

If you have Docker installed, you can use Asciidoctor Docker container. For example, to build HTML version:

git clone https://github.com/ovk/silverbox.git
docker run -it --rm -v $(pwd)/silverbox:/documents asciidoctor/docker-asciidoctor asciidoctor silverbox-server.adoc

Or to build a PDF:

docker run -it --rm -v $(pwd)/silverbox:/documents asciidoctor/docker-asciidoctor asciidoctor-pdf silverbox-server.adoc

This should produce output file (silverbox-server.html or silverbox-server.pdf) in the silverbox directory, where all the placeholders replaced with your values.

See Generating Custom Document section for more details.

Customizing Document

Most of the configuration-specific parameters (such as IP addresses, host names, port numbers etc.) are not hardcoded, but defined using AsciiDoc attributes. This way you can redefine these attributes with your specific parameter values and build your very own version of this document.

By default these parameter values contain simple placeholders, such as {SERVER_IP_ADDR} for the server local IP address. You can replace them with the values you want by editing parameters.adoc file and then compiling the document.

License

This document is licensed under Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) License.

For more details see: