Open source or Cloud
Shellui is an open-source web app platform under the MIT license. You can run the shell and its services on infrastructure you control. Shellui does not offer that stack as a hosted service today.
On this page, Cloud means the hosted service on the waitlist. You leave an email there. Shellui sends an invite when a spot opens. Use this page to choose who operates the stack, then open the guide that matches that choice.
Choose self-hosting when you need control
Self-hosting means you run the processes. Choose it when you need the source on hosts you administer. You pick where data sits, and you keep provider credentials there.
You still pay for the machines, database, Redis, object storage, and mail provider you select. The MIT license covers the software. Your host and provider bills stay yours.
shellui build writes the shell as static files under dist/web/. Sign-in, files, previews, and mail are separate services you run beside it. Shellui does not publish one Docker Compose file that starts every service for production. Follow each service's production section.
Join the waitlist when you want a hosted service later
Join the hosted Shellui waitlist when you want a hosted service and you can wait for an invite. The waitlist page says the hosted service opens by invite, and that you can self-host today.
That page does not list regions, backups, a support commitment, or a status page. It does not list a feature set that exists only on the hosted service. The pricing page says Shellui is free to use, modify, and distribute. It describes paid help as consulting, and it says that help is not a hosted plan or a usage meter.
Hosted operations on this page are future work, and they are subject to availability. Where the table says nothing is published, that is an absence of a commitment. It is not a promise that Shellui will do the work.
Separate contributor setup from a deployment
Changing Shellui and running a deployment are different jobs.
Use Development when you change @shellui/cli, @shellui/core, or @shellui/sdk in this repository.
Use the local dev stack when you want the shell and the service checkouts on your machine. That Docker Compose file mounts your code and reloads on save. Some repositories in its clone list are private. Treat that page as a development environment.
For a deployment, follow the production section of each service you enable. Start with identity-service. storage-service, hosting-service, and email-service check the tokens it issues.
Compare the operating model
The shell, authentication, administration, and storage behave as these docs describe them. The table says who operates the surrounding infrastructure. It does not split product features between the two columns.
| Responsibility | Self-hosted | Hosted Shellui (Cloud) |
|---|---|---|
| Software | MIT source. You may run, modify, and redistribute it. | Same MIT project. The waitlist publishes no second feature set. |
| Hosting | You run the static shell and each service image you enable. | Invite-only. Join the waitlist. The waitlist publishes no host list. |
| Configuration | You set shellui.config.json and each service environment. | The waitlist stores an email. It does not open an account or a console. |
| Updates | You pin npm versions and image tags, then apply them. | No update policy is published. |
| Backups and recovery | You keep PostgreSQL or the service data volume, Redis, and the file store. The production sections do not document a Shellui backup job. | No recovery commitment is published. |
| Monitoring | You scrape Prometheus where a service documents metrics. You can set Sentry on production shell builds. | No uptime commitment is published in these docs. |
| Credentials and providers | You create the OAuth apps and store the mail provider credentials. | No credential vault is published. |
| Data placement | You choose the hosts, the database, and the blob backend. | No region or residency claim is published. |
Shared shell capabilities
Your app runs in an iframe inside the shell. The shell shares navigation, authentication, administration, and storage. You point them at the origins you run:
- Connect a backend: set
backend.urlto identity-service, use Supabase Auth, or omit sign-in - Authentication:
/login, sessions, andrequiresAuth - Administration: the staff admin iframe at
backend.adminUrl - Storage:
storage.url, quota, andshellui.storage
Email and hosting are further origins in the same config. Set email.url for email-service and hosting.url for hosting-service. On the shell identity server, the shell forwards those URLs to the iframe app. It does not start the services.
Open the next guide
Run the stack yourself:
- Install the CLI, then create a project.
- Build the static shell. Put
dist/web/on an origin you control. - Run identity-service, then follow Deploy to production and Security hardening.
- Add the services you need. Each guide has a production section: Run storage-service, Run hosting-service, and Run email-service.
- For previews, Deploy with the CLI.
shellui deployuploads a 7-day preview to hosting-service. It does not replace the production sections above. - Optional checks: identity metrics, email metrics, and Sentry for production shell builds.
Try a shell before you install, or ask for a hosted invite:
- Playground: a running shell in the browser
- Join the waitlist: an invite when the hosted service has a spot
Change the Shellui source:
- Development: this repository
- Local dev stack: service checkouts on your machine
Source is on GitHub. The content plan for this page is Open source or Cloud plan.