Quick start

The fastest path to a running Octostar environment on a machine with internet access. For production tuning see Configuration; for air-gapped sites see Air-gapped installation.

1. Clone the repository

git clone <octostar-singlenode-repository-url>
cd octostar-singlenode

2. Provide your Docker Hub token

Either export it for the session:

export DOCKERHUB_TOKEN=<your-docker-hub-token>

…or set dockerHub.token in local-env.yaml (next step).

3. Create your configuration

cp local-env.template.yaml local-env.yaml
# edit local-env.yaml — at minimum set dockerHub.token if you didn't export it

Every setting in the template is commented and mirrors the default in defaults.yaml, so an almost-empty local-env.yaml is a valid starting point. See Configuration for the full reference.

4. Install

Against your cluster context:

./bin/install.sh --context <context-name>

💡 Don't have the CLI tools yet? — Add --install-tools to have the installer set up bc, kubectl, helm, and helmfile for you, and --install-utils for k9s and stern.

Run ./bin/install.sh -h to see all options (summarized in Online installation).

5. Trust the local certificate (optional)

For the default local.test domain the installer uses a self-signed certificate. To trust it on your machine:

./bin/install.sh --install-cert --context <context-name>

6. Verify

kubectl get pods -n octostar-main
kubectl get svc  -n octostar-main

Once pods are Running/Ready, browse to the platform at https://home.<domain> (default https://home.local.test).

Common follow-ups

# Update an existing installation to newer chart/image versions
./bin/update-existing.sh --context <context-name>

# Tear the environment down
./bin/destroy.sh --context <context-name>

See Upgrading and Operations & uninstallation for details.