Move .env.install to docs/INSTALL.md as Markdown

2026-06-06 14:35:22 +02:00
parent bbefdce290
commit 4c085ac7eb
4 changed files with 103 additions and 62 deletions
@@ -1,59 +0,0 @@
-╔══════════════════════════════════════════════════════════════╗
-║           AtomCMS — Environment Installation Guide          ║
-╚══════════════════════════════════════════════════════════════╝
-
-Follow these steps to configure your environment:
-
-Step 1 ─ Choose your platform
-─────────────────────────────
-  Linux:   cp .env.example.linux .env
-  Windows: cp .env.example.windows .env
-
-Step 2 ─ Generate app key
-─────────────────────────
-  php artisan key:generate
-
-Step 3 ─ Edit database settings in .env
-───────────────────────────────────────
-  DB_DATABASE=habbo
-  DB_USERNAME=cms          # Linux: create a dedicated DB user
-  DB_USERNAME=root         # Windows: default MySQL user
-  DB_PASSWORD=your_secure_password
-
-Step 4 ─ Set your domain
-─────────────────────────
-  APP_URL=https://yourhotel.nl
-  SESSION_DOMAIN=.yourhotel.nl
-  SANCTUM_STATEFUL_DOMAINS=yourhotel.nl,www.yourhotel.nl
-  CORS_ALLOWED_ORIGINS=https://yourhotel.nl,https://www.yourhotel.nl
-
-Step 5 ─ Set to production
-───────────────────────────
-  APP_ENV=production
-  APP_DEBUG=false
-
-Step 6 ─ (Linux only) Configure Redis
-─────────────────────────────────────
-  sudo apt install redis-server
-  sudo systemctl enable --now redis-server
-
-Step 7 ─ Run migrations
-────────────────────────
-  php artisan migrate --seed
-
-Step 8 ─ Build frontend
-───────────────────────
-  yarn install && yarn build:all
-
-Step 9 ─ Set permissions (Linux)
-────────────────────────────────
-  sudo chown -R www-data:www-data storage bootstrap/cache public/build
-  sudo chmod -R 775 storage bootstrap/cache
-
-Step 10 ─ Restart PHP-FPM (Linux)
-─────────────────────────────────
-  sudo systemctl restart php8.5-fpm
-
-────────────────────────────────────────────────────────────────
-  Your hotel is now ready at: https://yourhotel.nl
-────────────────────────────────────────────────────────────────
@@ -44,7 +44,7 @@ php artisan migrate --seed
 yarn install && yarn build:all
 ```

-> **Full installation guide** → `.env.install` or scroll down to [Installation](#installation-ubuntu-2604)
+> **Full installation guide** → `docs/INSTALL.md` or scroll down to [Installation](#installation-ubuntu-2604)

 ---

@@ -115,7 +115,7 @@ bash update-Nitrov3.sh

 | File | Use | Cache | DB |
 |------|-----|-------|----|
-| `.env.install` | Step-by-step setup guide | — | — |
+| `docs/INSTALL.md` | Step-by-step setup guide | — | — |
 | `.env.example.linux` | Linux production | Redis | MariaDB |
 | `.env.example.windows` | Windows development | File | MySQL |

@@ -21,7 +21,7 @@
 - Complete README rewrite with badges, tables, quick start
 - All Dutch comments translated to English
 - XAMPP support removed (security warning added)
- `.env.example` → `.env.install` with step-by-step guide
+- `.env.example` → `docs/INSTALL.md` with step-by-step guide
 - `.env.standard` → `.env.example.linux` + `.env.example.windows`
 - Nitro V3 update moved from web UI to CLI (Linux-only)
 - Nitro V3 settings moved from database to `.env` file
@@ -0,0 +1,100 @@
+# AtomCMS — Installation Guide
+
+Follow these steps to configure your environment after cloning the repository.
+
+---
+
+## Step 1 — Choose your platform
+
+```bash
+# Linux
+cp .env.example.linux .env
+
+# Windows
+cp .env.example.windows .env
+```
+
+---
+
+## Step 2 — Generate app key
+
+```bash
+php artisan key:generate
+```
+
+---
+
+## Step 3 — Edit database settings in `.env`
+
+```
+DB_DATABASE=habbo
+DB_USERNAME=cms          # Linux: create a dedicated DB user
+DB_USERNAME=root         # Windows: default MySQL user
+DB_PASSWORD=your_secure_password
+```
+
+---
+
+## Step 4 — Set your domain
+
+```
+APP_URL=https://yourhotel.nl
+SESSION_DOMAIN=.yourhotel.nl
+SANCTUM_STATEFUL_DOMAINS=yourhotel.nl,www.yourhotel.nl
+CORS_ALLOWED_ORIGINS=https://yourhotel.nl,https://www.yourhotel.nl
+```
+
+---
+
+## Step 5 — Set to production
+
+```
+APP_ENV=production
+APP_DEBUG=false
+```
+
+---
+
+## Step 6 — (Linux only) Configure Redis
+
+```bash
+sudo apt install redis-server
+sudo systemctl enable --now redis-server
+```
+
+---
+
+## Step 7 — Run migrations
+
+```bash
+php artisan migrate --seed
+```
+
+---
+
+## Step 8 — Build frontend
+
+```bash
+yarn install && yarn build:all
+```
+
+---
+
+## Step 9 — Set permissions (Linux)
+
+```bash
+sudo chown -R www-data:www-data storage bootstrap/cache public/build
+sudo chmod -R 775 storage bootstrap/cache
+```
+
+---
+
+## Step 10 — Restart PHP-FPM (Linux)
+
+```bash
+sudo systemctl restart php8.5-fpm
+```
+
+---
+
+Your hotel is now ready at `https://yourhotel.nl`.