# belal-i/dokku-scrubs architecture

> Architecture diagram of the GitHub repository belal-i/dokku-scrubs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/belal-i/dokku-scrubs
- Repository: https://github.com/belal-i/dokku-scrubs

## Overview

Dokku Scrubs is a command-line wrapper for setting up production websites on Dokku. The documented workflow starts with a user invoking `dokku-scrubs` with an app and domain, optionally requesting Let’s Encrypt; the README also lists supported application types and multi-subdomain hosting. The tree suggests separate runtime modules for app, domain, database, certificate, and post-deploy work, but no source excerpts were provided, so their internal call relationships are not shown.

Main entry points: [`bin/dokku-scrubs`](https://github.com/belal-i/dokku-scrubs/blob/master/bin/dokku-scrubs) (Scrubs command), [`lib/letsencrypt.sh`](https://github.com/belal-i/dokku-scrubs/blob/master/lib/letsencrypt.sh) (Let’s Encrypt)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Command entry"]
  node_cli["Scrubs command"]
end

subgraph group_setup["Site setup"]
  node_init["Setup initialization<br/>[init.sh]"]
  node_app["App setup<br/>[app.sh]"]
  node_domains["Domain setup<br/>[domains.sh]"]
  node_database["Database setup<br/>[db.sh]"]
  node_certificates["Let’s Encrypt<br/>[letsencrypt.sh]"]
  node_postdeploy["Post-deploy work<br/>[post-deploy.sh]"]
end

subgraph group_config["Runtime configuration"]
  node_config["Configuration handling<br/>[config.sh]"]
  node_common["Shared routines<br/>[common.sh]"]
  node_filters["App filter rules<br/>[filter.d]"]
  node_jails["App jail rules<br/>[jail.d]"]
end

node_user(("Operator"))
node_dokku["Dokku platform"]
node_letsencrypt_service["Let’s Encrypt service"]

node_user -->|"invokes"| node_cli
node_cli -->|"wraps setup"| node_dokku
node_cli -->|"requests certificates"| node_certificates
node_certificates -->|"obtains certificates"| node_letsencrypt_service

click node_cli "https://github.com/belal-i/dokku-scrubs/blob/master/bin/dokku-scrubs"
click node_init "https://github.com/belal-i/dokku-scrubs/blob/master/lib/init.sh"
click node_app "https://github.com/belal-i/dokku-scrubs/blob/master/lib/app.sh"
click node_domains "https://github.com/belal-i/dokku-scrubs/blob/master/lib/domains.sh"
click node_database "https://github.com/belal-i/dokku-scrubs/blob/master/lib/db.sh"
click node_certificates "https://github.com/belal-i/dokku-scrubs/blob/master/lib/letsencrypt.sh"
click node_postdeploy "https://github.com/belal-i/dokku-scrubs/blob/master/lib/post-deploy.sh"
click node_config "https://github.com/belal-i/dokku-scrubs/blob/master/lib/config.sh"
click node_common "https://github.com/belal-i/dokku-scrubs/blob/master/lib/common.sh"
click node_filters "https://github.com/belal-i/dokku-scrubs/tree/master/etc/filter.d"
click node_jails "https://github.com/belal-i/dokku-scrubs/tree/master/etc/jail.d"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli toneBlue
class node_init,node_app,node_domains,node_database,node_certificates,node_postdeploy toneAmber
class node_config,node_common,node_filters,node_jails toneMint
class node_user,node_dokku,node_letsencrypt_service toneIndigo
```

## Components

### Command entry

- [Scrubs command](https://github.com/belal-i/dokku-scrubs/blob/master/bin/dokku-scrubs): `bin/dokku-scrubs`

### Site setup

- [Setup initialization](https://github.com/belal-i/dokku-scrubs/blob/master/lib/init.sh): `lib/init.sh`
- [App setup](https://github.com/belal-i/dokku-scrubs/blob/master/lib/app.sh): `lib/app.sh`
- [Domain setup](https://github.com/belal-i/dokku-scrubs/blob/master/lib/domains.sh): `lib/domains.sh`
- [Database setup](https://github.com/belal-i/dokku-scrubs/blob/master/lib/db.sh): `lib/db.sh`
- [Let’s Encrypt](https://github.com/belal-i/dokku-scrubs/blob/master/lib/letsencrypt.sh): `lib/letsencrypt.sh`
- [Post-deploy work](https://github.com/belal-i/dokku-scrubs/blob/master/lib/post-deploy.sh): `lib/post-deploy.sh`

### Runtime configuration

- [Configuration handling](https://github.com/belal-i/dokku-scrubs/blob/master/lib/config.sh): `lib/config.sh`
- [Shared routines](https://github.com/belal-i/dokku-scrubs/blob/master/lib/common.sh): `lib/common.sh`
- [App filter rules](https://github.com/belal-i/dokku-scrubs/tree/master/etc/filter.d): `etc/filter.d`
- [App jail rules](https://github.com/belal-i/dokku-scrubs/tree/master/etc/jail.d): `etc/jail.d`

### Other components

- **Operator**
- **Dokku platform**
- **Let’s Encrypt service**

## Connections

- Operator → Scrubs command: invokes (evidence: `README.md`)
- Scrubs command → Dokku platform: wraps setup (evidence: `README.md`)
- Scrubs command → Let’s Encrypt: requests certificates (evidence: `README.md`)
- Let’s Encrypt → Let’s Encrypt service: obtains certificates (evidence: `README.md`)
