diff options
| -rw-r--r-- | README.md | 25 |
1 files changed, 22 insertions, 3 deletions
@@ -28,18 +28,37 @@ git clone <repo-url> && cd camagru # 2. Create your environment file cp .env.example .env -# Edit .env with your own values +# Edit .env with your own values (see "Environment variables" below) -# 3. Install dev tools +# 3. (Optional) Install dev tools — only needed for linting, not for running the app composer install # 4. Build and run docker-compose up --build # 5. Open in browser -# http://localhost:8080 +# App: http://localhost:8080 +# Email: http://localhost:8025 (MailPit — catches all outgoing emails) ``` +## Environment variables + +Copy `.env.example` to `.env` and fill in the values: + +| Variable | Purpose | +|----------|---------| +| `MYSQL_ROOT_PASSWORD` | MariaDB root password | +| `MYSQL_DATABASE` | Database name (default: `camagru`) | +| `MYSQL_USER` | Database user for the app | +| `MYSQL_PASSWORD` | Database user password | +| `APP_URL` | Base URL of the app (default: `http://localhost:8080`) — used in email links | +| `APP_SECRET` | Random string used for generating verification/reset tokens | +| `MAIL_FROM` | Sender address for outgoing emails | + +## Email in development + +All outgoing emails (verification, password reset, comment notifications) are caught by [MailPit](https://mailpit.axl.dev/) — nothing is actually sent. Open **http://localhost:8025** to view them. + ## Host setup (Manjaro) `phpactor` (LSP) requires the `iconv` extension. Install and enable it: |