@brezel/installer 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +81 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Brezel Installer
|
|
2
|
+
|
|
3
|
+
Official installer for Brezel ERP. This tool automates the setup of Brezel instances across different environments, including native Linux/macOS, Laravel Valet, and Docker.
|
|
4
|
+
|
|
5
|
+
## Fast-Track Installation
|
|
6
|
+
|
|
7
|
+
Run this command in your terminal to start the installation:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
curl -sL https://brezel.io/install.sh | bash
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- **Environment Validation:** Checks for Git, Node, NPM, and PHP 8.3+ before execution.
|
|
16
|
+
- **macOS Valet Support:** Automatically handles domain linking (`valet link`) and SSL configuration (`valet secure`).
|
|
17
|
+
- **Docker Integration:** Complete containerized setup including service orchestration and networking.
|
|
18
|
+
- **Native Setup:** Automates dependency installation and system configuration for bare-metal deployments.
|
|
19
|
+
- **System Components:** Optional automated setup for MariaDB, Nginx, SSL (Certbot), and Cron tasks.
|
|
20
|
+
- **Output Preview:** Provides real-time feedback for background tasks like Composer and NPM builds.
|
|
21
|
+
- **Non-Interactive Mode:** Full CLI support for automated deployments and CI/CD pipelines.
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
### Interactive Mode
|
|
26
|
+
Run the installer and follow the terminal prompts:
|
|
27
|
+
```bash
|
|
28
|
+
./install.sh
|
|
29
|
+
# OR
|
|
30
|
+
node dist/index.js
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Non-Interactive Mode
|
|
34
|
+
Specify configuration via CLI flags:
|
|
35
|
+
```bash
|
|
36
|
+
node dist/index.js \
|
|
37
|
+
--dir ./my-brezel \
|
|
38
|
+
--system production \
|
|
39
|
+
--mode native \
|
|
40
|
+
--url https://api.brezel.io \
|
|
41
|
+
--no-interactive
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### CLI Options
|
|
45
|
+
|
|
46
|
+
| Option | Description | Default |
|
|
47
|
+
| :--- | :--- | :--- |
|
|
48
|
+
| `-d, --dir` | Installation directory | `./brezel` |
|
|
49
|
+
| `-m, --mode` | Installation mode (`native`, `valet`, `docker`) | `native` |
|
|
50
|
+
| `-s, --system` | System/tenant name | `example` |
|
|
51
|
+
| `-u, --url` | API URL | `http://{system}.test` |
|
|
52
|
+
| `--spa-url` | SPA (frontend) URL | `http://localhost:5173` |
|
|
53
|
+
| `--php-path` | Path to PHP 8.3+ executable | `php` |
|
|
54
|
+
| `--gitlab-token` | GitLab Personal Access Token | (Prompted) |
|
|
55
|
+
| `--source-mode` | `clone` or `fork` | `clone` |
|
|
56
|
+
| `--components` | Optional components (`mariadb,nginx,ssl,cron`) | `""` |
|
|
57
|
+
| `--no-interactive`| Run without user prompts | `false` |
|
|
58
|
+
|
|
59
|
+
## Development
|
|
60
|
+
|
|
61
|
+
1. **Install Dependencies:**
|
|
62
|
+
```bash
|
|
63
|
+
npm install
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
2. **Build:**
|
|
67
|
+
```bash
|
|
68
|
+
npm run build
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
3. **Run Dev:**
|
|
72
|
+
```bash
|
|
73
|
+
npm run dev
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Prerequisites
|
|
77
|
+
|
|
78
|
+
- **Node.js:** v18+
|
|
79
|
+
- **Git:** Latest
|
|
80
|
+
- **Native/Valet:** PHP 8.3+ and Composer
|
|
81
|
+
- **Docker:** Docker Compose
|