TIDE/README.md

39 lines
1.1 KiB
Markdown

# TIDE
TIDE is the website and NixOS module for the Torah Im Derech Eretz community.
It serves the static landing page at `torahimderecheretz.com`, deploys the
forum with NixOS Discourse, and configures its production Borg backup.
## Landing page
The landing page is a static HTML and CSS site in [`site`](./site). Build its
deployment package with:
```console
nix build .#landing-page
```
## NixOS module
Import `nixosModules.tide` or `nixosModules.default`, then provide the runtime
secret paths:
```nix
services.tide = {
enable = true;
secretFiles = {
adminPassword = "/run/secrets/tide-admin-password";
mailPassword = "/run/secrets/tide-mail-password";
secretKeyBase = "/run/secrets/tide-secret-key-base";
borgPassphrase = "/run/secrets/borg-passphrase";
borgPrivateKey = "/run/secrets/borg-private-key";
};
};
```
The module owns the landing page and forum hostnames, site identity, SMTP
configuration, and backup policy. The importing host owns secret provisioning
and ACME account configuration.
See [RECOVERY.md](./RECOVERY.md) for the database and state restoration
procedure.