mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 10:21:52 +00:00
800b0763e4
* complete get_primary_url fn * complete clear_network_interfaces fn * formatting * complete remove_address fn * get_system_smtp wip * complete get_system_smtp and set_system_smtp * add SetSystemSmtpParams struct * add set_system_smtp subcommand * Remove 'Copy' implementation from `HostAddress` Co-authored-by: Aiden McClelland <3732071+dr-bonez@users.noreply.github.com> * Refactor `get_host_primary` fn and clone resulting `HostAddress` Co-authored-by: Aiden McClelland <3732071+dr-bonez@users.noreply.github.com> * misc fixes and debug info * seed hosts with a tor address --------- Co-authored-by: Aiden McClelland <3732071+dr-bonez@users.noreply.github.com> Co-authored-by: Aiden McClelland <me@drbonez.dev>
StartOS Web
StartOS web UIs are written in Angular/Typescript and leverage the Ionic Framework component library.
StartOS conditionally serves one of four Web UIs, depending on the state of the system and user choice.
- install-wizard - UI for installing StartOS, served on localhost.
- setup-wizard - UI for setting up StartOS, served on start.local.
- diagnostic-ui - UI to display any error during server initialization, served on start.local.
- ui - primary UI for administering StartOS, served on various hosts unique to the instance.
Additionally, there are two libraries for shared code:
- marketplace - library code shared between the StartOS UI and Start9's brochure marketplace.
- shared - library code shared between the various web UIs and marketplace lib.
Environment Setup
Install NodeJS and NPM
Check that your versions match the ones below
node --version
v18.15.0
npm --version
v8.0.0
Install and enable the Prettier extension for your text editor
Clone StartOS and load the PatchDB submodule if you have not already
git clone https://github.com/Start9Labs/start-os.git
cd start-os
git submodule update --init --recursive
Move to web directory and install dependencies
cd web
npm i
npm run build:deps
Copy config-sample.json to a new file config.json.
cp config-sample.json config.json
- By default, "useMocks" is set to
true. - Use "maskAs" to mock the host from which the web UI is served. Valid values are
tor,local, andlocalhost. - Use "maskAsHttps" to mock the protocol over which the web UI is served.
truemeans https;falsemeans http.
Running the development server
You can develop using mocks (recommended to start) or against a live server. Either way, any code changes will live reload the development server and refresh the browser page.
Using mocks
Start the standard development server
npm run start:install-wiz
npm run start:setup
npm run start:dui
npm run start:ui
Proxying to a live server
In config.json, set "useMocks" to false
Copy proxy.conf-sample.json to a new file proxy.conf.json
cp proxy.conf-sample.json proxy.conf.json
Replace every instance of "<CHANGEME>" with the hostname of your remote server
Start the proxy development server
npm run start:ui:proxy