# Using GitHub Codespace

The easiest way to setup your Overleaf Pro is to use GitHub Codespace, where all environment variables are pre-configured to ensure you can use it out of the box.

{% hint style="warning" %}
When you run Docker containers using GitHub Codespaces, the Codespace will not automatically shut down and will continue to be **billed**. For GitHub Codespaces billing rules, please refer to [github codespaces billing rules](https://docs.github.com/en/billing/concepts/product-billing/github-codespaces).

To manage your GitHub Codespaces, please visit <https://github.com/codespaces>. When you no longer need it, please delete your Codespace in time.
{% endhint %}

We have **pre-configured** the following features:

* [x] Templates System
* [x] Public Register
* [x] Sandbox Compile
* [x] Git Bridge for overleaf
* [x] Review Panel

{% stepper %}
{% step %}

### Create Your GitHub Codespace

Click the following button to create you GitHub Codespace. In terms of server configuration, **2 cores with 8 GB of RAM** are generally sufficient for individual daily editing. If you plan to collaborate within a **small team**, we recommend choosing a configuration with **4 cores or more**.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/ayaka-notes/overleaf)
{% endstep %}

{% step %}

### Initialize Overleaf Instance

When your codespace is ready, run the following command in your bash to Initialize your overleaf instance.

{% code title="bash" %}

```bash
./init.sh
```

{% endcode %}

{% hint style="info" %}
You may need to wait for at least 3 mins before we pull all the docker images you need.
{% endhint %}

<figure><img src="/files/DhxAL7EDCx1pLYkrYf69" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Make 80 Port Available

Switch to the **Ports** tab, and then follow these steps to make the 80 port public.

<figure><img src="/files/cbdUz835RaWmK54wxenh" alt=""><figcaption></figcaption></figure>

After that, you can click the **Forwarede Address** to visit your overleaf instance. You may need to add `/launchpad` to visit overleaf welcome page.
{% endstep %}

{% step %}

### Create Your Admin Account

Input your admin account and password, then click Register button.

<figure><img src="/files/R71mkQBFuRHPTcjWJ5hT" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Enjoy Writing

Now, time to enjoy your $$\LaTeX$$ writing!

<figure><img src="/files/dJ7ac0d8OiY6jdkCfRBR" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://overleaf-pro.ayaka.space/on-premises/installation/using-the-github-codespace.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.