Quickstart: Difference between revisions

Latest revision as of 07:20, 1 June 2026

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 through Hack Club Auth. Age verification is handled by Hack Club Auth, not by Nest itself.

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 .pub). 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:

cat ~/.ssh/id_ed25519.pub

Windows (PowerShell):

type $env:USERPROFILE\.ssh\id_ed25519.pub

Windows (Command Prompt):

type %USERPROFILE%\.ssh\id_ed25519.pub

If it prints a long string starting with ssh-ed25519, 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 id_rsa.pub instead of id_ed25519.pub. If that prints a string starting with ssh-rsa, 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:

ssh-keygen -t ed25519

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:

cat ~/.ssh/id_ed25519.pub

Windows (PowerShell):

type $env:USERPROFILE\.ssh\id_ed25519.pub

Windows (Command Prompt):

type %USERPROFILE%\.ssh\id_ed25519.pub

Copy the entire line starting with ssh-ed25519 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 username):

ssh username@hackclub.app

The first time you connect, you'll see a message about the host's authenticity and a prompt asking whether to continue. Type yes and press Enter. You'll only be asked this once.

If you instead get Permission denied (publickey), 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 cat/type 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.

@@ Line 1: / Line 1: @@
-Before you can access your Nest container, you'll need to apply for a container at https://dashboard.hackclub.app. If you haven't already, you will be asked to verify your age through [https://auth.hackclub.com/ Hack Club Auth]. Age verification is not done by Nest.
+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 through [https://auth.hackclub.com/ Hack Club Auth]. Age verification is handled by Hack Club Auth, not by Nest itself.
-You'll be asked to pick a username, paste your public SSH key, and tell us what you'll use Nest for. Nest exclusively use SSH keys instead of passwords since they're easier and more secure.
+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.
-----If you're confused, here's how to create/find your SSH public key:
+'''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.
-. You might have already generated an SSH key! If you're unsure, use this command to check:<syntaxhighlight>
+----
-cat ~/.ssh/id_ed25519.pub
+If you're not sure how to find your public SSH key, here's how:
-</syntaxhighlight>If it returns a long string starting with <code>ssh-ed25519</code>, then you already have one! Just copy that entire thing!
+'''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 that command brought back "No such file or directory" or a similar issue, it means you don't have an SSH key. You can generate one now by running this command:<syntaxhighlight>
+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.
-ssh-keygen -t ed25519
-</syntaxhighlight>You can press enter during the prompts to use the default settings.
+If you have a SSH key copy it and skip step 2 and 3.
-. Now you'll need to copy that string of text. Run this command to show it:<syntaxhighlight>
+'''2. Generate a key (only if you don't have one).'''
-cat ~/.ssh/id_ed25519.pub
-</syntaxhighlight>It should return a long string starting with <code>ssh-ed25519</code>, just copy that entire thing!
+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.'''
-Once submitted, your application might take up to 72 hours for an admin to review, approve, or reject your application.
+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.
-Once your application has been accepted you can SSH into your new container using this command:<syntaxhighlight>ssh username@hackclub.app</syntaxhighlight>(Replace username with the username you applied with!)
+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 new Nest container! Now you can start hosting your projects.
+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!
+You can also manage your container at https://dashboard.hackclub.app. If you're unsure about the dashboard, read the [[Dashboard]] guide.