Try it locally
Two ways to see the platform on your own machine. Neither is for production: secrets are throwaway and nothing is backed up off the machine.
Docker on localhost (fastest)
Needs Docker Engine 24+ with the Compose plugin, git, and ports 80 and 443 free.
git clone --depth 1 --branch v1.5.1 https://github.com/excalibase/excalibase.git
cd excalibase/deploy/single-host
./init.sh --domain localhost --admin-email you@example.com --apps --app-sandbox none
docker compose up -d
docker compose logs bootstrap
The bootstrap log prints the first admin's password once. Open
https://studio.localhost and sign in as admin. The edge signs
localhost certificates with its own CA, so the browser warns first; accept it for the trial.
--apps --app-sandbox none turns on container apps without a sandbox, so apps share your
kernel: fine for trying images you trust. With gVisor installed, drop
--app-sandbox none (see Single host).
Then, in Studio:
- Provision (sidebar) → a Postgres project. It is ready in about a minute.
- Databases → Tables → +: create
todoswithidandtitle, and add a row (or runCREATE TABLE todos (id serial primary key, title text not null)in the SQL Editor). - Next to
todos, the API permissions button: let theanonroleselectit. - Query it from a terminal, with the project id from Studio as
PROJECT:
curl -sk https://api.localhost/$PROJECT/api/v1/todos
curl -sk https://api.localhost/$PROJECT/graphql -H 'Content-Type: application/json' \
-d '{"query":"{ publicTodos { id title } }"}'
A request without a token runs as anon. Keys and tokens work as on the cloud: see
Connect to your project, with https://api.localhost as the base URL.
-
Containers → New container, image
traefik/whoami:v1.11.0(a tag or digest is required), port80, then Deploy. It opens athttps://<app>-<project>.apps.localhost.The platform pulls the image from its registry, as a cluster would: an image you only built locally (
docker build -t myapp .) fails withpull access denied. Push it to a registry first, Docker Hub, GHCR or one on this machine. For a registry on this machine such aslocalhost:5000, list it in.envasAPP_LOCAL_REGISTRIES=localhost:5000and deploy it by digest.
Stop it with docker compose down. To remove everything, including project databases and apps,
see Removing an install.
Kubernetes on k3d
The Kubernetes install, on a throwaway k3d cluster with Cilium as the network
plugin, as production runs. Needs Docker, k3d 5.6+, kubectl, helm 3.15+, about 8 GiB of free
memory and port 80 free.
1. Cluster with Cilium
k3d cluster create excalibase --servers 1 --agents 0 \
--k3s-arg "--disable=traefik@server:0" \
--k3s-arg "--flannel-backend=none@server:0" \
--k3s-arg "--disable-network-policy@server:0" \
-p "80:30080@server:0" --wait
docker exec k3d-excalibase-server-0 mount --make-rshared /
NODE_IP=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' k3d-excalibase-server-0)
helm repo add cilium https://helm.cilium.io
helm install cilium cilium/cilium --version 1.19.6 -n kube-system \
--set ipam.mode=kubernetes --set k8sServiceHost="$NODE_IP" --set k8sServicePort=6443 \
--set operator.replicas=1 --wait --timeout 10m
2. Operators and the edge: the same as for production, with HAProxy on a NodePort instead of host ports:
kubectl apply --server-side -f https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/release-1.30/releases/cnpg-1.30.1.yaml
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.16.2/cert-manager.yaml
kubectl -n cnpg-system wait --for=condition=available deployment/cnpg-controller-manager --timeout=300s
kubectl -n cert-manager wait --for=condition=available deployment --all --timeout=300s
kubectl apply --server-side -f https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v0.15.0/manifest.yaml
kubectl -n cnpg-system rollout status deployment/barman-cloud --timeout=300s
helm repo add haproxytech https://haproxytech.github.io/helm-charts
helm install haproxy haproxytech/kubernetes-ingress --version 1.54.2 \
-n haproxy-controller --create-namespace \
--set controller.service.type=NodePort --set controller.service.nodePorts.http=30080 \
--set controller.containerPort.http=8080 --set controller.containerPort.https=8443 \
--set controller.ingressClass=haproxy --set controller.ingressClassResource.name=haproxy --wait
3. Local stand-ins: inside the cluster, the *.127.0.0.1.nip.io names must reach the edge as
they do from your browser, and apps need a RuntimeClass (k3d has no gVisor, so runc stands in):
kubectl apply -f - <<'YAML'
apiVersion: v1
kind: ConfigMap
metadata: { name: coredns-custom, namespace: kube-system }
data:
edge.override: |
rewrite name regex (.*)\.127\.0\.0\.1\.nip\.io haproxy-kubernetes-ingress.haproxy-controller.svc.cluster.local answer auto
---
apiVersion: node.k8s.io/v1
kind: RuntimeClass
metadata: { name: runc-local }
handler: runc
YAML
kubectl -n kube-system rollout restart deployment/coredns
4. Install the platform
cat > local-values.yaml <<'YAML'
provisioning:
studioUrl: http://localhost
publicBaseUrl: http://api.127.0.0.1.nip.io
backupCredentials: { provider: sts }
denoRuntime: { egressPolicy: cilium }
auth:
edge:
namespace: haproxy-controller
podLabels: app.kubernetes.io/name=kubernetes-ingress
podPorts: "8080"
podCIDRs: 10.42.0.0/16
objectStore:
bundled: { enabled: true }
email: { provider: noop }
ingress:
enabled: true
host: api.127.0.0.1.nip.io
tls: { enabled: false }
admin:
enabled: true
public: true
host: localhost
tls: { enabled: false }
appHosting:
enabled: true
domain: apps.127.0.0.1.nip.io
runtimeClass: runc-local
ingressFromNamespace: haproxy-controller
ingressFromLabels: app.kubernetes.io/name=kubernetes-ingress
observability:
serviceMonitors: { enabled: false }
vault:
unseal: { provider: plaintext, devPlaintext: true }
YAML
helm repo add excalibase https://excalibase.github.io/excalibase-service
helm repo update excalibase
helm install platform-aio excalibase/platform-aio --version 1.5.1 \
-n excalibase-platform --create-namespace -f local-values.yaml --timeout 15m
kubectl -n excalibase-platform wait --for=condition=complete job/platform-bootstrap --timeout=15m
kubectl -n excalibase-platform get secret platform-setup-token -o jsonpath='{.data.token}' | base64 -d; echo
Open http://localhost/setup, paste the setup token and create the admin
account with a password of your own. Then follow the same steps as above in Studio; the API is at
http://api.127.0.0.1.nip.io/<projectId>/graphql and apps at http://<app>-<project>.apps.127.0.0.1.nip.io.
nip.io is a public DNS name that answers 127.0.0.1. If your network's DNS refuses such answers,
the names will not resolve; use a resolver that allows them.
Remove it all with k3d cluster delete excalibase.