Skip to content

Commit 06b1ef4

Browse files
DougReederDougReeder
committed
WIP: Splits out provider-specific parts of Beginner's Guide to CE
1 parent cd4f0b5 commit 06b1ef4

File tree

3 files changed

+191
-0
lines changed

3 files changed

+191
-0
lines changed

‎docs/install-domain-porkbun.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: install-domain-porkbun
3+
title: Purchase a web domain at Porkbun
4+
---
5+
6+
[*NB: This is a placeholder; screenshots will be included in the pull request.]
7+
8+
1. Go to Porkbun.com.
9+
10+
2. Under Products, select Domains.
11+
12+
3. Search for a domain name if you already have a specific name in mind or you may shop by reviewing for different ending web domain extensions (the .com or .net or .xyz part of a web address) and their prices.
13+
14+
Select column headers “Registration”, “Renewal”, or “Transfer” to sort by lowest price in each column.
15+
16+
For example, let’s say you select the .space (dot space) extension because it is currently on a 1st Year Sale of US$1.11. 🤔 Advice: Pay special attention to the Renewal column, however, because that is what you will be charged every year after.
17+
Next, search if your full domain name is available to buy. Let’s say you want “mycoolhubs.space”, enter mycoolhubs in the search box and select the magnifying glass (submit search).
18+
Note from the future: Scaleway ONLY wants domains that meet these conditions, so follow them now: The domain can only contain alphanumeric characters, dots, and dashes.
19+
20+
4. When you have chosen your full web domain address, select the plus sign under sort by price to add it to your shopping cart.
21+
22+
5. Select Checkout.
23+
24+
6. At Your Cart, select Continue Create account / Login.
25+
26+
7. Under Create a New Account, type in your information to these required fields:
27+
Username, Password, Primary email address, First or Given Name, Address, Country, City, Zip / Postal, Phone Code, Phone Number
28+
Select the checkbox for You must agree to the following by checking the checkbox before continuing.
29+
You may say yes or no to awesome emails.
30+
Save your username and password somewhere.
31+
Select Create Account.
32+
33+
8. Complete your purchase. Complete the email verification step. Enter your verification code into the pop-up and then select Submit.
34+
35+
🤔 Advice: Activate two factor authentication (2FA) for your account.
36+
37+
[Back to Overview](./install-overview.md#3-purchase-a-web-domain)

‎docs/install-overview.md

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
id: install-overview
3+
title: Overview of Installation
4+
---
5+
6+
[*NB: this heirarchy is not final; it's just a first pass*]
7+
8+
The exact steps you take will depend somewhat on which providers you use.
9+
10+
## Preparation
11+
12+
[*NB: as in current Beginner's Guide*]
13+
14+
## Section 1: Download stuff
15+
16+
[*NB: as in the first part of "Download stuff and open accounts"*]
17+
18+
## Section 2: Open accounts
19+
20+
### 3. Purchase a web domain
21+
22+
You need control of a domain name.
23+
Your Hubs instance can have a name like `example.com` if it is the only server on your domain.
24+
Your instance can have a name like `hubs.example.com` if you have other servers on your domain.
25+
26+
Follow the directions for one of these providers, or use an existing domain name you control.
27+
28+
* [Porkbun](./install-domain-porkbun.md)
29+
* [NameCheap](./install-domain-namecheap.md)
30+
31+
> 💡️ Your domain name service will probably show some filler at your domain name.
32+
> This will go away when you set up Hubs.
33+
34+
### 4: Set up an account and create a managed Kubernetes cluster
35+
36+
* [DigitalOcean](./install-kubernetes-digitalocean)
37+
* [Scaleway](./install-kubernetes-scaleway)
38+
* [AWS](./install-kubernetes-aws)
39+
40+
[*NB: "Download and Install Doctl" and "Authenticate doctl" will be merged into the DigitalOcean directions here. Or maybe Other providers will have different tools, which typically won't be needed in later steps. "Connect DO" might be merged here or be its own step.*]
41+
42+
### 5. Set up SMTP email service, verify domain, & get credential.
43+
44+
There are two types of email when setting up Hubs.
45+
The first is an account where you can receive email. You probably already have one. (work email, home email, etc.). We used gMail in our testing.
46+
We call this your “admin email”. It will control your Hubs instance.
47+
48+
The second is an account to send the automatic login emails from.
49+
As many similar emails will be sent from this account, you need a setup that won't be blocked as spam.
50+
We call this your SMTP email service.
51+
52+
* [Scaleway](./install-smtp-scaleway)
53+
* [Sendlayer](./install-smtp-sendlayer)
54+
* [GMail](./install-smtp-gmail)
55+
56+
### 6. Domain verification and adding DNS Records
57+
58+
In this step, you will add in the SPF, DKIM, MX, and DMARC records for your SMTP email service in your web domain.
59+
60+
> 💡 Here we assume you use the DNS service of your domain name service.
61+
> You can use a different DNS service if you want to.
62+
63+
* [Porkbun](./install-mx-porkbun)
64+
* [NameCheap](./install-mx-namecheap)
65+
66+
### 7. Download and install Kubectl
67+
68+
[*NB: as in "Download and install Kubectl"*]
69+
70+
> ☑️ To verify that kubectl is configured correctly, at the command line type
71+
> ```shell
72+
> kubectl cluster-info
73+
> ```
74+
> The output should resemble
75+
> ```angular2html
76+
> Kubernetes control plane is running at https://127.0.0.1:66666
77+
> CoreDNS is running at https://127.0.0.1:66666/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
78+
>
79+
> To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
80+
> ```
81+
82+
## Section 3: Download Hubs and Upload it to your cluster
83+
84+
### 8. Download Hubs Community Edition (a.k.a. Hubs CE and HCCE)
85+
86+
[*NB: as in "Download Hubs CE"*]
87+
88+
### 9. Upload your Hubs to your cluster
89+
90+
[*NB: as in "Upload your Hubs"*]
91+
92+
> ☑️ Now is a good time to check that your SMTP email service is reachable from your Kubernetes cluster. See [Checking that my SMTP is reachable from my Kubernetes cluster](./troubleshooting-smtp)
93+
94+
### 10. Add new A records to DNS
95+
96+
This step will be very similar to "Domain verification and adding DNS Records" above. You will add four more new A records. You will copy from your Kubernetes hoster and paste into your DNS provider/domain name provider.
97+
98+
* [Porkbun](./install-dns-porkbun)
99+
* [NameCheap](./install-dns-namecheap.md)
100+
101+
> ☑️ You can verify that the new DNS records are in use.
102+
> Type your domain name into your Web browser.
103+
> You should get a warning that the connection is insecure.
104+
> **That's great!** It means you're connecting to your cluster, but the connection isn't secure yet.
105+
> The next step will make your connection secure.
106+
107+
### 11. Generate certificates
108+
109+
[*NB: as in "Generate certificates"*]
110+
111+
## Section 4: Kick the tires and light the fires
112+
113+
### 12. Configure Firewall
114+
115+
Now you have to whitelist a few ports so that the voice chat and screen share/video share work properly.
116+
117+
* [DigitalOcean](./install-firewall-digitalocean)
118+
* [Scaleway](./install-firewall-scaleway)
119+
* [AWS](./install-firewall-aws)
120+
121+
> ☑️ To check that your firewall is correctly configured, type your domain name into your Web browser.
122+
> You should see the root page of your Hubs instance, without any warning about an insecure connection.
123+
> [*NB: insert screenshot here*]
124+
125+
### 13. Your Hubs is up!
126+
127+
Go to your domain and log in.
128+
129+
Visit What's next? for tips on room settings, importing scenes, and backups.
130+
131+
### 14. Got questions?
132+
133+
Check our FAQs. Also, our community Discord is standing by.
134+
135+
## Sources
136+
137+
* Hrithik Tiwari’s original DigitalOcean instructions.
138+
* [Video] DigitalOcean Quick Start with Hrithik Tiwari - Community Edition Setup Session - April 3, 2024
139+
* Using Sendgrid for SMTP
140+
* [Video] Doctl for Windows installation video
141+
* [Video] Visual Studio code tutorial
142+
* [Video] Config file tutorial from Stan
143+
~~* Installing WSL in Windows - didn’t use WSL after all~~
144+
~~* Username and password advice for Linux - didn’t use after all~~
145+
* Using SendGrid for SMTP- Tutorial from Fabien
146+
* Brevo How to Authenticate your domain
147+
* Setting up AWS SES
148+
* Community Edition Case Study: Quick Start on Google Cloud with AWS Services
149+
150+

‎website/sidebars.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@
5757
"dev-client-interactivity",
5858
"dev-client-networking"
5959
],
60+
"Install": [
61+
"install-overview",
62+
"install-domain-porkbun"
63+
],
6064
"Hubs Cloud": [
6165
"hubs-cloud-intro",
6266
"hubs-cloud-getting-started",

0 commit comments

Comments
 (0)