Using GitHub Codespace

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

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.

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

We have pre-configured the following features:

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.

Initialize Overleaf Instance

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

bash

./init.sh

You may need to wait for at least 3 mins before we pull all the docker images you need.

Make 80 Port Available

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

After that, you can click the Forwarede Address to visit your overleaf instance. You may need to add /launchpad to visit overleaf welcome page.

Create Your Admin Account

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

Enjoy Writing

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

PreviousIntroduction NextUsing the Toolkit

Last updated 4 hours ago

Was this helpful?

Good evening

hashtagCreate Your GitHub Codespace

hashtagInitialize Overleaf Instance

hashtagMake 80 Port Available

hashtagCreate Your Admin Account

hashtagEnjoy Writing

Create Your GitHub Codespace

Initialize Overleaf Instance

Make 80 Port Available

Create Your Admin Account

Enjoy Writing