Skip to content

Commit e2987cb

Browse files
committed
fix: add auto-accept option to setup scripts for non-interactive inst… (#862)
1 parent a4817e3 commit e2987cb

File tree

91 files changed

+8366
-4107
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+8366
-4107
lines changed

usecases/ai/edge-ai-demo-studio/.gitignore

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ tmp
2828

2929
/tests/coverity/*
3030
!/tests/coverity/coverity_scan.sh
31+
/tests/shellcheck/*
32+
!/tests/shellcheck/shellcheck_scan.sh
3133

3234
/build
3335

3436
*.log
3537
/out/*
3638
!/out/README.md
37-
!/out/run_web.sh
39+
!/out/start_web.sh
3840
!/out/setup.sh
39-
!/out/run_web.ps1
40-
!/out/setup.ps1
41+
!/out/start_web.bat
42+
!/out/setup.bat

usecases/ai/edge-ai-demo-studio/README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@ Edge AI Demo Studio is a modern toolkit for deploying, managing, and serving AI
1717
- Speech to Text (STT)
1818
- Embedding
1919
- Lipsync
20+
- Image Generation
21+
- MCP Manager
2022
- **Samples:** Samples use cases that implements the ai services
2123
- Digital Avatar
24+
- RAG Chat
2225

2326
## Architecture Diagram
2427
![Archictecture Diagram](./docs/Architecture.png)
@@ -47,9 +50,9 @@ For Linux:
4750
```bash
4851
./setup.sh
4952
```
50-
For Windows (PowerShell):
53+
For Windows (PowerShell/Command Prompt):
5154
```bash
52-
./setup.ps1
55+
./setup_win.bat
5356
```
5457

5558
This will:
@@ -64,9 +67,9 @@ For Linux:
6467
```bash
6568
./start.sh
6669
```
67-
For Windows (PowerShell):
70+
For Windows (PowerShell/Command Prompt):
6871
```bash
69-
./start.ps1
72+
./start_win.bat
7073
```
7174

7275
Once started, access the web UI at [http://localhost:8080](http://localhost:8080).
@@ -108,18 +111,6 @@ See [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) for deployment guidelines.
108111

109112
## FAQ
110113

111-
**Q: PowerShell script is not able to run. What should I do?**
114+
**Q: Why is Electron Skipped by default**
112115

113-
This is usually due to Windows PowerShell's execution policy restrictions. To allow scripts to run, open PowerShell as Administrator and run:
114-
115-
```powershell
116-
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
117-
```
118-
119-
When prompted, type `Y` to confirm.
120-
121-
**Note:** Only change the execution policy if you understand the security implications. You can revert to the default policy later with:
122-
123-
```powershell
124-
Set-ExecutionPolicy Restricted
125-
```
116+
This is because Electron is being used to create a packaged release only. If you need a packaged release, please refer to [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)
471 KB
Loading

usecases/ai/edge-ai-demo-studio/docs/DEPLOYMENT.md

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ This directory contains the Deployment instructions for Edge AI Demo Studio.
66

77
### Packaging the Electron App
88

9-
For Linux/macOS:
9+
For Linux:
1010
```bash
11-
../scripts/package.sh
11+
../scripts/bash/package.sh
1212
```
13-
For Windows (PowerShell):
13+
For Windows (PowerShell/Command Prompt):
1414
```bash
15-
../scripts/package.ps1
15+
../scripts/win/package.ps1
1616
```
1717

1818
This script will help ensure all dependencies are installed and configured correctly before packaging and then it will create the package in [electron/out](../electron/out).
1919

20+
If you have permission issue running the package script in Windows, please refer to [FAQ](#faq)
21+
2022
## Running on Ubuntu 24.04
2123

2224
If you're running the packaged Electron app on Ubuntu 24.04, you may need to adjust AppArmor settings to allow the application to run properly:
@@ -28,4 +30,47 @@ sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
2830
This command disables AppArmor restrictions on unprivileged user namespaces, which is required for Electron apps to function correctly on Ubuntu 24.04.
2931
## Prerequisites
3032

31-
Make sure you have ran the root setup script before running the commands above.
33+
Make sure you have ran the root setup script before running the commands above.
34+
35+
## FAQ
36+
37+
**Q: Why is Electron failed to install**
38+
39+
If you are running behind a proxy, please ensure you set proxy for Electron as below:
40+
41+
For Linux:
42+
```bash
43+
export ELECTRON_GET_USE_PROXY=http://proxy:port
44+
```
45+
46+
For Windows (PowerShell):
47+
48+
```powershell
49+
$env:ELECTRON_GET_USE_PROXY="http://proxy:port"
50+
```
51+
52+
**Q: Why do I not have permission to run PowerShell scripts?**
53+
54+
This is usually due to Windows PowerShell's execution policy restrictions.
55+
56+
**Quick Solution (Recommended):** Run the script with the `-ExecutionPolicy Bypass` flag each time:
57+
58+
```powershell
59+
powershell -ExecutionPolicy Bypass -NoProfile -File package.ps1
60+
```
61+
62+
This bypasses the execution policy for that single command without changing system settings.
63+
64+
**Alternative (Persistent Solution):** If you don't want to type the long command every time, you can change the execution policy for your entire PC. Open PowerShell as Administrator and run:
65+
66+
```powershell
67+
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
68+
```
69+
70+
When prompted, type `Y` to confirm.
71+
72+
**Note:** Only change the execution policy if you understand the security implications. `RemoteSigned` allows locally created scripts to run but requires downloaded scripts to be signed by a trusted publisher. You can revert to the default policy later with:
73+
74+
```powershell
75+
Set-ExecutionPolicy Restricted
76+
```

usecases/ai/edge-ai-demo-studio/electron/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This directory contains the Electron Builder implementation of Edge AI Demo Stud
1616
From the project root, run:
1717

1818
```bash
19-
# Linux/macOS
19+
# Linux
2020
./setup.sh
2121

2222
# Windows PowerShell
@@ -26,7 +26,7 @@ From the project root, run:
2626
Or setup just this directory:
2727

2828
```bash
29-
# Linux/macOS
29+
# Linux
3030
cd electron-builder
3131
./setup.sh
3232

0 commit comments

Comments
 (0)