Skip to content

Commit

Permalink
docs: even more updates and improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
dr460nf1r3 committed Aug 23, 2024
1 parent 313a488 commit 2c323c7
Show file tree
Hide file tree
Showing 26 changed files with 401 additions and 139 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.direnv
.idea
.pre-commit-config.yaml
.vault_pass
buildiso/**
57 changes: 40 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,28 @@
## General information

- Our current infrastructure is hosted in one of [these](https://www.hetzner.com/dedicated-rootserver/ax102).
- The only other server not being contained in this dedicated server is our mail server.
- Both servers are being backed up to Hetzner storage boxes via [Borg](https://www.borgbackup.org/).
- After multiple different setups, we settled on [NixOS](https://nixos.org/) as our main OS as it provides reproducible and atomically updated system states
- Most (sub)domains are protected by Cloudflare while also making use of its caching feature.
- The only other server not being contained in this dedicated server is our mail server, as well as a legacy build server.
- The first two mentioned servers are being backed up to Hetzner storage boxes via [Borg](https://www.borgbackup.org/).
- After multiple different setups, we settled on [NixOS](https://nixos.org/) as our main OS as it provides reproducible
and atomically updated system states
- Cloudflare protects Most (sub)domains while also making use of its caching feature.
Exemptions are services such as our mail server and parts violating Cloudflares rules such as proxying Piped content.
- Cloudflare Access in combination with Cloudflared is used to secure access to high-risk services such as admin panels.

## Quick links

- [Common maintenance tasks](https://docs.garudalinux.net/common)
- [Host: garuda-build](./hosts/garuda-build.md)
- [Host: garuda-mail](https://docs.garudalinux.net/hosts/garuda-mail)
- [Host: immortalis](https://docs.garudalinux.net/hosts/immortalis)

## Devshell and how to enter it

This NixOS flake provides a [devshell](https://github.com/numtide/devshell) which contains all deployment tools as well as handy aliases for common tasks.
The only requirement for using it is having the Nix package manager available. It can be installed on various distributions via the package manager or the following script ([click me for more information](https://zero-to-nix.com/start/install)):
This NixOS flake provides a [devshell](https://github.com/numtide/devshell)
which contains all deployment tools as well as handy aliases for common tasks.
The only requirement for using it is having the Nix package manager available.
It can be installed on various distributions via the package manager or the following
script ([click me for more information](https://zero-to-nix.com/start/install)):

```shell
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix -o nix-install.sh # Check its content afterwards
Expand All @@ -34,19 +40,36 @@ nix develop # The intended way to use the devshell
nix-shell # Legacy, non-flakes way if flakes are not available for some reason
```

This also sets up pre-commit-hooks and shows the currently implemented tasks, which can be executed by running the command.
This also sets up pre-commit-hooks and shows the currently implemented tasks, which can be executed by running the
command.

```shell
🔨 Welcome to Garuda's infra-nix shell ❄️

[[general commands]]

ansible-core - Radically simple IT automation
apply - Applies the infra-nix configuration pushed to the servers
clean - Runs the garbage collection on the servers
commitizen - Tool to create committing rules for projects, auto bump versions, and generate changelogs
deploy - Deploys the local NixOS configuration to the servers
manix - Fast CLI documentation searcher for Nix
mdbook - Create books from MarkDown
mdbook-admonish - Preprocessor for mdbook to add Material Design admonishments
mdbook-emojicodes - MDBook preprocessor for converting emojicodes (e.g. `: cat :`) into emojis 🐱
menu - prints this menu
nixos-install-tools - The essential commands from the NixOS installer as a package
pre-commit - Framework for managing and maintaining multi-language pre-commit hooks
prettier - Prettier is an opinionated code formatter
rsync - Fast incremental file transfer utility
update - Performs a full system update on the servers bumping flake lock

[infra-nix]

ansible-core - Radically simple IT automation
apply - Applies the infra-nix configuration previously deployed to the servers
buildiso-local - Spawns a local buildiso shell to build to ./buildiso (needs Docker)
buildiso-remote - Spawns a buildiso shell on the iso-runner builder
clean - Runs the garbage collection on the servers
deploy - Deploys the local NixOS configuration to the servers
update - Performs a full system update on the servers by bumping flake lock
update-forum - Updates the Discourse container of our forum
update-toolbox - Updates the locked Chaotic toolbox commit and deploys the changes
update-website - Updates the locked website commit and deploys the changes
buildiso-local - Spawns a local buildiso shell to build to ./buildiso (needs Docker)
buildiso-remote - Spawns a buildiso shell on the iso-runner builder
ipv6-generator - Generates random IPv6 addresses in our /64 subnet to help rorating them
update-forum - Updates the Discourse container of our forum
update-toolbox - Updates the locked Chaotic toolbox commit and deploys the changes

```
5 changes: 3 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Security Policy

If any vulnerability or security flaw is discovered please contact us directly via [team@garudalinux.org](mailto:team@garudalinux.org).
If any vulnerability or security flaw is discovered, please contact us directly
via [team@garudalinux.org](mailto:team@garudalinux.org).

We will try to respond within 24-48 hours on a best-effort basis.
We will try to respond within 2448 hours on a best-effort basis.
Loading

0 comments on commit 2c323c7

Please sign in to comment.