More actions
Edited custom domain section to explain on new domain verification system |
Update cli to new js |
||
| Line 2: | Line 2: | ||
== Subdomains == | == Subdomains == | ||
To configure any subdomains of your user subdomain of hackclub.app, you can simply run the following command where <code>name</code> is the name of the subdomain you want to add. For example, if your username is <code>orpheus</code>, and you'd like to configure <code>drawing.orpheus.hackclub.app</code>, then you would run <code>nest | To configure any subdomains of your user subdomain of hackclub.app, you can simply run the following command where <code>name</code> is the name of the subdomain you want to add. For example, if your username is <code>orpheus</code>, and you'd like to configure <code>drawing.orpheus.hackclub.app</code>, then you would run <code>nest caddy add drawing.orpheus.hackclub.app</code>. | ||
nest | nest caddy add <name>.<username>.hackclub.app | ||
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 run the following command which will remove it from the root Caddyfile. | If you'd like to remove a subdomain from the configuration, you can run the following command which will remove it from the root Caddyfile. | ||
nest | nest caddy rm <name>.<username>.hackclub.app | ||
== Custom Domains == | == Custom Domains == | ||
| Line 16: | Line 16: | ||
If you're using a root domain and you can't add a CNAME, you can also add an ALIAS record (or manually add the A and AAAA records if you're feeling spicy). Set your ALIAS record to <code>hackclub.app</code>, or set your A record to <code>37.27.51.34</code> and AAAA record to <code>2a01:4f9:3081:399c::4</code>. | If you're using a root domain and you can't add a CNAME, you can also add an ALIAS record (or manually add the A and AAAA records if you're feeling spicy). Set your ALIAS record to <code>hackclub.app</code>, or set your A record to <code>37.27.51.34</code> and AAAA record to <code>2a01:4f9:3081:399c::4</code>. | ||
Once you've followed either of those and the DNS has propagated, you can link the domain to your user account by running the following command. For example, <code>orpheus</code> may run <code>nest | Once you've followed either of those and the DNS has propagated, you can link the domain to your user account by running the following command. For example, <code>orpheus</code> may run <code>nest caddy add orpheus.com</code>. | ||
nest | |||
'''Important''': You need to set the "domain-verification" TXT record to your username. | |||
nest caddy add <domain> | |||
| Line 25: | Line 27: | ||
If you'd ever like to remove a domain from your user account, you can run the following command which will remove it from the root Caddyfile. | If you'd ever like to remove a domain from your user account, you can run the following command which will remove it from the root Caddyfile. | ||
nest | nest caddy remove <domain> | ||
Revision as of 16:49, 10 September 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 caddy add drawing.orpheus.hackclub.app.
nest caddy add <name>.<username>.hackclub.app
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 the following command which will remove it from the root Caddyfile.
nest caddy rm <name>.<username>.hackclub.app
Custom Domains
As well as having your https://<username>.hackclub.app subdomain, you can link a custom domain to your user account.
To configure a domain for your user account, add a CNAME record to your domain pointing to <username>.hackclub.app. For example, if your username was orpheus, you'd set your CNAME to orpheus.hackclub.app. If you're using Cloudflare or similar providers that reverse-proxies requests, make sure to disable proxying (on Cloudflare, this is the orange cloud).
If you're using a root domain and you can't add a CNAME, you can also add an ALIAS record (or manually add the A and AAAA records if you're feeling spicy). Set your ALIAS record to hackclub.app, or set your A record to 37.27.51.34 and AAAA record to 2a01:4f9:3081:399c::4.
Once you've followed either of those and the DNS has propagated, you can link the domain to your user account by running the following command. For example, orpheus may run nest caddy add orpheus.com.
Important: You need to set the "domain-verification" TXT record to your username.
nest caddy add <domain>
If you added the CNAME to your domain, congrats, you've now successfully linked your domain to your user account! The Nest CLI, just like with subdomains, has configured your domain and added a block to your Caddyfile. See Caddy for more information about the Caddyfile.
If you used an ALIAS (or the A/AAAA records), you'll need to add a secondary TXT record to your domain to verify ownership. Once added and propagated, run the command again and it should be linked to your user account!
If you'd ever like to remove a domain from your user account, you can run the following command which will remove it from the root Caddyfile.
nest caddy remove <domain>