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

# Erste Schritte auf Square Cloud mit Ruby

> Erfahre, wie du auf Square Cloud mit Ruby loslegst

## 🚀 Einführung

* Stelle vor dem Start sicher, dass Ruby auf deinem System installiert ist. Falls du es noch nicht hast, kannst du es von der [offiziellen Ruby-Website](https://www.ruby-lang.org/en/) herunterladen oder Versionsmanager wie [rbenv](https://github.com/rbenv/rbenv) oder [rvm](https://rvm.io/) verwenden.
* Anschließend musst du ein Konto bei Square Cloud erstellen, was über die [Anmeldeseite](https://squarecloud.app/de/signup) möglich ist. Du kannst dein Konto per E-Mail, GitHub oder beidem erstellen.
* Schließlich benötigst du einen aktiven kostenpflichtigen Plan in deinem Konto. Du kannst unsere Pläne ansehen und je nach Bedarf einen [hier](https://squarecloud.app/de/pricing) kaufen.

## ⚙️ Konfiguration der squarecloud.app-Datei

<Note>
  Wenn du deine Anwendung über die Square Cloud Website hochlädst, kannst du diesen Abschnitt ignorieren. Die Website erstellt die `squarecloud.app` Konfigurationsdatei automatisch für dich.
</Note>

<Card title="Mehr erfahren: So erstellst du die Konfigurationsdatei für Square Cloud." icon="link" href="https://docs.squarecloud.app/de/getting-started/config-file">
  Die squarecloud.app Datei ist eine Konfigurationsdatei, die zur
  Konfiguration deiner Anwendung verwendet wird; sie dient dazu, den Namen, die
  Beschreibung, die Version, die Hauptdatei und weiteres zu definieren.
</Card>

## 📄 Erforderliche Dateien

* main.rb (Beispiel für die Hauptdatei — dein Ruby-Einstiegspunkt).
* Gemfile (Abhängigkeitsdatei, falls du Bundler verwendest).
* Gemfile.lock (von Bundler erzeugt; empfohlen zur Aufnahme für reproduzierbare Builds).
* [squarecloud.app](https://docs.squarecloud.app/de/getting-started/config-file) (Datei mit der Square-Cloud-Konfiguration).

## ▶️ So startest du deine Anwendung

* Wenn das Feld `START` in der Konfigurationsdatei nicht definiert ist, führt Square Cloud `ruby MAIN` aus, wobei die in `MAIN` angegebene Datei die Ruby-Datei ist (z. B. `main.rb`). Ist das Feld `START` definiert, wird der darin enthaltene Wert direkt ausgeführt. In Anwendungen, die Bundler verwenden, ist es üblich, `START` als `bundle exec ruby main.rb` oder einen anderen geeigneten Startbefehl zu definieren. Weitere Informationen zu den Parametern der Konfigurationsdatei findest du unter [Konfigurationsparameter](https://docs.squarecloud.app/de/getting-started/config-file#configuration-parameters).

<Info>Für Ruby-Anwendungen, die **Bundler** verwenden, ist es wichtig, Umgebungsvariablen korrekt zu konfigurieren, um den Installationsprozess der Abhängigkeiten auf Square Cloud zu optimieren. Square Cloud führt die Bundler-Installation mithilfe von Umgebungsvariablen aus. Um unnötige Gem-Gruppen in der Produktion auszuschließen, konfiguriere die Variable `BUNDLE_WITHOUT=development:test`. Dies hilft außerdem, **Deprecations** aus **Bundler 2.x** zu entfernen.</Info>

## 🖥️ Vorbereitung des Projekts

Bevor du dein Projekt auf Square Cloud hostest, überprüfe, ob die Projektdateien ordnungsgemäß für das Hosting konfiguriert sind.

<Warning>Die Konfigurationsdatei (`squarecloud.app/.config`) muss sich im Stammverzeichnis der ZIP-Datei befinden. Andernfalls kann Square Cloud sie beim Deploy nicht finden.</Warning>

## 📤 So hostest du dein Projekt

Nachdem du nun alle Dateien für dein Ruby-Projekt vorbereitet hast, besteht der nächste Schritt darin, sie auf Square Cloud hochzuladen und deine Anwendung online zu stellen. Es gibt mehrere Möglichkeiten zum Hochladen, aber wir behandeln zwei: über das Dashboard oder über die CLI.

### Über das Dashboard

<Steps>
  <Step title="Upload-Seite aufrufen">
    Rufe die [Upload-Seite](https://squarecloud.app/de/dashboard/new) auf und lade die ZIP-Datei deines Projekts hoch.
  </Step>

  <Step title="Umgebung konfigurieren">
    Nachdem du deine ZIP-Datei hochgeladen hast, musst du den Namen, die Hauptdatei oder Runtime-Umgebung und weitere Einstellungen für dein Projekt konfigurieren.\
    Wenn du ein Web-Projekt hochlädst, achte darauf, "Web Publication" auszuwählen und deinem Projekt eine Subdomain zuzuweisen.
  </Step>

  <Step title="Projekt bereitstellen">
    Klicke abschließend auf die Schaltfläche "Deploy", um dein Projekt auf Square Cloud zu hosten.\
    Nach dem Deploy kannst du den Status und die Logs deines Projekts über das Dashboard überwachen.

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/dashboard/uploading.gif" alt="Anwendung wird auf Square Cloud hochgeladen" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>
</Steps>

### Über die CLI

Um diese Methode zu nutzen, musst du eine Konfigurationsdatei mit dem Namen `squarecloud.app` im Stammverzeichnis deines Projekts erstellen. Diese Datei enthält die notwendige Konfiguration für dein Projekt.

<Card title="Mehr erfahren: So erstellst du die Konfigurationsdatei für Square Cloud." icon="link" href="/de/getting-started/config-file">
  Die Datei squarecloud.app ist eine Konfigurationsdatei, mit der deine Anwendung konfiguriert wird; sie dient dazu, deine Umgebung zu definieren.
</Card>

<Steps>
  <Step title="CLI installieren">
    Zuerst musst du die CLI in deiner Umgebung installiert haben. Falls du sie noch nicht hast, führe den folgenden Befehl in deinem Terminal aus:

    ```
    npm install -g @squarecloud/cli
    ```

    Falls du sie bereits hast, empfehlen wir, sie zu aktualisieren. Führe dazu den folgenden Befehl in deinem Terminal aus:

    <Tabs>
      <Tab title="Windows">
        ```bash theme={null}
        squarecloud update
        ```
      </Tab>

      <Tab title="Linux, macOS und WSL">
        ```bash theme={null}
        curl -fsSL https://cli.squarecloud.app/install | bash
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Authentifizieren">
    Um dich zu authentifizieren und weitere CLI-Befehle zu nutzen, findest du deinen Autorisierungsschlüssel [hier](https://squarecloud.app/de/account/security), indem du auf "Request API Key" klickst. Nachdem du deinen Autorisierungsschlüssel erhalten hast, führe den folgenden Befehl aus:

    ```bash theme={null}
    squarecloud auth login
    ```
  </Step>

  <Step title="Projekt hochladen">
    Um deine Anwendung schließlich über die CLI auf Square Cloud bereitzustellen, musst du den folgenden Befehl ausführen:

    ```bash theme={null}
    squarecloud upload 
    ```

    Oder falls du die ZIP-Datei manuell erstellt hast, kannst du Folgendes verwenden:

    ```bash theme={null}
    squarecloud upload --file <path/to/zip> 
    ```
  </Step>
</Steps>

## Kontaktiere uns

Falls du weiterhin **technische Schwierigkeiten** hast, steht dir unser **spezialisiertes Support-Team** zur Verfügung. [**Kontaktiere uns**](https://squarecloud.app/de/support) und wir helfen dir gerne, jedes Problem zu lösen.