Skip to content

docs: Add local installation instructions#642

Merged
vishnoianil merged 1 commit intoinstructlab:mainfrom
alimaredia:local-install-instructions
Mar 6, 2025
Merged

docs: Add local installation instructions#642
vishnoianil merged 1 commit intoinstructlab:mainfrom
alimaredia:local-install-instructions

Conversation

@alimaredia
Copy link
Collaborator

Add a new README file in installers/podman to show how to start up the UI locally at localhost:3000
using installers/podman/ilab-ui-native-installer.sh

@alimaredia alimaredia force-pushed the local-install-instructions branch from ad9e4eb to 7ea70da Compare March 5, 2025 13:44
Copy link
Member

@vishnoianil vishnoianil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alimaredia Thanks for the PR. PR looks great. Couple of minute comments.


## Starting the UI

Once the ilab is set up, run `ilab-ui-native-installer.sh` with the usernam and password of your preference to start the UI up.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once the ilab is set up, run `ilab-ui-native-installer.sh` with the usernam and password of your preference to start the UI up.
Once the ilab is set up, run `ilab-ui-native-installer.sh` with the username and password of your preference to start the UI up.


A taxonomy is needed to start the UI. Without providing `--taxonomy-dir` to the script the default taxonomy used is the upstream taxonony in `~/.local/share/instructlab/taxonomy`.

The custom empty taxonomy can be used:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The custom empty taxonomy can be used:
The custom empty taxonomy can be used. Taxonomy must of git initialize repository.

The custom empty taxonomy can be used:

```bash
mkdir /home/user/ui-local/taxonomy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mkdir /home/user/ui-local/taxonomy
mkdir /home/user/ui-local/taxonomy
cd /home/user/ui-local/taxonomy
git config --global init.defaultBranch main

@alimaredia alimaredia force-pushed the local-install-instructions branch from 7ea70da to 2187bd5 Compare March 6, 2025 10:51
Add a new README file in installers/podman to show
how to start up the UI locally at localhost:3000
using installers/podman/ilab-ui-native-installer.sh

Signed-off-by: Ali Maredia <amaredia@redhat.com>
@alimaredia alimaredia force-pushed the local-install-instructions branch from 2187bd5 to 26b16d6 Compare March 6, 2025 11:03
@alimaredia
Copy link
Collaborator Author

@vishnoianil updated this PR with the fixes you suggested.

@vishnoianil vishnoianil merged commit 1e700b6 into instructlab:main Mar 6, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants