diff --git a/README.md b/README.md index db8358c..60ee790 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,24 @@ Install docker on your system first. If you already have docker installed, you c ## Quickstart +### 0) Default Layout + +``` +project-root/ +├─ application/ +│ ├─ site1/ +│ ├─ site2/ +│ └─ ... +└─ LocalDevStack/ (this repository) +``` + +This layout is flexible. If you want a different projects folder, set `PROJECT_DIR` in your env. + +```bash +# supports relative/absolute path (recommended to use absolute path for less confusion) +PROJECT_DIR=/path/to/your/projects +``` + ### 1) Clone ```bash git clone https://github.com/infocyph/LocalDevStack.git diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 74269f9..2d4d294 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -42,15 +42,6 @@ Quick Start - :doc:`guides/tls-and-certificates` -Next steps ----------- - -- Domain and vhosts: :doc:`guides/domain-setup` -- Local TLS (mkcert + certify): :doc:`guides/tls-and-certificates` -- Node apps behind Nginx: :doc:`guides/node-apps` -- Encrypted secrets (SOPS + Age): :doc:`guides/secrets-sops-age` -- Notifications: :doc:`guides/notifications` - Directory Structure ------------------- @@ -135,3 +126,12 @@ Shells:: Notes: - ``lds core `` is intended to open the right runtime container shell for that domain. + +Next steps +---------- + +- Domain and vhosts: :doc:`guides/domain-setup` +- Local TLS (mkcert + certify): :doc:`guides/tls-and-certificates` +- Node apps behind Nginx: :doc:`guides/node-apps` +- Encrypted secrets (SOPS + Age): :doc:`guides/secrets-sops-age` +- Notifications: :doc:`guides/notifications`