Skip to content

Three steps to your first host.

Check the host, get the code, bring it up. Then sign in at your own console, create an organisation, and open your first workspace.

The commands use example values (203.0.113.10, kodela.example.com, you@example.com). Put in your own.

0-3next · check your host
example values
  1. Check your host

    Ubuntu 24.04 with systemd, Docker, Python 3.12, git, curl, jq, openssl. 8 GB RAM or more, 30 GB disk or more. Run the preflight: it changes nothing and tells you what is missing.

    on the host
    $ bin/host-preflight.sh

    Limit: it is read-only and reports three states: ok, bad, and could not test. "Could not test" is never a pass. The figures are the ones we run on, not a sizing guarantee.

  2. Get the code

    Repository access is shared on request with pilot teams. There is no public repository and no download link.

    Limit: Kodela is not open source today; the code is all rights reserved. Public source is marked soon and not promised.

    Ask for access
  3. Bring up the host

    From your checkout, check the target, then bring it up. It installs the services, the firewall and the front door, creates the first operator (it asks for a password of at least 12 characters), and checks itself with /api/readyz.

    your machine
    $ bin/provision-host --host 203.0.113.10 --user ops --check
    $ bin/provision-host --host 203.0.113.10 --user ops \
        --base-url https://kodela.example.com \
        --operator-email you@example.com
    once TLS is in front
    $ curl -s https://kodela.example.com/api/readyz
    $ bin/deploy verify

    Limit: bin/provision-host is new and has not yet been proven against a second machine. Readiness answers 503 and names the failing check until everything is in place. The readiness URL above assumes your TLS front end is already in place.

    The full bring-up

Then, on your own console

Everything after bring-up happens in the console on your host. Nothing is created for you anywhere else.

Sign inAs the operator you created, at your own base URL.there is no hosted sign-in
Create an organisationIt gets its own network, members and settings. Invite members; an invitation lasts 7 days.mail is off until you set up SMTP
Open a workspaceA container with a terminal, VS Code in the browser, preview and the agent CLIs.about 2 GB of memory each

Know this first

Four things the bring-up does not do for you. The rest are on known gaps.

  • TLS is yours to put in front. Plain HTTP until you do.
  • Egress starts in observe. It logs and lets through until you switch it to deny.
  • Mail is off until you configure SMTP. Until then, invitation links are shown to the admin.
  • Nothing schedules backups for you. Add a timer for bin/backup.

Need the code?

It is shared with pilot teams. Start with the guide, then tell us about your team.