Repository navigation
docs: README を仕様書化し、docs を種類別に整理 - #5
Open
makoto-kamimura wants to merge 3 commits into
Open
makoto-kamimura wants to merge 3 commits into
makoto-kamimura wants to merge 3 commits into
Conversation
- backup-files.sh + cron: archive wp-content/uploads daily; extra targets (e.g. overlay apps' volumes) come from the untracked platform/backup-files.targets - ops-digest.sh: one daily summary of WAF / fail2ban / certificates / access / backups / disk, with items that need action listed first - n8n (profile=automation, 127.0.0.1 only): MCP tools for the report scripts, morning digest mail and hourly WAF threshold alert - keep server-specific pieces out of the repo: domain-specific WAF exclusions (*.local.conf), personal blog auto-post workflows and their env vars now live in the untracked overlay - scan the n8n image with Trivy
- README.md becomes the spec body: concept, Part 1 overview (features, services, basic flows, theme, roadmap), Part 2 technical (stack, system diagram, quick start, network, volumes, implementation notes, non-functional requirements) and an appendix with decisions and open questions; merges the WordPress-stack parts of the former design notes - drop demo-specific commands and links to untracked docs from README - docs/ is organized by kind (design / runbooks / incidents / automation / tasks); only docs/README.md and the .gitkeep files are tracked, contents stay out of this public repo
makoto-kamimura
force-pushed
the
docs/align-doc-structure
branch
from
September 29, 2026 04:28
340dd6b to
02e5e61
Compare
makoto-kamimura
changed the title
- drop the theme submodule; themes now live untracked under wp-content/themes/ like other server-specific pieces - initial-setup.sh activates THEME_SLUG from .env and skips when unset - move the theme's REST API WAF exclusion to the untracked *.local.conf - README: describe how to bring your own theme instead of the bundled one
makoto-kamimura
force-pushed
the
docs/align-doc-structure
branch
from
September 29, 2026 04:51
02e5e61 to
5a0011d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
README を「仕様書の本体」にし、
docs/を種類ごとのフォルダに分けました。あわせて、本番で動いている運用スクリプト（ファイルのバックアップ・運用ダイジェスト・n8n）を取り込み、このリポジトリを「セキュアな WordPress を簡易展開するソース」に絞るため、デモ固有・個人向けの部分は git 管理外へ分けています。変更内容
1. docs: README の構成を揃える（1886da0）
-f docker-compose.demo.yml前提のコマンドと、存在しないdoc/...へのリンクを削除docs/を design / runbooks / incidents / automation / tasks に分けた。中身は引き続き git 管理外で、追跡するのはdocs/README.mdと各フォルダの.gitkeepだけ（.gitignoreを/docs/**+ 例外に変更）2. feat: 運用スクリプトと n8n（f219998）
backup-files.sh+cron.d/files-backup: uploads を毎日 tar.gz で保存。追加の対象は git 管理外のplatform/backup-files.targetsから読むops-digest.sh: WAF・fail2ban・証明書・アクセス・バックアップ・ディスクを 1 通にまとめる。デモ DB の行は置き場所があるときだけ出す3. テーマを同梱しない（5a0011d）
wp-content/themes/に git 管理外で置き、.envのTHEME_SLUG（.env.exampleに追加）でinitial-setup.shが有効にする。未設定ならテーマの切り替えをスキップするREQUEST-900-EXCLUSION-RULES-BEFORE-CRS.local.confに移したgit 管理外へ分けたもの
nginx_data/modsec-rules/REQUEST-900-EXCLUSION-RULES-BEFORE-CRS.local.conf（overlay でマウント）docker-compose.demo.yml（overlay）.gitignoreに列挙platform/backup-files.targets.env.exampleのキーwp-content/themes/・*.local.conf本番で行った操作
nginx -tの後に reload した。テーマ API への攻撃風の本文は前後とも WAF を通過（400）、他のパスは前後とも 403、トップは 200 で変わらないことを確認した.envにTHEME_SLUGを追記した（compose は参照しないので再作成なし）nginx -tを通した確認
docker compose config --quiet（.env.exampleから。本体 + admin/stats/automation の profile 込み）platform/scripts全体、CI と同じ-e SC1091）backup-files.shの対象が変更前と同じ 5 件に解決される /ops-digest.shの出力が変わらないdocker compose config（.env.exampleと本番の.envの両方）が通るinitial-setup.sh、-e SC1091）