Skip to content

Add instructions for deploying to maincloud #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Mar 4, 2025
30 changes: 30 additions & 0 deletions docs/deploying/maincloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Deploy to Maincloud

Maincloud is a managed cloud service that provides developers an easy way to deploy their SpacetimeDB apps to the cloud.

## Deploy via CLI

1. Install the SpacetimeDB CLI for your platform: [Install SpacetimeDB](/install)
1. Create your module (see [Getting Started](/docs/getting-started))
1. Publish to Maincloud:

```bash
spacetime publish -s maincloud my-cool-module
```

## Connecting your Identity to the Web Dashboard

By logging in your CLI via spacetimedb.com, you can view your published modules on the web dashboard.

If you did not log in with spacetimedb.com when publishing your module, you can log in by running:
```bash
spacetime logout
spacetime login
```

1. Open the SpacetimeDB website and log in using your GitHub login.
1. You should now be able to see your published modules [by navigating to your profile on the website](/profile).

---

With SpacetimeDB Maincloud, you benefit from automatic scaling, robust security, and the convenience of not having to manage the hosting environment.
2 changes: 2 additions & 0 deletions docs/nav.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ const nav = {
section('Intro'),
page('Overview', 'index', 'index.md'), // TODO(BREAKING): For consistency & clarity, 'index' slug should be renamed 'intro'?
page('Getting Started', 'getting-started', 'getting-started.md'),
section('Deploying'),
page('Maincloud', 'deploying/maincloud', 'deploying/maincloud.md'),
section('Unity Tutorial - Basic Multiplayer'),
page('Overview', 'unity', 'unity/index.md'),
page('1 - Setup', 'unity/part-1', 'unity/part-1.md'),
Expand Down
3 changes: 3 additions & 0 deletions nav.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ const nav: Nav = {
page('Overview', 'index', 'index.md'), // TODO(BREAKING): For consistency & clarity, 'index' slug should be renamed 'intro'?
page('Getting Started', 'getting-started', 'getting-started.md'),

section('Deploying'),
page('Maincloud', 'deploying/maincloud', 'deploying/maincloud.md'),

section('Unity Tutorial - Basic Multiplayer'),
page('Overview', 'unity', 'unity/index.md'),
page('1 - Setup', 'unity/part-1', 'unity/part-1.md'),
Expand Down
2 changes: 1 addition & 1 deletion scripts/checkLinks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ function checkLinks(): void {
return; // Skip external links
}

const siteLinks = ['/install', '/images'];
const siteLinks = ['/install', '/images', '/profile'];
for (const siteLink of siteLinks) {
if (link.startsWith(siteLink)) {
return; // Skip site links
Expand Down