Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# LocalDevStack

LocalDevStack provides an easy-to-use Docker-based development environment for your projects.
All modules are **selective** and can be enabled via environment settings (Compose profiles).
Supports **multiple domains** and local TLS (mkcert).

> 1) Local development only.
> 2) Your domain(s) must be resolvable on your host:
> - add entries to your hosts file: `<your_ip> <your_domain>`, **or**
> - use a DNS that resolves to your machine, **or**
> - use `*.localhost` (no hosts entry required in many setups)

---

## Prerequisites (Docker)

Install docker on your system first. If you already have docker installed, you can skip this step.
- It is recommended to use [Docker Engine](https://docs.docker.com/engine/install/).
- If Docker Engine not supported in your OS, use [Docker Desktop](https://docs.docker.com/desktop/) (although you can also install this on linux as well).

---

## Quickstart

### 1) Clone
```bash
git clone https://github.com/infocyph/LocalDevStack.git
cd LocalDevStack
````

### 2) Permissions (Linux/macOS)

```bash
chmod +x ./lds 2>/dev/null || true
sudo ./lds setup permissions
```

### 3) Start the stack

```bash
lds start
```

### 4) Add a domain (vhost wizard)

```bash
lds setup domain
```

### 5) Optional: trust HTTPS locally (Root CA)

```bash
sudo lds certificate install
```

### 6) Reload HTTP (after vhost/cert changes)

```bash
lds http reload
```

---

## Minimal configuration

Most setups only need:

* `PROJECT_DIR` (where your apps live)
* `COMPOSE_PROFILES` (what to run)

Example:

```dotenv
PROJECT_DIR=../application
COMPOSE_PROFILES=nginx,php,php84,tools,mariadb,redis
```

---

## CLI help (built-in “man”)

```bash
lds help
lds help <command>
lds help setup
lds help certificate
```

---

## Documentation

This README stays intentionally short.

* Full documentation: **Read the Docs** (Sphinx docs in `docs/`)
* Quick reference: `lds help ...`

---

## License

MIT
245 changes: 0 additions & 245 deletions README.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/concepts/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Instead of a monolithic "one container does everything" model, LocalDevStack use
How containers cooperate
------------------------

1. You generate vhost configs (via ``server setup domain``).
1. You generate vhost configs (via ``lds setup domain``).
2. The Tools container can scan all vhosts and generate certificates.
3. Nginx loads hosts and routes requests either:

Expand Down
24 changes: 0 additions & 24 deletions docs/guides/node-apps.rst

This file was deleted.

Loading