diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..218885b --- /dev/null +++ b/profile/README.md @@ -0,0 +1,87 @@ +# ๐Ÿณ CasjaysDevDocker + +A curated collection of self-hostable Docker containers โ€” all built on a standardised Alpine-based foundation, designed for simplicity, consistency, and easy self-hosting. + +--- + +## ๐Ÿ“ฆ What's Here + +Every repository in this organisation is a single containerised application: + +| Category | Containers | +|----------|-----------| +| **Web & Proxy** | nginx, lighttpd, caddy, traefik, cherokee | +| **Databases** | mariadb, mysql, postgres, mongodb, couchdb, redis, valkey, sqlite | +| **Git & Dev** | gitea, forgejo, soft-serve, code, neovim, vim | +| **Media** | ampache, navidrome, icecast, mpd, ympd | +| **Cloud & Storage** | nextcloud, opencloud | +| **Languages & Runtimes** | nodejs, bun, deno, python, php | +| **Mail** | postfix, mailman | +| **Networking** | bind, ddns, tor, i2pd, ifconfig | +| **Utilities** | ntfy, gotify, apprise, aria2, transmission, pastebin, wttr, ssl-ca, tftpd, proftpd | +| **AI & LLMs** | ollama | +| **Desktop** | xfce4 | +| **CMS & Web Apps** | wordpress, jekyll, enclosed, opengist, webmin | +| **Downloads** | youtube-dl | + +--- + +## ๐Ÿ—๏ธ How Containers Are Built + +All images follow the same two-stage pattern: + +- **Stage 1** โ€” Alpine bootstrap: install `bash`, `ca-certificates`, and update trust store +- **Stage 2** โ€” `FROM scratch`: copy the full Alpine rootfs, layer in the application, and configure via environment variables + +Every container is generated and maintained using the **[gen-dockerfile](https://github.com/casjay-dotfiles/scripts)** tool, which produces consistent Dockerfiles, entrypoint scaffolding, and CI workflows across all repositories. + +--- + +## ๐Ÿš€ Quick Start + +```bash +docker pull casjaysdev/ +docker run -d \ + -e TZ=America/New_York \ + -p : \ + --name \ + casjaysdev/ +``` + +Each repository's `README.md` documents the available environment variables, ports, and volume mounts. + +--- + +## ๐Ÿ”ง Common Environment Variables + +All containers share a consistent set of environment variables: + +| Variable | Default | Description | +|----------|---------|-------------| +| `TZ` | `America/New_York` | Container timezone | +| `HOSTNAME` | `casjaysdev-` | Container hostname | +| `PORT` | service-specific | Primary service port | +| `ENV_PORTS` | service-specific | Additional exposed ports | +| `SERVICE_NAME` | image name | Name used for config/log paths | +| `CONTAINER_NAME` | image name | Internal container identifier | + +--- + +## ๐Ÿ“‚ Registry + +Images are published to: + +- **Docker Hub:** `docker.io/casjaysdev/` +- **Gitea Registry:** `git.casjay.pro/casjaysdevdocker/` + +--- + +## ๐Ÿ‘ค Maintainer + +๐Ÿค– **casjay** โ€” [GitHub](https://github.com/casjay) ยท [Website](https://casjay.pro) + +--- + +## ๐Ÿ“„ License + +MIT / WTFPL โ€” use freely.