easy-devops 0.2.1 → 0.2.2
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 +32 -3
- package/cli/menus/dashboard.js +22 -2
- package/core/nginx-conf-generator.js +4 -3
- package/dashboard/lib/nginx-service.js +19 -6
- package/dashboard/routes/domains.js +6 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,6 +21,7 @@ A unified DevOps management tool with interactive CLI and web dashboard for mana
|
|
|
21
21
|
|
|
22
22
|
- **Node.js 18+** (with npm)
|
|
23
23
|
- **Linux** (Debian/Ubuntu) or **Windows**
|
|
24
|
+
- ⚠️ **Windows users: PowerShell must be run as Administrator** (required for installing packages via winget, managing services, and SSL certificates)
|
|
24
25
|
- Optional: Nginx, Certbot, nvm (installed separately or via the tool)
|
|
25
26
|
|
|
26
27
|
## Installation
|
|
@@ -49,6 +50,8 @@ wget -qO- https://raw.githubusercontent.com/omar00050/Easy-DevOps/main/install.s
|
|
|
49
50
|
|
|
50
51
|
#### Windows (PowerShell)
|
|
51
52
|
|
|
53
|
+
> ⚠️ **Important:** Run PowerShell **as Administrator**. Right-click PowerShell → "Run as Administrator".
|
|
54
|
+
|
|
52
55
|
```powershell
|
|
53
56
|
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/omar00050/Easy-DevOps/main/install.ps1" -OutFile "install.ps1"; ./install.ps1
|
|
54
57
|
```
|
|
@@ -175,6 +178,20 @@ Manage Let's Encrypt SSL certificates using Certbot.
|
|
|
175
178
|
|
|
176
179
|
> **Note:** Renewing a certificate temporarily stops Nginx to free port 80, then restarts it automatically.
|
|
177
180
|
|
|
181
|
+
#### Windows Package Manager (winget)
|
|
182
|
+
|
|
183
|
+
Easy DevOps uses **winget** (Windows Package Manager) to install certbot and other packages on Windows. If winget is not installed, Easy DevOps will automatically prompt to install it using the [asheroto/winget-install](https://github.com/asheroto/winget-install) script.
|
|
184
|
+
|
|
185
|
+
**Installing winget manually:**
|
|
186
|
+
|
|
187
|
+
If you prefer to install winget separately, you can:
|
|
188
|
+
|
|
189
|
+
1. **Install from Microsoft Store:** Search for "App Installer" in the Microsoft Store
|
|
190
|
+
2. **Use the winget-install script:** [https://github.com/asheroto/winget-install](https://github.com/asheroto/winget-install)
|
|
191
|
+
3. **Official Microsoft documentation:** [https://learn.microsoft.com/en-us/windows/package-manager/winget/](https://learn.microsoft.com/en-us/windows/package-manager/winget/)
|
|
192
|
+
|
|
193
|
+
> **Note:** The embedded `winget-install.ps1` script in this project is sourced from [asheroto/winget-install](https://github.com/asheroto/winget-install) — a community-maintained, reliable installer for winget on Windows Server and systems without the Microsoft Store.
|
|
194
|
+
|
|
178
195
|
---
|
|
179
196
|
|
|
180
197
|
### Web Dashboard
|
|
@@ -187,7 +204,15 @@ Start the web dashboard:
|
|
|
187
204
|
npm run dashboard
|
|
188
205
|
```
|
|
189
206
|
|
|
190
|
-
Access at `http://localhost:
|
|
207
|
+
Access at `http://localhost:6443` (or configured port).
|
|
208
|
+
|
|
209
|
+
#### First-Time Login
|
|
210
|
+
|
|
211
|
+
Default credentials:
|
|
212
|
+
- **Username:** `admin`
|
|
213
|
+
- **Password:** Set in Settings menu or check your configuration
|
|
214
|
+
|
|
215
|
+
> **Tip:** From the Dashboard menu, select "How to use" for a quick guide on getting started.
|
|
191
216
|
|
|
192
217
|
#### Dashboard Pages
|
|
193
218
|
|
|
@@ -245,7 +270,8 @@ easy-devops/
|
|
|
245
270
|
│ ├── config.js # Configuration loader
|
|
246
271
|
│ ├── db.js # SQLite database (good.db)
|
|
247
272
|
│ ├── detector.js # System environment detection
|
|
248
|
-
│
|
|
273
|
+
│ ├── shell.js # Cross-platform shell executor
|
|
274
|
+
│ └── nginx-conf-generator.js # Nginx config file generator
|
|
249
275
|
├── dashboard/
|
|
250
276
|
│ ├── server.js # Express + Socket.io server
|
|
251
277
|
│ ├── routes/ # API endpoints
|
|
@@ -255,7 +281,10 @@ easy-devops/
|
|
|
255
281
|
├── data/
|
|
256
282
|
│ └── easy-devops.sqlite
|
|
257
283
|
└── lib/
|
|
258
|
-
└── installer/
|
|
284
|
+
└── installer/
|
|
285
|
+
├── install.ps1 # Windows bootstrap installer
|
|
286
|
+
├── install.sh # Linux/macOS bootstrap installer
|
|
287
|
+
└── winget-install.ps1 # Windows Package Manager installer
|
|
259
288
|
```
|
|
260
289
|
|
|
261
290
|
---
|
package/cli/menus/dashboard.js
CHANGED
|
@@ -139,6 +139,26 @@ function openBrowser(url) {
|
|
|
139
139
|
run(cmd).catch(() => {});
|
|
140
140
|
}
|
|
141
141
|
|
|
142
|
+
// ─── Usage Info ──────────────────────────────────────────────────────────────
|
|
143
|
+
|
|
144
|
+
function showUsageInfo() {
|
|
145
|
+
console.log(chalk.cyan('\n How to use the Dashboard:'));
|
|
146
|
+
console.log(chalk.gray(' ─'.repeat(40)));
|
|
147
|
+
console.log(' 1. Start the dashboard from this menu');
|
|
148
|
+
console.log(' 2. Open it in your browser (or visit the URL shown)');
|
|
149
|
+
console.log(' 3. Log in with the admin password from config');
|
|
150
|
+
console.log(' 4. Use the dashboard to:');
|
|
151
|
+
console.log(chalk.gray(' • Manage domains → create nginx configs'));
|
|
152
|
+
console.log(chalk.gray(' • View SSL certificates'));
|
|
153
|
+
console.log(chalk.gray(' • Control nginx (start/stop/reload)'));
|
|
154
|
+
console.log(chalk.gray(' • Edit nginx configuration files'));
|
|
155
|
+
console.log();
|
|
156
|
+
console.log(chalk.yellow(' Default login:'));
|
|
157
|
+
console.log(chalk.gray(' Username: admin'));
|
|
158
|
+
console.log(chalk.gray(' Password: (check your config or set one)'));
|
|
159
|
+
console.log();
|
|
160
|
+
}
|
|
161
|
+
|
|
142
162
|
// ─── Menu ─────────────────────────────────────────────────────────────────────
|
|
143
163
|
|
|
144
164
|
export default async function dashboardMenu() {
|
|
@@ -160,8 +180,8 @@ export default async function dashboardMenu() {
|
|
|
160
180
|
console.log();
|
|
161
181
|
|
|
162
182
|
const choices = status.running
|
|
163
|
-
? ['Open in browser', 'Stop dashboard', new inquirer.Separator(), '← Back']
|
|
164
|
-
: ['Start dashboard', new inquirer.Separator(), '← Back'];
|
|
183
|
+
? ['Open in browser', 'Stop dashboard', 'How to use', new inquirer.Separator(), '← Back']
|
|
184
|
+
: ['Start dashboard', 'How to use', new inquirer.Separator(), '← Back'];
|
|
165
185
|
|
|
166
186
|
let choice;
|
|
167
187
|
try {
|
|
@@ -257,7 +257,8 @@ export function buildConf(domain, nginxDir, certbotDir) {
|
|
|
257
257
|
|
|
258
258
|
// Logging
|
|
259
259
|
if (advanced?.accessLog) {
|
|
260
|
-
|
|
260
|
+
const logDir = isWindows ? `${nginxDir.replace(/\\/g, '/')}/logs` : '/var/log/nginx';
|
|
261
|
+
mainBlock.push(` access_log ${logDir}/${name}.access.log;`);
|
|
261
262
|
}
|
|
262
263
|
|
|
263
264
|
// ─── Location Block ─────────────────────────────────────────────────────────
|
|
@@ -301,10 +302,10 @@ export function buildConf(domain, nginxDir, certbotDir) {
|
|
|
301
302
|
mainBlock.push(` error_page 500 502 503 504 /50x.html;`);
|
|
302
303
|
}
|
|
303
304
|
if (security.custom404) {
|
|
304
|
-
mainBlock.push(` location = /404.html { root /usr/share/nginx/html; internal; }`);
|
|
305
|
+
mainBlock.push(` location = /404.html { root ${isWindows ? nginxDir.replace(/\\/g, '/') + '/html' : '/usr/share/nginx/html'}; internal; }`);
|
|
305
306
|
}
|
|
306
307
|
if (security.custom50x) {
|
|
307
|
-
mainBlock.push(` location = /50x.html { root /usr/share/nginx/html; internal; }`);
|
|
308
|
+
mainBlock.push(` location = /50x.html { root ${isWindows ? nginxDir.replace(/\\/g, '/') + '/html' : '/usr/share/nginx/html'}; internal; }`);
|
|
308
309
|
}
|
|
309
310
|
}
|
|
310
311
|
|
|
@@ -141,17 +141,26 @@ export async function start() {
|
|
|
141
141
|
throw new NginxNotFoundError('nginx binary not found');
|
|
142
142
|
}
|
|
143
143
|
|
|
144
|
-
//
|
|
144
|
+
// Ensure required directories exist on Windows
|
|
145
|
+
if (process.platform === 'win32') {
|
|
146
|
+
await fs.mkdir(path.join(nginxDir, 'logs'), { recursive: true });
|
|
147
|
+
await fs.mkdir(path.join(nginxDir, 'temp'), { recursive: true });
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
// Test config before starting with explicit config path on Windows
|
|
145
151
|
await ensureNginxInclude(nginxDir);
|
|
146
|
-
const
|
|
152
|
+
const testCmd = process.platform === 'win32'
|
|
153
|
+
? `${nginxExe} -c "${path.join(nginxDir, 'conf', 'nginx.conf')}" -t`
|
|
154
|
+
: `${nginxExe} -t`;
|
|
155
|
+
const testResult = await run(testCmd);
|
|
147
156
|
if (!testResult.success) {
|
|
148
157
|
return { success: false, output: combineOutput(testResult) };
|
|
149
158
|
}
|
|
150
159
|
|
|
151
|
-
// Start nginx
|
|
160
|
+
// Start nginx with explicit config path on Windows
|
|
152
161
|
if (process.platform === 'win32') {
|
|
153
|
-
|
|
154
|
-
const startCmd = `Start-Process -FilePath "${path.join(nginxDir, 'nginx.exe')}" -WorkingDirectory "${nginxDir}" -WindowStyle Hidden`;
|
|
162
|
+
const confPath = path.join(nginxDir, 'conf', 'nginx.conf');
|
|
163
|
+
const startCmd = `Start-Process -FilePath "${path.join(nginxDir, 'nginx.exe')}" -ArgumentList '-c','"${confPath}"' -WorkingDirectory "${nginxDir}" -WindowStyle Hidden`;
|
|
155
164
|
await run(startCmd, { timeout: 10000 });
|
|
156
165
|
} else {
|
|
157
166
|
const result = await run('nginx', { cwd: nginxDir, timeout: 15000 });
|
|
@@ -216,7 +225,11 @@ export async function test() {
|
|
|
216
225
|
}
|
|
217
226
|
|
|
218
227
|
await ensureNginxInclude(nginxDir);
|
|
219
|
-
|
|
228
|
+
// Use explicit -c flag on Windows to avoid path issues
|
|
229
|
+
const testCmd = process.platform === 'win32'
|
|
230
|
+
? `${nginxExe} -c "${path.join(nginxDir, 'conf', 'nginx.conf')}" -t`
|
|
231
|
+
: `${nginxExe} -t`;
|
|
232
|
+
const result = await run(testCmd);
|
|
220
233
|
return { success: result.success, output: combineOutput(result) };
|
|
221
234
|
}
|
|
222
235
|
|
|
@@ -18,7 +18,12 @@ function getNginxExe(nginxDir) {
|
|
|
18
18
|
|
|
19
19
|
function nginxTestCmd(nginxDir) {
|
|
20
20
|
const exe = getNginxExe(nginxDir);
|
|
21
|
-
|
|
21
|
+
// Use explicit -c flag on Windows to avoid path issues
|
|
22
|
+
if (isWindows) {
|
|
23
|
+
const confPath = `${nginxDir}\\conf\\nginx.conf`;
|
|
24
|
+
return `& "${exe}" -c "${confPath}" -t`;
|
|
25
|
+
}
|
|
26
|
+
return 'nginx -t';
|
|
22
27
|
}
|
|
23
28
|
|
|
24
29
|
function nginxReloadCmd(nginxDir) {
|
package/package.json
CHANGED