Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,26 @@ An utility aimed at managing NBFS appliance using published NBFS REST APIs and [
> Table of Contents

- [Appliance Manager](#appliance-manager)
- [Setup Instruction](#setup-instruction)
- [Setup Instructions](#setup-instructions)
- [Instructions with custom options](#instructions-with-custom-options)
- [Appliance Manager UI](#appliance-manager-ui)

## Setup Instruction
## Setup Instructions

1. Get plugin manager code `make setup`.
2. Install dependencies `make install-proto-deps`.
3. Start appliance-manager server `make start`.
4. Open browser `http://{host}:8081`
Setting up Appliance Manager involves following steps:

> Manual instructions (i.e., without using make)
1. Setup requirements to run appliance manager by running `make setup`.
2. Start appliance-manager server `make start`.
3. Open browser <http://{{host}}:8081>

Setting up Appliance Manager involves following steps:
### Instructions with custom options

If you would like use your own built custom UI, or specify appliance manager to run on a specific port, refer to below instructions:

1. Get latest version of [Plugin Manager v2](https://github.com/VeritasOS/plugin-manager/tree/v2), and check out v2 branch. Build by running `make build` inside `plugin-manager` to get `pm` binary.
1. Set `PM_WEB` environment variable to point to `web` directory.
1. Set `PM_WEB` environment variable to point to your UI/web directory.
1. Start Plugin Manager server: `pm server -port <port-number>`.
1. Appliance Manager can now be accessed via `http://{{server}}:{{port-number}}/`.
1. Appliance Manager can now be accessed via <http://{{server}}:{{port-number}}/>.

## Appliance Manager UI

Expand Down
Loading