You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Unselect the *Public Bot* setting and save changes. Otherwise, other users on Discord could add your bot to their servers.
22
-
23
-
24
-
25
-
Finally, under the OAuth2 panel, you'll need to set a proper redirect URL for your site. Set it to `https://<your site>/api/v1/oauth/discord` replacing `<your site>` with your Hubs Cloud domain.
First, go to the [Admin Console](./hubs-cloud-getting-started.md) and under "Server Settings" -> "API Keys" you'll need to set the **Discord Client ID**, **Discord Client Secret**, and **Discord Bot Token**
Your **Bot Token** can be found under your Bot's settings page on Discord.
40
-
41
-
42
-
43
-
## Server Setup
44
-
45
-
You will install the Hubs Discord Bot on one of your Hubs Cloud servers.
46
-
47
-
To proceed, first SSH into one of your servers. To access your servers over SSH, in the the [Admin Console](./hubs-cloud-getting-started.md) choose **Server Access** and follow the guide. Note that 2-factor authentication is set up by default, so you will need a 2FA device with an application installed like Google Authenticator to connect to your servers.
48
-
49
-
If you are running multiple servers, you *must* run the bot on an *app* server, not a stream server.
50
-
51
-
Once you've connected to your server, enter the following command in the command shell:
After it installs, your bot should now be up and running. Note that if you re-create your server, you'll need to run this command again.
59
-
60
-
## Inviting Your Bot
61
-
62
-
The last step is inviting your bot to your server. To do so, go back to the OAuth2 settings for your application and in the **OAuth 2 URL Generator**, select the "bot" scope, and the following permissions:
Copy file name to clipboardExpand all lines: docs/hubs-cloud-do-quick-start.md
+26-13
Original file line number
Diff line number
Diff line change
@@ -4,31 +4,44 @@ title: DigitalOcean Quick Start
4
4
sidebar_label: DigitalOcean Quick Start
5
5
---
6
6
7
+
> **Warning! Hubs Cloud for DigitalOcean is in alpha and provided as is.**
8
+
>
9
+
> We're unable to provide the level of support as we do for the AWS version.
10
+
7
11
Hubs Cloud DigitalOcean can be found on [DigitalOcean Marketplace](https://marketplace.digitalocean.com/apps/hubs-cloud-personal).
8
12
9
13
1. You'll need two registered domain names, one for your hub and one for short room links. We recommend using .link domains for short links. Make sure to update the DNS for your domains to [point to DigitalOcean's nameservers](https://www.digitalocean.com/community/tutorials/how-to-point-to-digitalocean-nameservers-from-common-domain-registrars).
10
14
11
-
2.[Create your Droplet](https://marketplace.digitalocean.com/apps/hubs-cloud-personal) via the DigitalOcean Marketplace. For testing a $5 droplet will work just fine. Larger droplets will be required to support more users. In the alpha stage we don't really have particular recommendations, so experiment and let us know what works for you!
12
-
- If you want additional storage for uploads, avatars, and scenes, you should attach a block storage volume.
13
-
- If you already have a DigitalOcean project, assign your droplet to your project now. Otherwise you can do this when you create your project in step 4.
15
+
2.[Create your Droplet](https://marketplace.digitalocean.com/apps/hubs-cloud-personal) via the DigitalOcean Marketplace. For testing a \$5 droplet will work just fine. Larger droplets will be required to support more users. In the alpha stage we don't really have particular recommendations, so experiment and let us know what works for you!
16
+
17
+
- If you want additional storage for uploads, avatars, and scenes, you should attach a block storage volume.
18
+
- If you already have a DigitalOcean project, assign your droplet to your project now. Otherwise you can do this when you create your project in step 4.
19
+
20
+
3. Add your two domains to your DigitalOcean project by [adding them to networking](https://cloud.digitalocean.com/networking/domains).
21
+
22
+
- If you've already created a DigitalOcean project, add the domains to your project via the "Move Resources" button in the project view. Otherwise, you can add them in the next step when creating a new project.
14
23
15
-
3. Add your two domains to your DigitalOcean project by [adding them to networking](https://cloud.digitalocean.com/networking/domains).
16
-
- If you've already created a DigitalOcean project, add the domains to your project via the "Move Resources" button in the project view. Otherwise, you can add them in the next step when creating a new project.
24
+
4.[Create a New Project](https://cloud.digitalocean.com/projects/new) for your hub and assign your domains and droplet as resources.
17
25
18
-
4.[Create a New Project](https://cloud.digitalocean.com/projects/new) for your hub and assign your domains and droplet as resources.
19
-
- By associating your domains with your project, we'll be able to automatically add the necessary DNS records for you.
20
-
- Otherwise, you'll have to add the necessary DNS records yourself. The setup script (step 8) will tell you what records to add.
26
+
- By associating your domains with your project, we'll be able to automatically add the necessary DNS records for you.
27
+
- Otherwise, you'll have to add the necessary DNS records yourself. The setup script (step 8) will tell you what records to add.
21
28
22
29
5. Hubs Cloud uses email magic links to log in. You'll need SMTP connection info from an email provider to send these emails.
23
-
- We recommend using [SendGrid](https://www.sendgrid.com) and using port 2525 to prevent firewall blocking. To use SendGrid for SMTP, create an account and then go to the [SMTP Integration](https://app.sendgrid.com/guide/integrate/langs/smtp) to get an SMTP username and password.
24
-
- SendGrid has an additional step to [authenticate your domain](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication) before your emails will start being sent.
25
-
30
+
31
+
- We recommend using [SendGrid](https://www.sendgrid.com) and using port 2525 to prevent firewall blocking. To use SendGrid for SMTP, create an account and then go to the [SMTP Integration](https://app.sendgrid.com/guide/integrate/langs/smtp) to get an SMTP username and password.
32
+
- SendGrid has an additional step to [authenticate your domain](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication) before your emails will start being sent.
33
+
26
34
6.[Create a writable DigitalOcean API token](https://cloud.digitalocean.com/account/api/tokens/new). This token will be needed during during setup for configuring DNS, firewall, etc as it allows the setup script to update your project/droplet as needed.
27
-
- The token **won't** be saved and you can remove it from your account once your hub is up.
35
+
36
+
- The token **won't** be saved and you can remove it from your account once your hub is up.
28
37
29
38
7. Once your droplet has started, SSH in as root to complete the setup process. Ex: `ssh [email protected]` You can find the ip address of your droplet at the top of the droplet detail page in the DigitalOcean dashboard. Depending on how you configured authentication when creating your droplet you will need to either provide the one time password given to you or simply use a pre-configured ssh key.
30
39
31
40
8. Upon login the Hubs Cloud setup wizard will start automatically. This will guide you through all the rest of the steps required to get you Hubs Cloud instance up and running. If you ever need to change the settings you entered during setup or if you exited it for any other reason you can re-run it by running `/opt/polycosm/setup.sh`
32
-
- You will need to provide a database or create a DigitalOcean Managed Database during setup. DigitalOcean Managed Databases start at $15/mo [See pricing for all DigitalOcean services here](https://www.digitalocean.com/pricing/).
41
+
- You will need to provide a database or create a DigitalOcean Managed Database during setup. DigitalOcean Managed Databases start at \$15/mo [See pricing for all DigitalOcean services here](https://www.digitalocean.com/pricing/).
33
42
34
43
DigitalOcean is currently an **alpha** pre-release. If you run into any issues, see the [help page](./help.html) for ways you can get in touch.
44
+
45
+
> **Warning! Hubs Cloud for DigitalOcean is in alpha and provided as is.**
46
+
>
47
+
> We're unable to provide the level of support as we do for the AWS version.
0 commit comments