{"id":15712399,"url":"https://github.com/ovk/silverbox","last_synced_at":"2025-05-05T21:34:05.510Z","repository":{"id":62268008,"uuid":"226545983","full_name":"ovk/silverbox","owner":"ovk","description":"Guide describing how to setup compact, silent and energy-efficient GNU/Linux home server","archived":false,"fork":false,"pushed_at":"2022-10-29T14:56:35.000Z","size":315,"stargazers_count":60,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T23:51:14.408Z","etag":null,"topics":["apache","docker","docker-compose","firefly-iii","guide","linux","nextcloud","nfs","privacy","selfhosted","server"],"latest_commit_sha":null,"homepage":"https://ovk.github.io/silverbox","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ovk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-07T16:50:25.000Z","updated_at":"2025-03-04T12:50:14.000Z","dependencies_parsed_at":"2022-10-29T16:27:02.486Z","dependency_job_id":null,"html_url":"https://github.com/ovk/silverbox","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovk%2Fsilverbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovk%2Fsilverbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovk%2Fsilverbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovk%2Fsilverbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ovk","download_url":"https://codeload.github.com/ovk/silverbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252580126,"owners_count":21771267,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache","docker","docker-compose","firefly-iii","guide","linux","nextcloud","nfs","privacy","selfhosted","server"],"created_at":"2024-10-03T21:16:00.424Z","updated_at":"2025-05-05T21:34:05.493Z","avatar_url":"https://github.com/ovk.png","language":null,"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/693072/70379633-1406bd80-18fd-11ea-82d6-209c2bb80f24.png\"\u003e\n\u003c/p\u003e\n\nGuide on how to build compact, silent and energy-efficient GNU/Linux home server that runs:\n\n- **Unbound** as a forwarding DNS server that forwards queries to the DNS server of your choice and uses DNS-over-TLS and DNSSEC for\nextra security and privacy.\n- **NFS server** secured with Kerberos (clean NFSv4-only server).\n- **Nextcloud** accessible over HTTP(S) with Let's Encrypt certificates (renewed automatically using Certbot with DNS challenge).\n- **Transmission** BitTorent client that communicates only over a VPN connection.\n- **SOCKS5 proxy server** that proxies traffic securely over a VPN connection.\n- **Git server** for hosting Git repositories.\n- **Borg and Rclone** for automatic encrypted incremental backups (both on-site and off-site).\n- **Reverse proxy server** with HTTPS (using wildcard certificate) and basic authentication to access internal services.\n- **Firefly III** for personal finances management.\n- **Monit** for system monitoring and notifications.\n- Script to automatically update DNS record pointing to server's public IP address (in case of dynamic IP).\n\nThe server also runs:\n\n- SSH server.\n- Docker engine (as most of the workloads are run as containers).\n\nThe latest HTML version of the guide is hosted online using GitHub Pages\nand can be viewed here: https://ovk.github.io/silverbox\n\n# Compiling\nThe guide is written in [AsciiDoc](https://en.wikipedia.org/wiki/AsciiDoc) format\nand can be compiled into different output formats, such as HTML or PDF.\n\nIf you have Docker installed, you can use Asciidoctor Docker container.\nFor example, to build HTML version:\n\n```\ngit clone https://github.com/ovk/silverbox.git\ndocker run -it --rm -v $(pwd)/silverbox:/documents asciidoctor/docker-asciidoctor asciidoctor silverbox-server.adoc\n```\n\nOr to build a PDF:\n\n```\ndocker run -it --rm -v $(pwd)/silverbox:/documents asciidoctor/docker-asciidoctor asciidoctor-pdf silverbox-server.adoc\n```\n\nThis should produce output file (`silverbox-server.html` or `silverbox-server.pdf`) in the `silverbox`\ndirectory, where all the placeholders replaced with your values.\n\nSee [Generating Custom Document](https://ovk.github.io/silverbox/#generating_custom_document)\nsection for more details.\n\n## Customizing Document\nMost of the configuration-specific parameters (such as IP addresses, host names, port numbers etc.)\nare not hardcoded, but defined using AsciiDoc attributes.\nThis way you can redefine these attributes with your specific parameter values\nand build your very own version of this document.\n\nBy default these parameter values contain simple placeholders,\nsuch as `{SERVER_IP_ADDR}` for the server local IP address.\nYou can replace them with the values you want by editing `parameters.adoc` file and then compiling the document.\n\n# License\nThis document is licensed under Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) License.\n\nFor more details see:\n\n- https://creativecommons.org/licenses/by-nc/4.0\n- https://creativecommons.org/licenses/by-nc/4.0/legalcode\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovk%2Fsilverbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fovk%2Fsilverbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovk%2Fsilverbox/lists"}