Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ovk/silverbox
Guide describing how to setup compact, silent and energy-efficient GNU/Linux home server
https://github.com/ovk/silverbox
apache docker docker-compose firefly-iii guide linux nextcloud nfs privacy selfhosted server
Last synced: 4 days ago
JSON representation
Guide describing how to setup compact, silent and energy-efficient GNU/Linux home server
- Host: GitHub
- URL: https://github.com/ovk/silverbox
- Owner: ovk
- License: other
- Created: 2019-12-07T16:50:25.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-29T14:56:35.000Z (about 2 years ago)
- Last Synced: 2024-10-25T00:05:40.847Z (12 days ago)
- Topics: apache, docker, docker-compose, firefly-iii, guide, linux, nextcloud, nfs, privacy, selfhosted, server
- Homepage: https://ovk.github.io/silverbox
- Size: 308 KB
- Stars: 61
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
Guide on how to build compact, silent and energy-efficient GNU/Linux home server that runs:
- **Unbound** as a forwarding DNS server that forwards queries to the DNS server of your choice and uses DNS-over-TLS and DNSSEC for
extra security and privacy.
- **NFS server** secured with Kerberos (clean NFSv4-only server).
- **Nextcloud** accessible over HTTP(S) with Let's Encrypt certificates (renewed automatically using Certbot with DNS challenge).
- **Transmission** BitTorent client that communicates only over a VPN connection.
- **SOCKS5 proxy server** that proxies traffic securely over a VPN connection.
- **Git server** for hosting Git repositories.
- **Borg and Rclone** for automatic encrypted incremental backups (both on-site and off-site).
- **Reverse proxy server** with HTTPS (using wildcard certificate) and basic authentication to access internal services.
- **Firefly III** for personal finances management.
- **Monit** for system monitoring and notifications.
- Script to automatically update DNS record pointing to server's public IP address (in case of dynamic IP).
The server also runs:
- SSH server.
- Docker engine (as most of the workloads are run as containers).
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](https://en.wikipedia.org/wiki/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](https://ovk.github.io/silverbox/#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:
- https://creativecommons.org/licenses/by-nc/4.0
- https://creativecommons.org/licenses/by-nc/4.0/legalcode