More actions
Re-wrote the custom domain section |
Improve consistency and make custom domains section more concise |
||
| Line 1: | Line 1: | ||
Whilst a subdomain of https://hackclub.app is automatically configured for you when you sign up for Nest, you'll need to use the [[Nest CLI]] to configure new subdomains under your user subdomain (https://<username>.hackclub.app). | Whilst a subdomain of https://hackclub.app is automatically configured for you when you sign up for Nest, you'll need to use the [[Nest CLI]] to configure new subdomains under your user subdomain (<code>https://<username>.hackclub.app</code>). | ||
== Subdomains == | == Subdomains == | ||
| Line 6: | Line 6: | ||
The Nest CLI will automatically configure the subdomain in the system and add a block to your Caddyfile to get you started. See [[Caddy]] for more information about the Caddyfile. | The Nest CLI will automatically configure the subdomain in the system and add a block to your Caddyfile to get you started. See [[Caddy]] for more information about the Caddyfile. | ||
If you'd like to remove a subdomain from the configuration, you can | If you'd like to remove a subdomain from the configuration, you can run | ||
nest subdomain remove <name> | nest subdomain remove <name> | ||
| Line 12: | Line 12: | ||
As well as having your <code>https://<username>.hackclub.app</code> subdomain, you can link a custom domain to your user account. | As well as having your <code>https://<username>.hackclub.app</code> subdomain, you can link a custom domain to your user account. | ||
To configure any custom domains for your user account, add a CNAME record to your domain leading to <code><username>.hackclub.app</code>. | To configure any custom domains for your user account, add a CNAME record to your domain leading to <code><username>.hackclub.app</code>. For example, if your username is <code>orpheus</code>, you would create a CNAME record with the value of <code>orpheus.hackclub.app</code> . | ||
If you are using Cloudflare or a similar DNS provider that reverse-proxies requests, make sure to uncheck "Proxy status" ( | If you are using Cloudflare or a similar DNS provider that reverse-proxies requests, make sure to uncheck "Proxy status" (the orange cloud on Cloudflare). | ||
Once this is done and the DNS has propagated, you can link your domain to your user account with the following command | Once this is done and the DNS has propagated, you can link your domain to your user account with the following command. For example, <code>orpheus</code> may run <code>nest domain add orpheus.com</code>. | ||
nest domain add <domain> | nest domain add <domain> | ||
Just like with normal subdomains, the Nest CLI will automatically configure the domain in the system and add a block to your Caddyfile to get you started. See [[Caddy]] for more information about the Caddyfile. | Just like with normal subdomains, the Nest CLI will automatically configure the domain in the system and add a block to your Caddyfile to get you started. See [[Caddy]] for more information about the Caddyfile. | ||
If you'd like to remove a domain from the configuration, you can | If you'd like to remove a domain from the configuration, you can run: | ||
nest domain remove <name> | nest domain remove <name> | ||
Revision as of 20:52, 12 April 2024
Whilst a subdomain of https://hackclub.app is automatically configured for you when you sign up for Nest, you'll need to use the Nest CLI to configure new subdomains under your user subdomain (https://<username>.hackclub.app).
Subdomains
To configure any subdomains of your user subdomain of hackclub.app, you can simply run the following command where name is the name of the subdomain you want to add. For example, if your username is orpheus, and you'd like to configure drawing.orpheus.hackclub.app, then you would run nest subdomain add drawing.
nest subdomain add <name>
The Nest CLI will automatically configure the subdomain in the system and add a block to your Caddyfile to get you started. See Caddy for more information about the Caddyfile.
If you'd like to remove a subdomain from the configuration, you can run
nest subdomain remove <name>
Custom Domains
As well as having your https://<username>.hackclub.app subdomain, you can link a custom domain to your user account.
To configure any custom domains for your user account, add a CNAME record to your domain leading to <username>.hackclub.app. For example, if your username is orpheus, you would create a CNAME record with the value of orpheus.hackclub.app .
If you are using Cloudflare or a similar DNS provider that reverse-proxies requests, make sure to uncheck "Proxy status" (the orange cloud on Cloudflare).
Once this is done and the DNS has propagated, you can link your domain to your user account with the following command. For example, orpheus may run nest domain add orpheus.com.
nest domain add <domain>
Just like with normal subdomains, the Nest CLI will automatically configure the domain in the system and add a block to your Caddyfile to get you started. See Caddy for more information about the Caddyfile.
If you'd like to remove a domain from the configuration, you can run:
nest domain remove <name>