CARLOS

CARLOS runs your apps on hardware you control. A deployment is one object-store bucket, one or more Linux hosts running the carlos binary, and a DNS zone; you put a release live with carlos deploy, and the platform places it on instances, routes to it through a shared edge, and keeps TLS, config, secrets and replication working underneath it.

These pages cover the platform. They explain how it works, how to run a deployment, and how to ship apps onto one. Use the tutorials and guides for step-by-step help. Use the reference to find commands.

If you are a Carloku customer, the docs you want are at carloku.com. Carloku is CARLOS run for you, and it covers the parts you actually touch without the box-side machinery these pages spend most of their time on.

Tutorials

  • Run a Rails app Build a Rails 8 app into an image, ship it, and run it with a worker on your own boxes.
  • Laravel and Django What changes from the Rails guide for a Laravel or a Django app.

Guides

  • Rootfs apps What a rootfs app's image is started with, what it can write, and where it may run.
  • Stateless replicas Run more than one copy of each instance across your fleet. Learn what happens when a box stops.
  • High availability Keep a second server ready to take over your app, and see what happens when a server or its storage fails.
  • One instance per customer Give each customer their own instance, with a hub app for sign-in, shared data, shared keys and reports.
  • PDFs Render an invoice, attach it to an email, and use Gotenberg from your app.
  • Receiving scan results Ask for one object to be scanned, read the verdict, and verify the callback that tells you it is done.
  • Enable domain buying Configure the registrar, branded nameservers and prices for domain purchases.
  • Linked deployments Publish an app from your home deployment through your Carloku account, and what Carloku can and can't reach.
  • Rate limits Stop one visitor taking over an instance, set limits per instance, and roll them out safely.
  • Plans Give accounts limits, packs and sponsorship. Plans stay off until you configure a catalog.

CLI reference

  • The CLI Every carlos command, grouped by whether you are shipping an app, running a deployment, or on a box.

API reference

  • API reference The public API is not available yet. Use the CLI for now.

Every page

Browse the docs from A to Z.