Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions cloud_docs/01-getting-started/01-installation.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
---
sidebar_label: Installation
title: Install scloud
sidebar_label: Install scloud
sidebar_class_name: sidebar-installation-icon
description: Install scloud, Serverpod Cloud's command-line interface, and authenticate it with your account.
---

# Installation
# Install scloud
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a nice scloud banner immage would really upsell this page

Copy link
Copy Markdown
Contributor Author

@developerjamiu developerjamiu Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will file a follow-up issue so it doesn't get lost. We don't have an scloud banner asset today, and I'd rather not ship a placeholder.


This page shows how to install `scloud`, Serverpod Cloud's command line interface, and how to authenticate it with your account. After completing these steps, you're ready to deploy your first Serverpod server.
This page shows how to install `scloud`, Serverpod Cloud's command-line interface, and authenticate it with your account. After completing these steps, you're ready to deploy your first Serverpod app.

## Prerequisites

Before installing the CLI, make sure you have the following:
Before installing the CLI, make sure you have:

- **Dart installed** Follow the official guide: [https://dart.dev/get-dart#install](https://dart.dev/get-dart#install)
- **A Serverpod Cloud account** Sign up at [https://console.serverpod.cloud/auth/signup](https://console.serverpod.cloud/auth/signup)
- **Dart installed.** Follow [Dart's install guide](https://dart.dev/get-dart#install).
- **A Serverpod Cloud account.** [Sign up for Cloud](https://console.serverpod.cloud/auth/signup).

## Install the Serverpod Cloud CLI

Install the `serverpod_cloud_cli` package globally using Dart to make the `scloud` command available:
Install `serverpod_cloud_cli` to make the `scloud` command available:

```bash
dart pub global activate serverpod_cloud_cli
dart install serverpod_cloud_cli
```

After installation, verify that the CLI is available:
Verify the CLI is available:

```bash
scloud version
Expand All @@ -38,4 +40,4 @@ Log in to your Serverpod Cloud account from the terminal:
scloud auth login
```

This command opens a browser window where you can authenticate your account. Once authentication completes, the CLI is authorized to manage your Serverpod Cloud projects.
This opens a browser window where you authenticate. Once authentication completes, the CLI is authorized to manage your Serverpod Cloud projects.
2 changes: 1 addition & 1 deletion cloud_docs/01-getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Getting started",
"label": "Get started",
"collapsed": false,
"className": "sidebar-icon-getting-started"
}
55 changes: 15 additions & 40 deletions cloud_docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,56 +3,31 @@ title: Introduction
sidebar_position: -1
sidebar_label: Introduction
sidebar_class_name: sidebar-introduction-icon
description: Serverpod Cloud is a managed hosting platform for Serverpod apps. Deploy from the command line; Cloud manages runtime, networking, database, and secrets.
---

# Introduction

**Serverpod Cloud** is a fully managed hosting platform for Serverpod apps. It lets you deploy and run your Serverpod backend from the command line or via CI/CD. The platform manages all infrastructure needed to run your service in production. It can seamlessly scale to any size, and pricing is predictable. Serverpod Cloud handles networking, load balancing, custom domain names, and your database.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a decision page. We are dropping some important keywords for the user here, like 'predictable pricing,' which is not listed below.

Serverpod Cloud is a managed hosting platform for Serverpod apps. You deploy and run your app with the `scloud` command-line interface, and use the web console for account setup, billing, and project dashboards.

This documentation covers account setup, installing and using the `scloud` command, deploying your server, configuring environments, and operating your services in production.

## Zero-configuration deployments

Deploy your Serverpod server directly from your project directory using the command line or integrate it into your CI/CD pipeline. No manual VM setup, container configuration, or infrastructure orchestration is needed.
Deploy is two commands. No Dockerfile, no container config, no infrastructure setup:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This first sentence "Deploy is two commands" is a bit fuzzy and confusing.
The actual deploy command after the launch is just scloud deploy.
Also, following this is the install command.

Does it mean something like "Your first deploy is two commands away"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjusted: reworded to "Your first deploy is two commands." which matches the install + launch sequence and avoids the "deploy" overload.


```bash
### Install the CLI tool
dart pub global activate serverpod_cloud_cli

### Launch your Serverpod project
dart install serverpod_cloud_cli
scloud launch
```

## Managed runtime and networking

Your deployment automatically receives a production-ready runtime environment with:

- Encrypted endpoints and certificates that work reliably with high loads and streaming data.
- Load balancing and automatic scaling to any size.
- Health checks for your backend and related services.

This allows your server to run reliably without configuring networking or reverse proxies.

## Managed database (optional)

Serverpod Cloud can provision and manage a production-grade PostgreSQL database for your project. When enabled, database migrations are applied automatically during deployment. All authentication tokens and keys are fully managed and configured, and your database is frequently backed up.

## Secure passwords and secrets

Manage secrets, passwords, and environment variables through the `scloud` CLI. Sensitive values are encrypted where applicable, allowing you to easily connect to 3rd party services while keeping your app's configuration out of your source code.

## Custom domains and web server

Attach your own domain to a deployment. TLS certificates are automatically provisioned and renewed. Serverpod Cloud will host both your backend service and a website preconfigured for a Flutter web app.

## Insights, logs, and diagnostics

Serverpod Cloud comes with Serverpod Insights, our visual log viewer, preconfigured (requires a database). This gives you access to our world-class logging and server monitoring.

## PubSub and caching
## What Cloud manages
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to use the Service's full name here.

Suggested change
## What Cloud manages
## What Serverpod Cloud manages


The Serverpod framework has built-in support for sending messages between your servers, and caching objects works out of the box. We are working on building a service native to Serverpod Cloud; in the meantime, it's easy to configure a 3rd party service.
- **Runtime and scaling.** Your app runs on a production runtime that scales automatically.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new lightweight list is great. However, a user considering Serverpod Cloud for a serious production app might want to delve deeper into each section, or a specific section. Perhaps link out to a page containing more details on each feature (ie preserve the lengthier explanations on an in-depth page).

- **Networking and TLS.** Encrypted endpoints and certificates work without configuration.
- **Managed Postgres** (optional). Cloud can provision a production-grade Postgres database with automatic migrations and backups.
- **Secrets and environment variables.** Manage sensitive values through `scloud`; values are encrypted where applicable.
- **Custom domains.** Attach your own domain; TLS certificates are provisioned and renewed. Cloud hosts both your backend and a preconfigured website for your Flutter web app.
- **Logs and inspection.** View logs in the CLI or in Serverpod Insights, the desktop log viewer (requires a database).
- **PubSub, caching, and file storage.** Supported through the Serverpod framework using third-party services today; managed services are on the roadmap.

## File storage buckets
## Where to go next

A fully managed file upload and storage service is planned for Serverpod Cloud. While it's being built, you can still use a 3rd party service, such as GCP or AWS, as these (and other compatible services) are supported by the Serverpod framework.
- [Install scloud](/cloud/getting-started/installation) to set up the CLI.
- [Deploy your first app](/cloud/getting-started/launch) for a guided first deploy.
Loading