Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-26 02:11:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Proxy local frontend to remote backend (#1452)

Browse Source 
* add server proxy configurations

* change address to host due to compliation warning

* adjust config sample to more accurately reflect production version
This commit is contained in:
Lucy C
2022-05-19 15:58:32 -06:00
committed by GitHub
parent 1023916390
commit 2b6e54da1e
5 changed files with 49 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
frontend/README.md
View File

@@ -25,6 +25,8 @@ v8.0.0
## Running locally with mocks
1. Clone the repository
```
git clone https://github.com/Start9Labs/embassy-os.git
cd embassy-os
@@ -34,7 +36,7 @@ npm ci
npm run build:deps
```
Copy `config-sample.json` and its contents to a new file `config.json`.
2. Copy `config-sample.json` and its contents to a new file `config.json`.
```
cp config-sample.json config.json
@@ -43,10 +45,30 @@ cp config-sample.json config.json
By default, "useMocks" is set to `true`.
Valid values for "maskAs" are `tor` and `lan`.
**Start the development server(s)**
3. Start the development server(s)
```
npm run start:ui
npm run start:setup-wizard
npm run start:diagnostic-ui
```
## Running locally with proxied backend
This section enables you to run a local frontend with a remote backend (eg. hosted on a live Embassy). It assumes you have completed Step 1 and Step 2 in the [section above](#running-locally-with-mocks)
1. Set `useMocks: true` in `config.json`
2. Create a proxy configuration file from the sample:
```
cp proxy.conf.json.sample proxy.conf.json
```
3. Change the target address to desired IP address in `proxy.conf.json`
4. Start the development server
```
npm run start:ui:proxy
```