> ## Documentation Index
> Fetch the complete documentation index at: https://new-docs.simplecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Get started with SimpleCloud by creating your account and connecting your first server host

Getting started with SimpleCloud takes just a few steps. The dashboard will guide you through the entire process - this page provides an overview of what to expect.

## Create Your Account

<Steps>
  <Step title="Open the Dashboard">
    Go to the [SimpleCloud Dashboard](https://dash.simplecloud.app)
  </Step>

  <Step title="Sign In">
    Create an account or sign in using one of the following options:

    * **Magic Link** - Enter your email and receive a login link
    * **SSO** - Sign in with Google, Discord, or GitHub
  </Step>
</Steps>

## Create or Join a Network

After signing in, you'll choose how to get started:

<Tabs>
  <Tab title="Create New Network">
    1. Enter a name for your network (e.g., "My Minecraft Network")
    2. The URL slug is auto-generated but can be customized
    3. Optionally add a description
    4. Click **Create Network**

    The setup wizard will then guide you through installing the CLI and connecting your first server host.
  </Tab>

  <Tab title="Join Existing Network">
    1. Paste the invitation code you received
    2. Click **Join Network**
  </Tab>
</Tabs>

## Install the CLI

The setup wizard will display the installation command for you. Simply copy and run it in your terminal.

<Tabs>
  <Tab title="Linux / macOS">
    ```bash theme={null}
    /bin/bash -c "$(curl -fsSL https://get.simplecloud.app)"
    ```

    Verify the installation:

    ```bash theme={null}
    simplecloud --version
    ```
  </Tab>

  <Tab title="Windows">
    <Note>
      Windows support is coming soon.
    </Note>
  </Tab>
</Tabs>

## Connect Your Server Host

A server host is the machine that will run your Minecraft servers.

<Steps>
  <Step title="Run the Setup Command">
    The dashboard displays a setup command with your unique code. Copy and run it on your server:

    ```bash theme={null}
    simplecloud setup --code=YOUR_CODE
    ```
  </Step>

  <Step title="Wait for Setup">
    The setup will:

    * Check that all requirements are installed
    * Download necessary components
    * Register your machine as a server host
  </Step>

  <Step title="Done">
    Once complete, the dashboard automatically detects your server host and takes you to the main dashboard.
  </Step>
</Steps>

## Inviting Team Members

To add others to your network:

1. Go to **Settings** → **Members**
2. Click **Invite Member**
3. Enter their email and choose their role

## Troubleshooting

<AccordionGroup>
  <Accordion title="curl: command not found">
    **Symptom:** Install script fails because curl is not installed.

    **Solution:** Install curl for your system:

    ```bash theme={null}
    # Debian/Ubuntu
    sudo apt install curl

    # CentOS/RHEL
    sudo yum install curl

    # macOS
    brew install curl
    ```
  </Accordion>

  <Accordion title="Permission denied during install">
    **Symptom:** Install script fails with permission errors.

    **Cause:** Script needs write access to `/usr/local/bin`.

    **Solution:**

    * Run with sudo: `sudo /bin/bash -c "$(curl -fsSL ...)"`
    * Or install to a user directory and add to PATH
  </Accordion>

  <Accordion title="Network timeout or connection refused">
    **Symptom:** Install script hangs or fails to download.

    **Cause:** Firewall blocking outbound connections.

    **Solution:** Allow HTTPS (port 443) to:

    * `raw.githubusercontent.com`
    * `github.com`
  </Accordion>

  <Accordion title="Setup code not working">
    **Symptom:** `simplecloud setup --code=...` fails with invalid code error.

    **Cause:** Code expired or copied incorrectly.

    **Solution:**

    1. Generate a fresh code from the dashboard
    2. Copy the entire code without extra spaces
    3. Run the command immediately (codes expire quickly)
  </Accordion>

  <Accordion title="Server host not appearing in dashboard">
    **Symptom:** Setup completes but host doesn't show in dashboard.

    **Solution:**

    1. Check terminal for setup errors
    2. Verify serverhost is running: `sc status serverhost`
    3. Check network connectivity to SimpleCloud
    4. Review logs: `sc logs serverhost`
  </Accordion>

  <Accordion title="Requirements check failed">
    **Symptom:** Setup fails because required software is missing.

    **Solution:** Install missing requirements:

    | Requirement | Install Command                                                           |
    | ----------- | ------------------------------------------------------------------------- |
    | Java 21+    | `sudo apt install openjdk-21-jdk`                                         |
    | screen/tmux | `sudo apt install screen`                                                 |
    | Docker      | [docs.docker.com/engine/install](https://docs.docker.com/engine/install/) |
  </Accordion>
</AccordionGroup>