Nest Wiki - User contributions [en]

Quickstart

2026-07-15T20:21:41Z

Admin: minor edit (comma)

Before you can access your Nest container, you'll need to apply for one at https://dashboard.hackclub.app. If you haven't already, you'll be asked to verify your age/identity through [https://auth.hackclub.com/ Hack Club Auth]. Age verification is handled by Hack Club Auth, not by Nest itself.

----''Nest operates differently than services you might have used before. There are 2 places you'll manage your Nest container:''

- The [https://dashboard.hackclub.app '''Dashboard'''] for starting/stopping, adding domains, creating backups, etc.

- Your '''terminal''' for pretty much everything. If you're on Windows, you can technically use Command Prompt or Powershell, but the Terminal app works best. It comes preinstalled on Win11 but on Win10, we would recommend installing it.

Your Nest container has no GUI, it is fully command line. This means you'll only be able to type and execute commands and will have no traditional desktop. There are a ton of external guides that can help you [https://ubuntu.com/tutorials/command-line-for-beginners#1-overview navigate this].

----You'll be asked to pick a username, paste your '''public''' SSH key, and tell us what you'll use Nest for. Nest uses SSH keys instead of passwords: they're more secure, and once set up you never type a password again.

'''Important:''' only ever paste your '''public''' key (the file ending in <code>.pub</code>). Never paste your private key (the matching file with no extension). Your public key is safe to share; your private key is not and should never leave your machine.

----
If you're not sure how to find your public SSH key, here's how:

'''1. Check whether you already have a key.'''

Linux/macOS:<syntaxhighlight>cat ~/.ssh/id_ed25519.pub</syntaxhighlight>Windows (PowerShell):<syntaxhighlight>type $env:USERPROFILE\.ssh\id_ed25519.pub</syntaxhighlight>Windows (Command Prompt):<syntaxhighlight>type %USERPROFILE%\.ssh\id_ed25519.pub</syntaxhighlight>
If it prints a long string starting with <code>ssh-ed25519</code>, you already have a key. Copy that entire line and skip to submitting it.

If you get "No such file or directory," you might have no key, or you might have an older RSA key. Run the same command again with <code>id_rsa.pub</code> instead of <code>id_ed25519.pub</code>. If that prints a string starting with <code>ssh-rsa</code>, use it instead.

''' 
If you have a SSH key already, copy it and skip step 2 and 3.\'''

'''2. Generate a key (only if you don't have one).'''

If neither command returned a key, create one:<syntaxhighlight>ssh-keygen -t ed25519</syntaxhighlight>
You can press Enter at each prompt to accept the defaults (this creates the key with no passphrase). Adding a passphrase when prompted is optional but more secure, since it protects the key if your machine is ever compromised.

'''3. Display your public key so you can copy it.'''

Linux/macOS:<syntaxhighlight>cat ~/.ssh/id_ed25519.pub</syntaxhighlight>Windows (PowerShell):<syntaxhighlight>type $env:USERPROFILE\.ssh\id_ed25519.pub</syntaxhighlight>Windows (Command Prompt):<syntaxhighlight>type %USERPROFILE%\.ssh\id_ed25519.pub</syntaxhighlight>
Copy the entire line starting with <code>ssh-ed25519</code> and paste it into the application.

----
Once submitted, your application may take up to 72 hours for an admin to review. You'll be notified whether it's approved or rejected. If it's rejected, you can should ask an admin in #nest-help on Slack.

Once approved, SSH into your container with (replace <code>username</code>):<syntaxhighlight>ssh username@hackclub.app</syntaxhighlight>
'''The first time you connect, you'll see a message about the host's authenticity and a prompt asking whether to continue. Type <code>yes</code> and press Enter. You'll only be asked this once.'''

If you instead get <code>Permission denied (publickey)</code>, the key you submitted probably doesn't match the one on your machine, or your SSH agent isn't using it. Check that the public key in the dashboard matches the output of the <code>cat</code>/<code>type</code> command above.

Congratulations, you're now inside your Nest container and can start hosting your projects.

You can also manage your container at https://dashboard.hackclub.app. If you're unsure about the dashboard, read the [[Dashboard]] guide.

Main Page

2026-07-13T21:07:34Z

Admin: improved getting started

Nest is a free Linux hosting service provided by [https://hackclub.app Hack Club] for teenagers to host their apps and projects for free.

=== Getting Started ===
To get started, check out the [[Quickstart]] guide, which walks you through creating an account, verifying that you are a student, logging in, and basic usage of Nest. '''Please read the [[Acceptable Use Policy]] and [[Limitations]] page before using Nest.''' You can also review our [[Nest Wiki:Privacy policy|privacy policy]] and [[Your data on nest|what happens to your data on Nest]]. There's also a list of [[Frequently Asked Questions]] that you really should read.

Please note that these guides only provide information on how to use and navigate Nest-specific services, so it may not cover every Linux question you might have. We recommend using external docs (like [https://ubuntu.com/tutorials this one]!) if you have Linux-related questions, but you can always get help from us in our help channel!

=== How to Use Nest Services: ===
* [[Dashboard]]
* [[Forgejo]]

=== Tool Guides: ===
* [[Using PM2|PM2]]
* [[Systemd]]
* [[Docker]]
* more coming soon...

=== Important Concepts: ===
* [[IPv6 vs IPv4]]

If you need further help, external resources are listed in each of the guides mentioned above, and you can always get help from fellow birds in [https://app.slack.com/client/E09V59WQY1E/C097AL5AUH0 #nest-help] on the [https://hackclub.com/slack Hack Club Slack].

=== Quick links ===
Dashboard: https://dashboard.hackclub.app

Forgejo: https://git.hackclub.app

Nest Status: https://status.hackclub.app/

Quickstart

2026-07-13T21:01:25Z

Admin: added more beginner stuff

Before you can access your Nest container, you'll need to apply for one at https://dashboard.hackclub.app. If you haven't already, you'll be asked to verify your age/identity through [https://auth.hackclub.com/ Hack Club Auth]. Age verification is handled by Hack Club Auth, not by Nest itself.

----''Nest operates differently than services you might have used before. There are 2 places you'll manage your Nest container:''

- The [https://dashboard.hackclub.app '''Dashboard'''] for starting/stopping, adding domains, creating backups, etc.

- Your '''terminal''' for pretty much everything. If you're on Windows, you can technically use Command Prompt or Powershell, but the Terminal app works best. It comes preinstalled on Win11 but on Win10, we would recommend installing it.

Your Nest container has no GUI, it is fully command line. This means you'll only be able to type and execute commands and will have no traditional desktop. There are a ton of external guides that can help you [https://ubuntu.com/tutorials/command-line-for-beginners#1-overview navigate this].

----You'll be asked to pick a username, paste your '''public''' SSH key, and tell us what you'll use Nest for. Nest uses SSH keys instead of passwords: they're more secure, and once set up you never type a password again.

'''Important:''' only ever paste your '''public''' key (the file ending in <code>.pub</code>). Never paste your private key (the matching file with no extension). Your public key is safe to share; your private key is not and should never leave your machine.

----
If you're not sure how to find your public SSH key, here's how:

'''1. Check whether you already have a key.'''

Linux/macOS:<syntaxhighlight>cat ~/.ssh/id_ed25519.pub</syntaxhighlight>Windows (PowerShell):<syntaxhighlight>type $env:USERPROFILE\.ssh\id_ed25519.pub</syntaxhighlight>Windows (Command Prompt):<syntaxhighlight>type %USERPROFILE%\.ssh\id_ed25519.pub</syntaxhighlight>
If it prints a long string starting with <code>ssh-ed25519</code>, you already have a key. Copy that entire line and skip to submitting it.

If you get "No such file or directory," you might have no key, or you might have an older RSA key. Run the same command again with <code>id_rsa.pub</code> instead of <code>id_ed25519.pub</code>. If that prints a string starting with <code>ssh-rsa</code>, use it instead.

If you have a SSH key copy it and skip step 2 and 3.

'''2. Generate a key (only if you don't have one).'''

If neither command returned a key, create one:<syntaxhighlight>ssh-keygen -t ed25519</syntaxhighlight>
You can press Enter at each prompt to accept the defaults (this creates the key with no passphrase). Adding a passphrase when prompted is optional but more secure, since it protects the key if your machine is ever compromised.

'''3. Display your public key so you can copy it.'''

Linux/macOS:<syntaxhighlight>cat ~/.ssh/id_ed25519.pub</syntaxhighlight>Windows (PowerShell):<syntaxhighlight>type $env:USERPROFILE\.ssh\id_ed25519.pub</syntaxhighlight>Windows (Command Prompt):<syntaxhighlight>type %USERPROFILE%\.ssh\id_ed25519.pub</syntaxhighlight>
Copy the entire line starting with <code>ssh-ed25519</code> and paste it into the application.

----
Once submitted, your application may take up to 72 hours for an admin to review. You'll be notified whether it's approved or rejected. If it's rejected, you can should ask an admin in #nest-help on Slack.

Once approved, SSH into your container with (replace <code>username</code>):<syntaxhighlight>ssh username@hackclub.app</syntaxhighlight>
'''The first time you connect, you'll see a message about the host's authenticity and a prompt asking whether to continue. Type <code>yes</code> and press Enter. You'll only be asked this once.'''

If you instead get <code>Permission denied (publickey)</code>, the key you submitted probably doesn't match the one on your machine, or your SSH agent isn't using it. Check that the public key in the dashboard matches the output of the <code>cat</code>/<code>type</code> command above.

Congratulations, you're now inside your Nest container and can start hosting your projects.

You can also manage your container at https://dashboard.hackclub.app. If you're unsure about the dashboard, read the [[Dashboard]] guide.

Using PM2

2026-07-13T18:00:56Z

Admin: Admin moved page Using PM2 to PM2: Misspelled title

#REDIRECT [[PM2]]

PM2

2026-07-13T18:00:56Z

Admin: Admin moved page Using PM2 to PM2: Misspelled title

{{DISPLAYTITLE:PM2}}
Building a Discord/Slack bot? '''You should use PM2'''. PM2 is the easiest way to keep Node.js, Python, Bun, and other simple scripts running in the background. (If you're running a compiled backend service or something system-level, you should check out our guide on [[Systemd]]; it's likely a better fit!)

''Note: "My-bot" is used as a filler in commands. You should change this before running commands.''

==== 1. Installation ====
First, update your container and install both Node.js and npm using this command:<syntaxhighlight>
apt update && apt install nodejs npm -y
</syntaxhighlight>
Now, install PM2:<syntaxhighlight>
npm install -g pm2
</syntaxhighlight>

==== 2. Start Your Bot ====
Navigate to your project folder, then use the following commands to start your app, based on which language you're using.

'''Node.js:'''<syntaxhighlight>
pm2 start index.js --name "my-bot"
</syntaxhighlight>Python:<syntaxhighlight>
pm2 start app.py --name "my-bot" --interpreter python3
</syntaxhighlight>Bun:<syntaxhighlight>
pm2 start "bun run index.ts" --name "my-bot"
</syntaxhighlight>

==== 3. Make it Survive Reboots ====
When you inevitably need to restart or your LXC goes down, you want your bot to come back online without having to manually start it again. Run this command to make it survive reboots:<syntaxhighlight>
pm2 startup && pm2 save
</syntaxhighlight>Now you should be good to go!

==== 4. Additional/Useful Commands: ====
Listing all apps:<syntaxhighlight>
pm2 list
</syntaxhighlight>Checking logs:<syntaxhighlight>
pm2 logs my-bot
</syntaxhighlight>Restarting a bot/app:<syntaxhighlight>
pm2 restart my-bot
</syntaxhighlight>Stopping a bot/app:<syntaxhighlight>
pm2 stop my-bot
</syntaxhighlight>Viewing logs (this command shows the last 100 lines):<syntaxhighlight>
pm2 logs my-bot --lines 100
</syntaxhighlight>

PM2

2026-07-13T17:59:15Z

Admin: changed systemd hyperlink

2026-05-21T19:40:05Z

Admin: Changed Cloudflare CNAME image

Dashboard

2026-05-21T19:38:09Z

Admin: Created Using Dashboard guide!

File:Example-Cloudflare-CNAME.png

2026-05-21T19:36:10Z

Admin: Admin uploaded a new version of File:Example-Cloudflare-CNAME.png

Example Cloudflare CNAME record for Nest reverse proxy.

File:Example-Cloudflare-CNAME.png

2026-05-21T19:33:57Z

Admin:

Example Cloudflare CNAME record for Nest reverse proxy.

File:Nest-Domains.png

2026-05-21T19:26:50Z

Admin:

Nest domains dashbord tab.

File:Nest-Dashboard.png

2026-05-21T18:22:46Z

Admin:

Screenshot of dashboard on the Nest Dashboard.

Frequently Asked Questions

2026-05-21T18:07:58Z

Admin: added a semicolon!

'''What is Nest? What do I get?'''

Nest is a free Linux hosting service provided by [https://hackclub.com Hack Club] for teenagers to host their apps and projects for free. You can host websites, Discord bots, really anything that doesn't go against the [[Acceptable Use Policy]]! Everyone gets 2 cores, 2 GB memory and 16 GB storage by default; you can request more [https://nest.fillout.com/resources here].

'''How can I get started?'''

Visit the [[Quickstart]] Guide!

'''How can i make my services run in the background?'''

Read our guide on [[Using PM2]] and [[Using Systemd]]!

'''How can i complain about the nest admins?'''

Please send an email to root [at] hackclub [dot] app

'''Is nest down?'''

Stop saying nest is broken or "nest is down". You're going to need to actually say what you're having issues with. If you're using SSH, use <code>ssh -vvv username@hackcub.app</code> and put those logs there. If you can't access USERNAME.hackclub.app? Say that, give the (sub)domain and give logs. https://status.hackclub.app/status/nest says nest is down? We already know.

'''Can i host ___?'''

As long as it's not abusive and not against [[Acceptable Use Policy|the acceptable use policy]] then yes.

'''Do i get my own IP?'''

You do not get your own public IPv4, but you do get a public IPv6. We have a reverse proxy which you can use to proxy your websites without needing your own dedicated IP.

'''Is there a limit to the number of ports that can be opened?''' '''Are any ports blocked?'''

65535 is the limit for ports, and port 25 is blocked to prevent malicious email spam.

'''Can i portscan on nest?'''

No, you will be banned.

'''Why is ID verification taking so long?'''

We do not know, it's not in our control. ID verification is done by [https://auth.hackclub.com HCA].

IPv6 vs IPv4

2026-05-21T16:22:33Z

Admin: Created page with "IPv6 is the upgraded successor to IPv4, and consist of hexadecimal values instead of integers. An IPv6 looks something like <code>2a01:4f9:3081:399c::1</code>, while an IPv4 looks like <code>1.1.1.1</code>. IPv6 using 128-bit alphanumerical values compared to IPV4's 32-bit numbers means that there are way more possible IPv6 addresses (340 undecillion compared to 4.3 billion), this means that they are also way cheaper. While an IPv4 from Hetzner is ~2$/month, most serve..."

IPv6 is the upgraded successor to IPv4, and consist of hexadecimal values instead of integers. An IPv6 looks something like <code>2a01:4f9:3081:399c::1</code>, while an IPv4 looks like <code>1.1.1.1</code>. IPv6 using 128-bit alphanumerical values compared to IPV4's 32-bit numbers means that there are way more possible IPv6 addresses (340 undecillion compared to 4.3 billion), this means that they are also way cheaper.

While an IPv4 from Hetzner is ~2$/month, most servers come with a free /64 IPv6 block, which is over 18 quintillion IPs. This means we can give everyone a free public IPv6, while it would be too expensive to give everyone an IPv4. If you need to expose a web service you can use the reverse proxy, but if you need to directly access a port you cannot do that over IPv4, and you have to use IPv6.

You can view your public IPv6 on the dashboard.

==== IPv6 Support ====
Currently, IPv6 support worldwide sits at around 45%, to test if you can use IPv6 you can use https://test-ipv6.com/.

==== Binding to IPv6 ====
To bind to IPv6, you need to use <code>::</code> instead of <code>0.0.0.0</code>, <code>::</code> will bind to all interfaces, including IPv4. You can then access your service with <code>[ipv6]:port</code> for example <code>[2a01:4f9:3081:399c::1]:8080</code>. And if you want to point a domain at your ipv6 you can do so with a AAAA record.

Main Page

2026-05-21T15:22:30Z

Admin: /* Getting Started */

Nest is a free Linux hosting service provided by [https://hackclub.app Hack Club] for teenagers to host their apps and projects for free.

=== Getting Started ===
To get started, check out the [[Quickstart]] guide, which walks you through creating an account, verifying that you are a student, logging in, and basic usage of Nest. '''Please read the [[Acceptable Use Policy]] and [[Limitations]] page before using Nest.''' You can also review our [[Nest Wiki:Privacy policy|privacy policy]] and [[Your data on nest|what happens to your data on Nest]]. There's also a list of [[Frequently Asked Questions]] that you really should read.

===== Nest Services: =====

* [[Dashboard]]
* [[Forgejo]]

===== Tool Guides: =====

* [[Using PM2|PM2]]
* [[Systemd]]
* [[Docker]]
* more coming soon...

===== Important Concepts: =====

* [[IPv6 vs IPv4]]

If you need further help, external resources are listed in each of the guides mentioned above, and you can always get help from fellow birds in [https://app.slack.com/client/E09V59WQY1E/C097AL5AUH0 #nest-help] on the [https://hackclub.com/slack Hack Club Slack].

=== Quick links ===
Dashboard: https://dashboard.hackclub.app

Forgejo: https://git.hackclub.app

Nest Status: https://status.hackclub.app/status/nest

Main Page

2026-05-21T15:21:15Z

Admin: /* Getting Started */

Nest is a free Linux hosting service provided by [https://hackclub.app Hack Club] for teenagers to host their apps and projects for free.

=== Getting Started ===
To get started, check out the [[Quickstart]] guide, which walks you through creating an account, verifying that you are a student, logging in, and basic usage of Nest. '''Please read the [[Acceptable Use Policy]] and [[Limitations]] page before using Nest.''' You can also review our [[Nest Wiki:Privacy policy|privacy policy]] and [[Your data on nest|what happens to your data on Nest]]. There's also a list of [[Frequently Asked Questions]] that you really should read.

===== Nest Services: =====

* [[Dashboard]]
* [[Forgejo]]

===== Tool Guides: =====

* [[Using PM2|PM2]]
* more coming soon...

===== Important Concepts: =====

* [[IPv6 vs IPv4]]

If you need further help, external resources are listed in each of the guides mentioned above, and you can always get help from fellow birds in [https://app.slack.com/client/E09V59WQY1E/C097AL5AUH0 #nest-help] on the [https://hackclub.com/slack Hack Club Slack].

=== Quick links ===
Dashboard: https://dashboard.hackclub.app

Forgejo: https://git.hackclub.app

Nest Status: https://status.hackclub.app/status/nest