diff --git a/website/docs/archive/discord-bot.md b/website/docs/archive/discord-bot.md index 87fb296..a2afb77 100644 --- a/website/docs/archive/discord-bot.md +++ b/website/docs/archive/discord-bot.md @@ -29,7 +29,7 @@ If your room is hosted on hubs.mozilla.com: webhook to bridge chat and send Hubs status updates. 5. Try out the bot! Type !hubs in a channel the bot is in to see some things you can do. -Using Hubs Cloud? You can [add the bot to your Hubs Cloud server](./hubs-cloud-discord-bot.md). +Using Hubs Cloud? You can [add the bot to your Hubs Cloud server](./hubs-cloud/discord-bot.md). ### User Permissions diff --git a/website/docs/archive/hubs-cloud/adding-admins.md b/website/docs/archive/hubs-cloud/adding-admins.md index c9f7d33..523b9d3 100644 --- a/website/docs/archive/hubs-cloud/adding-admins.md +++ b/website/docs/archive/hubs-cloud/adding-admins.md @@ -6,9 +6,9 @@ sidebar_position: 9 Administrators for your hub have full access rights. They can: -- Have access to the [Admin Console](./hubs-cloud-getting-started.md) to update system settings and app configuration. -- [Manage the content library](./hubs-cloud-managing-content.md) and [import content](./hubs-cloud-importing-content.md). -- Have access to the [Scene Editor](./spoke-creating-projects.md) to create and publish new scenes, regardless of settings. +- Have access to the [Admin Console](./getting-started.md) to update system settings and app configuration. +- [Manage the content library](./managing-content.md) and [import content](./importing-content.md). +- Have access to the [Scene Editor](/creators/spoke/create-project.md) to create and publish new scenes, regardless of settings. To assign other accounts administrative access, you need to get their account id and then assign administrator rights in the Admin Console. diff --git a/website/docs/archive/hubs-cloud/asset-packs.md b/website/docs/archive/hubs-cloud/asset-packs.md index 530ecad..15ffe8f 100644 --- a/website/docs/archive/hubs-cloud/asset-packs.md +++ b/website/docs/archive/hubs-cloud/asset-packs.md @@ -6,7 +6,7 @@ sidebar_position: 5 We've compiled some avatar and scene collections you can easily import into your hub. This content is [Creative Commons 3](https://creativecommons.org/licenses/by/3.0/us/) licensed. License compliance with attribution is handled automatically by Hubs Cloud when the content is surfaced to users. -To import these packs, simply specify the URL for the pack specified below in the [Import Content](./hubs-cloud-importing-content.md) tool in the [Admin Console](./hubs-cloud-getting-started.md). Once you input the URL you will be able to preview the contents of the pack and choose which items to import. +To import these packs, simply specify the URL for the pack specified below in the [Import Content](./importing-content.md) tool in the [Admin Console](./getting-started.md). Once you input the URL you will be able to preview the contents of the pack and choose which items to import. ## Avatar Packs diff --git a/website/docs/archive/hubs-cloud/custom-smtp.md b/website/docs/archive/hubs-cloud/custom-smtp.md index 7bf0ce3..2dfe618 100644 --- a/website/docs/archive/hubs-cloud/custom-smtp.md +++ b/website/docs/archive/hubs-cloud/custom-smtp.md @@ -6,7 +6,7 @@ sidebar_position: 13 When you set up your server on some cloud providers like AWS, SMTP is automatically set up for you on your cloud provider's email service. You can set your own custom SMTP settings if you are using a different mail provider. -In the [Admin Console](./hubs-cloud-getting-started.md) choose **Server Settings**: +In the [Admin Console](./getting-started.md) choose **Server Settings**: ![Hubs Cloud ](/img/hubs-cloud-server-settings.jpeg) diff --git a/website/docs/archive/hubs-cloud/customizing-look.md b/website/docs/archive/hubs-cloud/customizing-look.md index f46a604..0beff62 100644 --- a/website/docs/archive/hubs-cloud/customizing-look.md +++ b/website/docs/archive/hubs-cloud/customizing-look.md @@ -24,7 +24,7 @@ Please note that we are working on tools and documentation to help streamline th You can completely completely customize the look and feel of your hub by adding custom colors and branding. -First, open the [Admin Console](./hubs-cloud-getting-started.md) then choose **App Settings**: +First, open the [Admin Console](/fundamentals/getting-started.md) then choose **App Settings**: ![Hubs Cloud App Settings](/img/hubs-cloud-app-settings.jpeg) diff --git a/website/docs/archive/hubs-cloud/customizing-themes.md b/website/docs/archive/hubs-cloud/customizing-themes.md index 6672bb5..39c3a23 100644 --- a/website/docs/archive/hubs-cloud/customizing-themes.md +++ b/website/docs/archive/hubs-cloud/customizing-themes.md @@ -16,7 +16,7 @@ _Theming refers to the colors used in your hub's interface. For each color in th # Theme JSON -You can add completely customized color schemes from the [Admin Panel](./setup-configuring-content.md) by copying and pasting a theme JSON, like the example below: +You can add completely customized color schemes from the [Admin Panel](/subscription/managing-subscription.md) by copying and pasting a theme JSON, like the example below: ```json [ diff --git a/website/docs/archive/hubs-cloud/faq.md b/website/docs/archive/hubs-cloud/faq.md index 9790b39..6a8d4ad 100644 --- a/website/docs/archive/hubs-cloud/faq.md +++ b/website/docs/archive/hubs-cloud/faq.md @@ -8,16 +8,16 @@ sidebar_position: 3 **Hubs Cloud allows you all the functionality of hubs.mozilla.com and also comes with additional features to customize branding, the url, user accounts, the interface and code inside the hubs client.** You're in control of your Hubs Cloud instance and its data via AWS or DigitalOcean infrastructure, Mozilla simply provides the template and automatic updates. This makes it perfect for creating a totally bespoke Hubs experience. -The max room size is the same as hubs.mozilla.com: 25 avatars per room + 75 to the lobby ([More on room capacity here](./hubs-faq.md#what-is-the-capacity-of-a-hubs-room)). +The max room size is the same as hubs.mozilla.com: 25 avatars per room + 75 to the lobby ([More on room capacity here](/fundamentals/fundamental-faqs.md#what-is-the-capacity-of-a-hubs-room)). -Try out Hubs via hubs.mozilla.com and when you're familiar and interested in using it for big events, exclusive personal meetups, or for a business, check out [Hubs Cloud](./hubs-cloud-intro.md). +Try out Hubs via hubs.mozilla.com and when you're familiar and interested in using it for big events, exclusive personal meetups, or for a business, check out [Hubs Cloud](./introduction.md). Documentation for customizing your Hubs Cloud instance: -- [Branding + look and feel](./hubs-cloud-customizing-look-and-feel.md) -- [Customizing hub url](./hubs-cloud-aws-domain-recipes.md) +- [Branding + look and feel](./customizing-look.md) +- [Customizing hub url](./hubs-cloud-aws/domain-recipes.md) - Managing accounts via the Admin Panel - _documentation coming soon_ -- [Customizing the user interface and client code](./hubs-cloud-custom-clients.md) +- [Customizing the user interface and client code](/developers/development-basics/extending-client.md) ## Personal vs. Enterprise? @@ -27,11 +27,11 @@ Documentation for customizing your Hubs Cloud instance: ## How to change my server size up from a t3.micro to c4.large? -Check out [Updating the Stack](./hubs-cloud-aws-updating-the-stack.md) documentation. +Check out [Updating the Stack](./hubs-cloud-aws/updating-the-stack.md) documentation. ## Can I change the # of servers I am running? -Yes, for Enterprise. [Update the Stack](./hubs-cloud-aws-updating-the-stack.md). +Yes, for Enterprise. [Update the Stack](./hubs-cloud-aws/updating-the-stack.md). No, for Personal. @@ -45,28 +45,28 @@ No, you'll need to delete the current stack and remake it with those settings. ## How much will Hubs Cloud cost for AWS? -Check out our **rough** estimate guide here: [Estimated Cost Charts (alpha)](./hubs-cloud-aws-estimated-cost-charts.md) +Check out our **rough** estimate guide here: [Estimated Cost Charts (alpha)](./hubs-cloud-aws/estimating-cost.md) ## How many users can Hubs Cloud support? -Please see: [AWS Estimated CCU Limits](./hubs-cloud-aws-estimated-ccu-limits.md) +Please see: [AWS Estimated CCU Limits](./hubs-cloud-aws/estimating-ccu.md) ## Can I use the Mozilla / Hubs logo on my Hubs Cloud site? -Please review our [branding guidelines](./hubs-cloud-branding.md) for information about how the Hubs logos can be used. +Please review our [branding guidelines](./brand-guidelines.md) for information about how the Hubs logos can be used. ## What is my hub stack's admin email address? -See ["Check "What is my hubs stack's admin email address?" docs](./hubs-cloud-aws-troubleshooting.md#then-what-is-my-hub-stacks-admin-email-address) +See ["Check "What is my hubs stack's admin email address?" docs](./hubs-cloud-aws/aws-troubleshooting.md#then-what-is-my-hub-stacks-admin-email-address) ## How do I lockdown my rooms to specific people? -[See Limiting User Access docs](./hubs-cloud-limiting-user-access.md) +[See Limiting User Access docs](./limiting-access.md) ## Don't see your question? -If your question is about Hubs, check out the [Hubs FAQ](./hubs-faq.md). +If your question is about Hubs, check out the [Hubs FAQ](/fundamentals/fundamental-faqs.md). -If your question is about deploying Hubs Cloud to AWS, check out the [AWS Troubleshooting Guide](./hubs-cloud-aws-troubleshooting.md). +If your question is about deploying Hubs Cloud to AWS, check out the [AWS Troubleshooting Guide](./hubs-cloud-aws/aws-troubleshooting.md). If you can't find what you need in the rest of the documentation, see the [help page](./help.html) for ways to get in touch. diff --git a/website/docs/archive/hubs-cloud/getting-started.md b/website/docs/archive/hubs-cloud/getting-started.md index 1cb5c68..042fdfb 100644 --- a/website/docs/archive/hubs-cloud/getting-started.md +++ b/website/docs/archive/hubs-cloud/getting-started.md @@ -6,7 +6,7 @@ sidebar_position: 2.2 After successful Hubs Cloud deployment on AWS or DigitalOcean, navigate to your hub's hosted domain name (eg. myhub.com or hub.mydomain.com). -In the upper right corner, click "Sign In" and enter your admin email address you specified during CloudFormation. In your email inbox, click the received "magic link" to login (Issues with login? Check out the [AWS Troubleshooting Guide](./hubs-cloud-aws-troubleshooting.md)). +In the upper right corner, click "Sign In" and enter your admin email address you specified during CloudFormation. In your email inbox, click the received "magic link" to login (Issues with login? Check out the [AWS Troubleshooting Guide](./hubs-cloud-aws/aws-troubleshooting.md)). Once you've logged into Hubs Cloud for the first time, you should see the Hubs Cloud Admin Console. It should look like this: @@ -22,16 +22,16 @@ Now that your site is up and running, you can create a room by clicking on the " ![Hubs Cloud Create Room](/img/hubs-cloud-create-room.jpeg) -The first thing you'll notice... is your room is totally empty! Hubs Cloud isn't very useful until you [import some scenes and avatars](./hubs-cloud-importing-content.md). +The first thing you'll notice... is your room is totally empty! Hubs Cloud isn't very useful until you [import some scenes and avatars](./importing-content.md). ## Setting up your hub Here's some things you can do to continue setting up your hub: -- [Import content](./hubs-cloud-importing-content.md) so your visitors will have access to a library of scenes and avatars. -- [Customize the Look and Feel](./hubs-cloud-customizing-look-and-feel.md) to make your hub fit your brand or style. -- [Enable the Scene Editor](./hubs-cloud-enable-scene-editor.md) to let visitors create their own scenes. -- [Enable permissive rooms](./hubs-cloud-permissive-rooms.md) to let visitors add media to their rooms. -- [Set up the media browser](./hubs-cloud-enable-media-browser.md) so visitors can add content from sites like Sketchfab. -- [Learn how to manage content](./hubs-cloud-managing-content.md) so visitors can contribute content to your hub. -- [Add Administrators](./hubs-cloud-adding-administrators.md) if you'd like others to help you set up your hub. +- [Import content](./importing-content.md) so your visitors will have access to a library of scenes and avatars. +- [Customize the Look and Feel](./customizing-look.md) to make your hub fit your brand or style. +- Enable the Scene Editor to let visitors create their own scenes. +- [Enable permissive rooms](./permissive-rooms.md) to let visitors add media to their rooms. +- Set up the media browser so visitors can add content from sites like Sketchfab. +- [Learn how to manage content](./managing-content.md) so visitors can contribute content to your hub. +- [Add Administrators](./adding-admins.md) if you'd like others to help you set up your hub. diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/aws-troubleshooting.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/aws-troubleshooting.md index b9f1914..3d5e68f 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/aws-troubleshooting.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/aws-troubleshooting.md @@ -109,7 +109,7 @@ This is a bug in AWS Cloudformation that Amazon is working to address. Unfortuna Did you choose "Offline mode" when creating the stack? If so, you deployed correctly but your servers aren't running! -To get them running and take them "Online" follow the [Update the Stack Guide](./hubs-cloud-aws-updating-the-stack.md). When you want to take them "Offline" again, follow the same process and select "Offline". +To get them running and take them "Online" follow the [Update the Stack Guide](./updating-the-stack.md). When you want to take them "Offline" again, follow the same process and select "Offline". You can also specify a url to redirect traffic to when your servers are offline to avoid this error page. diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/backup-and-restore.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/backup-and-restore.md index 0501175..9378a9c 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/backup-and-restore.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/backup-and-restore.md @@ -8,13 +8,13 @@ If something goes wrong and you need to restore from a backup, or you'd like to Your hub's data is made up of two things: an AWS Aurora Serverless database, and an AWS Elastic File Store volume (used for scenes, avatars, etc.) Both of these are backed up for you automatically on a nightly basis. The database is backed up via database snapshots (which can be seen in the RDS console) and the EFS volume is backed up into a Vault in AWS Backup (which can be found in the AWS Backup console.) -**Do you need to update your Hubs Cloud stack from 1.0.0 to 1.1.0?** Follow the guide: [update from Hubs Cloud version 1.0.0 to 1.1.0](./hubs-cloud-aws-updating-the-stack.html#upgrade-to-a-new-stack-release) +**Do you need to update your Hubs Cloud stack from 1.0.0 to 1.1.0?** Follow the guide: [update from Hubs Cloud version 1.0.0 to 1.1.0](./updating-the-stack.html#upgrade-to-a-new-stack-release) ### Creating a backup manually Your hub is backed up automatically every night. If you want to make an up-to-the-minute backup of a hub you can manually create a RDS snapshot and new AWS Backup recovery point via the console. -- It's highly suggested you put your hub into "Offline" mode by performing a [stack update](./hubs-cloud-aws-updating-the-stack.md) before doing so to limit the risk of data being missed. +- It's highly suggested you put your hub into "Offline" mode by performing a [stack update](./updating-the-stack.md) before doing so to limit the risk of data being missed. - To create a database snapshot: - Select your database cluster in RDS and under "Actions" click "Take Snapshot". - If you're unsure which cluster is your hub's database, it can be found in the stack "Outputs" section under `AppDb`. diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/cost-saving.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/cost-saving.md index 8ee00a5..59e7278 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/cost-saving.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/cost-saving.md @@ -12,25 +12,25 @@ If you'd like to estimate the costs for your event: - Calculate and estimate the cost of your event - Recommended Server Types -See our [Estimating Costs and Charts (Alpha)](./hubs-cloud-aws-estimated-cost-charts.md) page. +See our [Estimating Costs and Charts (Alpha)](./estimating-cost.md) page. **Minimizing Costs Primer** -- [How do costs work for Hubs Cloud?](./hubs-cloud-aws-costs.md#how-do-costs-work-for-hubs-cloud) -- [Minimizing costs - Recommended user story](./hubs-cloud-aws-costs.md#minimize-your-costs---a-user-story) -- [Minimizing costs - Settings in stack template](./hubs-cloud-aws-costs.md#stack-cost-management-options) +- [How do costs work for Hubs Cloud?](./cost-saving.md#how-do-costs-work-for-hubs-cloud) +- [Minimizing costs - Recommended user story](./cost-saving.md#minimize-your-costs---a-user-story) +- [Minimizing costs - Settings in stack template](./cost-saving.md#stack-cost-management-options) ## How do costs work for Hubs Cloud? We've done our best to minimize costs in the template as much as possible. Your primary costs will be the EC2 AWS Server types you use hourly, the serverless hourly database costs, EFS storage, and, if you do not switch to Cloudflare, data transfer costs. -EC2 instances, while "Online", will cost the [minimum cost](./hubs-cloud-aws-estimated-cost-charts.md#estimated-cost-charts) per hour per server for your instance AWS server type [(?)](./hubs-cloud-aws-estimated-cost-charts.md#aws-server-type-recommendations). This minimum cost is hourly regardless of how many people connect at a time. You can manually turn off your EC2 instance + database via turning on [**Offline mode**](./hubs-cloud-aws-costs.md#offline-mode---manual) where no one can connect to your server at the time. +EC2 instances, while "Online", will cost the [minimum cost](./estimating-cost.md#estimated-cost-charts) per hour per server for your instance AWS server type [(?)](./estimating-cost.md#aws-server-type-recommendations). This minimum cost is hourly regardless of how many people connect at a time. You can manually turn off your EC2 instance + database via turning on [**Offline mode**](./cost-saving.md#offline-mode---manual) where no one can connect to your server at the time. -Database costs is the largest factor next to EC2 instance, you can set [**database pausing**](./hubs-cloud-aws-costs.md#database-pausing---automatic) on to stop costs incurring when no one is connected. +Database costs is the largest factor next to EC2 instance, you can set [**database pausing**](./cost-saving.md#database-pausing---automatic) on to stop costs incurring when no one is connected. -[See our (Alpha) Cost Charts for more information on AWS Server Types and Minimum EC2 Costs.](./hubs-cloud-aws-estimated-cost-charts.md#estimated-cost-charts) +[See our (Alpha) Cost Charts for more information on AWS Server Types and Minimum EC2 Costs.](./estimating-cost.md#estimated-cost-charts) -[For minimizing your costs, see our Minimize your Hubs Cloud Costs - A User Story](./hubs-cloud-aws-costs.md#minimize-your-hubs-cloud-costs---a-user-story) +[For minimizing your costs, see our Minimize your Hubs Cloud Costs - A User Story](./cost-saving.md#minimize-your-hubs-cloud-costs---a-user-story) ## Factors creating AWS cost estimates @@ -58,39 +58,39 @@ Note that you can significantly save data transfer charges by switching your CDN If you'd like to maximize your cost savings, you can perform a stack update to switch the stack into "Offline" mode when you are not using it, though this likely unnecessary except for cases where you are running at a higher capacity settings than the defaults. -To roughly estimate your costs, check out our [Estimated Cost Charts (alpha)](./hubs-cloud-aws-estimated-cost-charts.md). +To roughly estimate your costs, check out our [Estimated Cost Charts (alpha)](./estimating-cost.md). To more accurately predict future costs use [AWS Cost Explorer for your instance](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-what-is.html). ## Minimize your Costs - A User Story -Our recommendation to minimize costs for automatic settings is to turn [**database pausing**](./hubs-cloud-aws-costs.md#database-pausing---automatic) on by default. When no one is using your hub, turn your hub to [**Offline mode**](./hubs-cloud-aws-costs.md#offline-mode---manual) or a small instance type like **t3.medium**. Also use a Cloudflare worker as your content CDN. +Our recommendation to minimize costs for automatic settings is to turn [**database pausing**](./cost-saving.md#database-pausing---automatic) on by default. When no one is using your hub, turn your hub to [**Offline mode**](./cost-saving.md#offline-mode---manual) or a small instance type like **t3.medium**. Also use a Cloudflare worker as your content CDN. ### Before your event: Development -For development with only a few users connecting + setting rooms + scenes, we recommend at least a **t3.medium** instance [(?)](./hubs-cloud-aws-estimated-cost-charts.md#aws-server-type-recommendations). When not in use, set your instance to [**Offline mode**](./hubs-cloud-aws-costs.md#offline-mode---manual). Then switch back to Online when beginning development again. +For development with only a few users connecting + setting rooms + scenes, we recommend at least a **t3.medium** instance [(?)](./estimating-cost.md#aws-server-type-recommendations). When not in use, set your instance to [**Offline mode**](./cost-saving.md#offline-mode---manual). Then switch back to Online when beginning development again. ### Before your event: 1.5 hours -If your instance is in [**Offline mode**](./hubs-cloud-aws-costs.md#offline-mode---manual), manually update the stack to **Online** and wait 10 minutes. +If your instance is in [**Offline mode**](./cost-saving.md#offline-mode---manual), manually update the stack to **Online** and wait 10 minutes. -After, at least 1 hour before event, manually update the stack to scale up your AWS Server Type. For example 1 hour before your event, [update the stack](./hubs-cloud-aws-updating-the-stack.md) from a **t3.medium** to **c4.large** [(?)](./hubs-cloud-aws-estimated-cost-charts.md#aws-server-type-recommendations). +After, at least 1 hour before event, manually update the stack to scale up your AWS Server Type. For example 1 hour before your event, [update the stack](./updating-the-stack.md) from a **t3.medium** to **c4.large** [(?)](./estimating-cost.md#aws-server-type-recommendations). ### During your event -If you notice performance issues, you can ad hoc [update the stack](./hubs-cloud-aws-updating-the-stack.md) up more from a **c4.large** to **c5.2xlarge** [(?)](./hubs-cloud-aws-estimated-cost-charts.md#aws-server-type-recommendations). Your users in the rooms will have a brief freeze/voice drop while the users roll to the new servers. +If you notice performance issues, you can ad hoc [update the stack](./updating-the-stack.md) up more from a **c4.large** to **c5.2xlarge** [(?)](./estimating-cost.md#aws-server-type-recommendations). Your users in the rooms will have a brief freeze/voice drop while the users roll to the new servers. ### After your event -Scale down your AWS Server Type by [updating the stack](./hubs-cloud-aws-updating-the-stack.md) from the **c5.2xlarge** to **t3.medium** [(?)](./hubs-cloud-aws-estimated-cost-charts.md#aws-server-type-recommendations) when finished or there are less users connected. +Scale down your AWS Server Type by [updating the stack](./updating-the-stack.md) from the **c5.2xlarge** to **t3.medium** [(?)](./estimating-cost.md#aws-server-type-recommendations) when finished or there are less users connected. ### When no one is connecting to your instance for a long time -You can turn your hub to [**Offline mode**](./hubs-cloud-aws-costs.md#offline-mode---manual) where no one can connect to your hub or a redirect URL, if specified. Via **Offline mode** all costs except for asset storage like backups, scenes, and avatars are \$0. +You can turn your hub to [**Offline mode**](./cost-saving.md#offline-mode---manual) where no one can connect to your hub or a redirect URL, if specified. Via **Offline mode** all costs except for asset storage like backups, scenes, and avatars are \$0. ## Stack Cost Management Options -To enable these options, follow [Update the Stack instructions](./hubs-cloud-aws-updating-the-stack.html). +To enable these options, follow [Update the Stack instructions](./updating-the-stack.html). - Enable **Auto-Pause Database**. On by default for Personal and settable by Enterprise. - Toggle **Offline mode** to "Online" to "Offline" manually. Your EC2 and database costs will be \$0/hour when you've turned your servers off. @@ -101,7 +101,7 @@ To enable these options, follow [Update the Stack instructions](./hubs-cloud-aws If **Auto-Pause Database** or **database pausing** is "Yes - Pause database when not in use", after no one has connected to your instance for a while, your database and the costs incurred by your database will stop until a user connects again. It takes 1-3 minutes for the database to turn back on and allow the first user to connect. Subsequent connections will occur quickly afterward. -To enable database pausing, follow [Update the Stack instructions](./hubs-cloud-aws-updating-the-stack.html). +To enable database pausing, follow [Update the Stack instructions](./updating-the-stack.html). ### Offline Mode - manual @@ -109,7 +109,7 @@ When you set **Offline mode** to "Offline", you've completely turned off your se Turning **Offline mode** to "Offline" to "Online" and vice versa is a manual process. Wait 10 minutes afterward to connect. -To toggle Offline/Online, follow [Update the Stack instructions](./hubs-cloud-aws-updating-the-stack.html). +To toggle Offline/Online, follow [Update the Stack instructions](./updating-the-stack.html). ### Monthly Database Budget - automatic @@ -117,7 +117,7 @@ Careful with the **Monthly Database Budget** setting, we recommend $0 (unlimited Personal and Enterprise defaults to \$0 (unlimited). -To set budget, follow [Update the Stack instructions](./hubs-cloud-aws-updating-the-stack.html). +To set budget, follow [Update the Stack instructions](./updating-the-stack.html). ### Change content CDN to Cloudflare Workers - 1 time update @@ -127,4 +127,4 @@ To enable Cloudflare workers, in your hub Admin Panel > "Content CDN" menu > Fol ## Estimating your costs -See our [Estimating Costs and Charts (Alpha)](./hubs-cloud-aws-estimated-cost-charts.md) page. +See our [Estimating Costs and Charts (Alpha)](./estimating-cost.md) page. diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/domain-recipes.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/domain-recipes.md index 283be55..d5be7bf 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/domain-recipes.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/domain-recipes.md @@ -42,7 +42,7 @@ Use Recipe 3 when your website is already hosting something or used elsewhere fo You do NOT need to (but you CAN), if your domains are not being used by anything, in that case follow **How to setup on Route 53** above section. -For example, for us to use mozilla.com (and not break the pre-existing site), we had to follow [Recipe 3](./hubs-cloud-aws-domain-recipes.md#recipe-3-domain-can-not-be-on-route-53) and _NOT_ change nameservers to point to AWS for hubs.mozilla.com to work as a subdomain. +For example, for us to use mozilla.com (and not break the pre-existing site), we had to follow [Recipe 3](./domain-recipes.md#recipe-3-domain-can-not-be-on-route-53) and _NOT_ change nameservers to point to AWS for hubs.mozilla.com to work as a subdomain. ### Using a second level domain (.co.uk, .com.fr, etc)? @@ -52,17 +52,17 @@ Use domain Recipe 3 regardless of whether you bought the domains on Route 53 (we - `myhub.com` **OR subdomain** `hub.myhub.com` connects to your hub - _Warning! Do not create a new Hosted Zone for `hub.myhub.com` on Route 53! The Cloudformation template will manage the connections on your root domain, `myhub.com`, hosted zone._ - `myhub.com` is **_NOT_** used for any other purpose or sites -- `mysite.com` set up on on Route 53 [(?)](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) +- `mysite.com` set up on on Route 53 [(?)](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) - `anothersubdomain.myhub.com` **_could be_** used for any other purposes or sites ### Instructions: -**[Set up or purchase 2 domains on Route 53](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider)** +**[Set up or purchase 2 domains on Route 53](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider)** 1. `myhub.com` - Houses Hub site domain name + internal server domain 2. `myhub.link` - Short link domain name -[Known bug + fix: Using a second level domain (.co.uk, .com.fr, etc)?](./hubs-cloud-aws-domain-recipes.md#using-a-second-level-domain-couk-comfr-etc) Use Recipe 3. +[Known bug + fix: Using a second level domain (.co.uk, .com.fr, etc)?](./domain-recipes.md#using-a-second-level-domain-couk-comfr-etc) Use Recipe 3. **Next, specify the following when creating the stack:** @@ -79,14 +79,14 @@ Use domain Recipe 3 regardless of whether you bought the domains on Route 53 (we - `hub.mysite.com` connects to your hub. - _Warning! Do not create a new Hosted Zone for `hub.mysite.com` on Route 53! The Cloudformation template will manage the connections on your root domain, `mysite.com`, hosted zone._ - `mysite.com` **_IS_** used for other sites or purposes -- `mysite.com` set up on on Route 53 [(?)](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) +- `mysite.com` set up on on Route 53 [(?)](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) - `anothersubdomain.myhub.com` **_could be_** used for any other purposes or sites -[Known bug + fix: Using a second level domain (.co.uk, .com.fr, etc)?](./hubs-cloud-aws-domain-recipes.md#using-a-second-level-domain-couk-comfr-etc) Use Recipe 3. +[Known bug + fix: Using a second level domain (.co.uk, .com.fr, etc)?](./domain-recipes.md#using-a-second-level-domain-couk-comfr-etc) Use Recipe 3. ### Instructions: -**[Set up or purchase 3 domains on Route 53](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider)** +**[Set up or purchase 3 domains on Route 53](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider)** 1. `mysite.com` - Houses subdomain as Hub site domain name + the other sites or purposes at the root 2. `myhub.link` - Short link domain name @@ -107,39 +107,39 @@ Use domain Recipe 3 regardless of whether you bought the domains on Route 53 (we ## Recipe 3: Domain CAN NOT be on Route 53 -- [When should I use Recipe 3?](./hubs-cloud-aws-domain-recipes.md#when-should-i-use-recipe-3) -- `mysite.com` **_CAN NOT_** be set up on Route 53 [(?)](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) +- [When should I use Recipe 3?](./domain-recipes.md#when-should-i-use-recipe-3) +- `mysite.com` **_CAN NOT_** be set up on Route 53 [(?)](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) - `mysite.com` connects to your hub **OR** `hub.mysite.com` connects to your hub ### Instructions: -**[Set up or purchase 2 domains on Route 53 (optional 3 domains)](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider)** +**[Set up or purchase 2 domains on Route 53 (optional 3 domains)](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider)** 1. `myhub.link` - Short link domain name 2. `mysite-internal.com` - Internal server domain + email domain. This can be any name you want, and will not be seen by users. 3. _(optional)_ `mysite-mail.com` - Email domain, if using `mysite-internal.com` for emails is not what you want. -To use an existing email provider, read through our [Using an Existing Email Provider Guide](./hubs-cloud-aws-existing-email-provider.md) +To use an existing email provider, read through our [Using an Existing Email Provider Guide](./existing-email.md) -**First, follow [Using an Existing Domain: SSL Certificates instructions](./hubs-cloud-aws-existing-domain.md)** +**First, follow [Using an Existing Domain: SSL Certificates instructions](./existing-domain.md)** **Next, specify the following when creating the stack:** -| STACK OPTIONS | RECIPE 3 | -| ----------------------------------- | ---------------------------------------------------------------------------------------------- | -| **Site Domain Name** | `mysite.com` **OR** `hub.mysite.com` + [SSL certificates](./hubs-cloud-aws-existing-domain.md) | -| **Site is Set Up On Route 53** | `No` | -| **Internal Domain** | `mysite-internal.com` | -| **Short Link Domain** | `myhub.link` | -| **Outgoing Email Domain** | `mysite-internal.com` **OR** `mysite-mail.com` | -| **Outgoing Email Subdomain Prefix** | `mail` | +| STACK OPTIONS | RECIPE 3 | +| ----------------------------------- | ------------------------------------------------------------------------------- | +| **Site Domain Name** | `mysite.com` **OR** `hub.mysite.com` + [SSL certificates](./existing-domain.md) | +| **Site is Set Up On Route 53** | `No` | +| **Internal Domain** | `mysite-internal.com` | +| **Short Link Domain** | `myhub.link` | +| **Outgoing Email Domain** | `mysite-internal.com` **OR** `mysite-mail.com` | +| **Outgoing Email Subdomain Prefix** | `mail` | -**Lastly, after the stack is successfully deployed, follow [Using an Existing Domain: DNS Setup instructions](./hubs-cloud-aws-existing-domain.md)** +**Lastly, after the stack is successfully deployed, follow [Using an Existing Domain: DNS Setup instructions](./existing-domain.md)** ### If you run into any issues: 1. Check **Site Domain Name** is typed correctly with no typos. 2. Check AWS Console > Route 53 > [Hosted Zones](https://console.aws.amazon.com/route53/home#hosted-zones:) and all of the domains you listed above are [registered](https://console.aws.amazon.com/route53/home#DomainListing:) on Route 53 or you've updated the nameservers for your domains to point to AWS Route 53 as the DNS host -3. Find the rollback error in the stack output for your region [AWS Troubleshooting: see first stack error event](./hubs-cloud-aws-troubleshooting.md#my-aws-stack-says-rollback-complete-after-deploying-what-went-wrong) -4. Troubleshoot any common errors via [AWS Troubleshooting documentation](./hubs-cloud-aws-troubleshooting.md) +3. Find the rollback error in the stack output for your region [AWS Troubleshooting: see first stack error event](./aws-troubleshooting.md#my-aws-stack-says-rollback-complete-after-deploying-what-went-wrong) +4. Troubleshoot any common errors via [AWS Troubleshooting documentation](./aws-troubleshooting.md) 5. If you can't find what you need in the rest of our documentation, see the [help page](./help.html) for ways to get in touch. diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-ccu.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-ccu.md index 217aaab..c0b802a 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-ccu.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-ccu.md @@ -19,7 +19,7 @@ There are several factors that currently limit how many users can be on a server - Various features such as (but not limited to) media uploading, photo/video capture (via the camera tool), and link thumbnail generation, use varying degrees of server resources that may effect CCU limits. -Please see [AWS Estimating Costs and Cost Charts (Alpha)](./hubs-cloud-aws-estimated-cost-charts.md) for cost estimations. +Please see [AWS Estimating Costs and Cost Charts (Alpha)](./estimating-cost.md) for cost estimations. ## Estimated CCU Table (1 App / 1 Stream server) diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-cost.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-cost.md index c840ae4..4c06999 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-cost.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/estimating-cost.md @@ -10,7 +10,7 @@ This document explains how to estimate your costs. For a full description on: - Minimizing costs - Recommended user story - Minimizing costs - Settings in stack template -See our [Costs and Minimizing Costs Information](./hubs-cloud-aws-costs.md) page. +See our [Costs and Minimizing Costs Information](./cost-saving.md) page. ## Disclaimer for Estimating Costs @@ -27,7 +27,7 @@ For the **most accurate** way to see previous costs to predict your future costs ## Estimate your Event Cost -Read the [Recommended User Story in Minimizing Costs Page](./hubs-cloud-aws-costs.md#minimize-your-costs---a-user-story) first, to understand this calculation better. +Read the [Recommended User Story in Minimizing Costs Page](./cost-saving.md#minimize-your-costs---a-user-story) first, to understand this calculation better. ## Rough Calculation for Estimating Costs @@ -35,7 +35,7 @@ Read the [Recommended User Story in Minimizing Costs Page](./hubs-cloud-aws-cost - **\# of servers** = Personal (1 server), Enterprise multi-server (varies, 2 app x 2 stream = 4 servers) - **# Hours in state** expected to be in estimated Scalar state -- **Cost for EC2 (US\$/hr)** see below [estimate cost charts (alpha)](./hubs-cloud-aws-estimated-cost-charts.md#estimate-costs-charts-alpha) +- **Cost for EC2 (US\$/hr)** see below [estimate cost charts (alpha)](./estimating-cost.md#estimate-costs-charts-alpha) - **SCALAR** _Roughly_ estimate costs of running other services like RDS, EFS, and Data transfer costs. - **5x** - **roughly** TOP ACTIVE CAPACITY, estimate a hard upper bound and heavy other service use: top CCU capacity, streaming videos, large scenes, avatars moving and talking. - **4x** - AVERAGE USE for other service: no videos, some people connected @@ -43,7 +43,7 @@ Read the [Recommended User Story in Minimizing Costs Page](./hubs-cloud-aws-cost - **2x** - ONLINE, NOT ACTIVE, database pausing is off - **1.2x** - ONLINE, NOT ACTIVE, not connected and database pausing is on - **~ 0x** - Offline mode, paying only for scene, avatar assets and backups - - [To understand these states, read Recommended User Story in Minimizing Costs Page](./hubs-cloud-aws-costs.md#minimize-your-costs---a-user-story) + - [To understand these states, read Recommended User Story in Minimizing Costs Page](./cost-saving.md#minimize-your-costs---a-user-story) - Use AWS's cost explorer to estimate previous costs for future ones. ### THE FORMULA @@ -70,7 +70,7 @@ Event with expected 500 CCU for 4 hours for 2 days. Cost charts estimate an Ente 2. Off-time, I'm putting the instance in **offline** mode. - ~$0 - ~$10 for storing backups - - If you want the instance to be online, do [THE FORMULA](./hubs-cloud-aws-estimated-cost-charts.md#the-formula) calculation for a different instance size. Use x1.2 SCALAR for database pausing and x2 SCALAR for database pausing off. + - If you want the instance to be online, do [THE FORMULA](./estimating-cost.md#the-formula) calculation for a different instance size. Use x1.2 SCALAR for database pausing and x2 SCALAR for database pausing off. 3. During setup/development, I use the **t3.medium**. I need to create scenes + deploy a custom client. I estimate that will take me an active 16 hours. @@ -86,13 +86,13 @@ Rough HC Cost Range for Example Event = **~ \$146.68** - **~ \$216.80** ### Minimize # Hours at top Capacity to Minimize Cost -**If you are diligent with decreasing the # of hours at top capacity**, outlined in the [minimizing costs user story](./hubs-cloud-aws-costs.md#minimize-your-costs---a-user-story), your event costs can be extremely low especially when comparing an in-person event: +**If you are diligent with decreasing the # of hours at top capacity**, outlined in the [minimizing costs user story](./cost-saving.md#minimize-your-costs---a-user-story), your event costs can be extremely low especially when comparing an in-person event: - Scale the EC2 instance down during lower traffic - Turn on offline mode (costs are extremely minimal because the EC2 costs + RDS costs + EFS costs are down and you're only storing backups) - Enable database pausing - Use Cloudflare for content CDN - not recommended if you're streaming videos -- Read more about these settings in [minimizing costs user story](./hubs-cloud-aws-costs.md#minimize-your-costs---a-user-story) +- Read more about these settings in [minimizing costs user story](./cost-saving.md#minimize-your-costs---a-user-story) ## EC2 Server Type Recommendations @@ -100,11 +100,11 @@ Rough HC Cost Range for Example Event = **~ \$146.68** - **~ \$216.80** **t3.medium** is recommended for development/setup with only a few users connecting + setting rooms + scenes. -**Note:** This does **not** exclude the **t3.small**, see what works for you. Scale the server type up or down ad hoc via [updating the stack](./hubs-cloud-aws-updating-the-stack.md). +**Note:** This does **not** exclude the **t3.small**, see what works for you. Scale the server type up or down ad hoc via [updating the stack](./updating-the-stack.md). **c4.large** is recommended for during an event. -**Note:** This does **not** exclude any other instances types, see what works for you. Scale the server type up or down ad hoc based on performance via [updating the stack](./hubs-cloud-aws-updating-the-stack.md). +**Note:** This does **not** exclude any other instances types, see what works for you. Scale the server type up or down ad hoc based on performance via [updating the stack](./updating-the-stack.md). **We do not recommend using a t3.micro because of low memory.** @@ -129,13 +129,13 @@ For very large events 4x4 and 8x8 Enterprise multiserver stacks are recommended. Below are our CCU estimates for best performance. Performance may vary depending on client power: high power devices (Desktop/VR) vs. low power devices (Mobile). -Use the [Rough calculation section](./hubs-cloud-aws-estimated-cost-charts.md#rough-calculation-for-estimating-costs) to get estimates. +Use the [Rough calculation section](./estimating-cost.md#rough-calculation-for-estimating-costs) to get estimates. -To see how vCPU to CCU Min/Max was estimated see [AWS Estimated CCU Limits](./hubs-cloud-aws-estimated-ccu-limits.md). +To see how vCPU to CCU Min/Max was estimated see [AWS Estimated CCU Limits](./estimating-ccu.md). ### Estimating Personal / Enterprise Costs with 1 server -[How to read and use Alpha Cost Charts](./hubs-cloud-aws-estimated-cost-charts.md#how-to-read-and-use-alpha-cost-charts) +[How to read and use Alpha Cost Charts](./estimating-cost.md#how-to-read-and-use-alpha-cost-charts) | EC2 Server Type | vCPU (#) | CCU Min | CCU Max | Cost for EC2 (US\$/hr) | | ------------------------------ | -------- | ------- | ------- | ---------------------- | @@ -157,9 +157,9 @@ To see how vCPU to CCU Min/Max was estimated see [AWS Estimated CCU Limits](./hu ### Estimating Enterprise Costs for 4 servers -2 app x 2 streaming servers recommended for best performance. [Why?](./hubs-cloud-aws-estimated-cost-charts.md#why-enterprise-2-app-x-2-stream) +2 app x 2 streaming servers recommended for best performance. [Why?](./estimating-cost.md#why-enterprise-2-app-x-2-stream) -[How to read and use Alpha Cost Charts](./hubs-cloud-aws-estimated-cost-charts.md#how-to-read-and-use-alpha-cost-charts) +[How to read and use Alpha Cost Charts](./estimating-cost.md#how-to-read-and-use-alpha-cost-charts) | EC2 Server Type | Total vCPU (#) | Min CCU | Max CCU | Cost for EC2 (US\$/hr) | | ------------------------------ | -------------- | ------- | ------- | ---------------------- | diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/existing-domain.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/existing-domain.md index aa71e0c..2811ca4 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/existing-domain.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/existing-domain.md @@ -6,12 +6,12 @@ sidebar_position: 3 **Interested in using an existing domain or subdomain for your hub?** -Follow below instructions if you're following Recipe 3. [When should I use Recipe 3?](./hubs-cloud-aws-domain-recipes.md#when-should-i-use-recipe-3) +Follow below instructions if you're following Recipe 3. [When should I use Recipe 3?](./domain-recipes.md#when-should-i-use-recipe-3) -If your domains are NOT being used for anything else, we highly recommend setting up your domain to point to AWS Route 53 Hosted Zone. [Instructions here](./hubs-cloud-aws-domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) +If your domains are NOT being used for anything else, we highly recommend setting up your domain to point to AWS Route 53 Hosted Zone. [Instructions here](./domain-recipes.md#setup-external-domains-to-use-route-53-as-the-hostingdns-provider) [] -**If you want to use your existing email, see our [Using an Existing Email Provider guide](./hubs-cloud-aws-existing-email-provider.md)**. Otherwise, walk through the Domain Recipes #3 guide for configuring AWS SES email via stack creation. +**If you want to use your existing email, see our [Using an Existing Email Provider guide](./existing-email.md)**. Otherwise, walk through the Domain Recipes #3 guide for configuring AWS SES email via stack creation. ### Before creating the stack: SSL Certificates diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/quick-start.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/quick-start.md index 89daec7..eebef06 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/quick-start.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/quick-start.md @@ -9,11 +9,11 @@ sidebar_position: 1 **Follow along:** [Video Tutorial: How to Deploy Hubs Cloud Part 1](https://www.youtube.com/watch?v=2K7P8jFyHNc) 1. Create an account on AWS and log into the console. -2. Register or setup any domains in AWS Route 53, you'll need at least 2 domains. For example: `myhub.com` and `myhub.link`. See [Domain Recipes](./hubs-cloud-aws-domain-recipes.md) for more info. +2. Register or setup any domains in AWS Route 53, you'll need at least 2 domains. For example: `myhub.com` and `myhub.link`. See [Domain Recipes](./domain-recipes.md) for more info. 3. Review relevant docs: - - [Why use Hubs Cloud vs. hubs.mozilla.com?](./hubs-cloud-faq.md#why-use-hubs-cloud-vs-hubsmozillacom) - - [Personal vs. Enterprise](./hubs-cloud-faq.md#personal-vs-enterprise) - - [Cost Information](./hubs-cloud-aws-costs.md) + - [Why use Hubs Cloud vs. hubs.mozilla.com?](/archive/hubs-cloud/faq.md#why-use-hubs-cloud-vs-hubsmozillacom) + - [Personal vs. Enterprise](/archive/hubs-cloud/faq.md#personal-vs-enterprise) + - [Cost Information](./cost-saving.md) 4. Create an SSH keypair to access your servers - [Follow AWS guide to create the SSH keypair in your deployment region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair) - Deployment region is in the upper right corner with your username and support @@ -39,16 +39,16 @@ sidebar_position: 1 - Account Configuration Administrator Email Address - NO CAPITALIZED LETTERS - The admin for your hub - - For these parameters use [Domain Recipes](./hubs-cloud-aws-domain-recipes.md) for guidance: `Site Domain Name`, `Site is Set Up On Route 53`, `Internal Domain`, `Short Link Domain`, `Outgoing Email Domain`, and `Outgoing Email Subdomain Prefix` + - For these parameters use [Domain Recipes](./domain-recipes.md) for guidance: `Site Domain Name`, `Site is Set Up On Route 53`, `Internal Domain`, `Short Link Domain`, `Outgoing Email Domain`, and `Outgoing Email Subdomain Prefix` - Double check for no typos! - Choose your `KeyPair` from Before Creating the Stack: Step 4 - - If you are using an existing domain not on AWS Route 53, you'll need to perform a few extra steps - See [Using an existing domain](./hubs-cloud-aws-existing-domain.md) + - If you are using an existing domain not on AWS Route 53, you'll need to perform a few extra steps - See [Using an existing domain](./existing-domain.md) - Choose a setting for `Restrict SSH Access` - - Review the other options, or keep the defaults. You can update most of these later via a [Stack Update](./hubs-cloud-aws-updating-the-stack.md) + - Review the other options, or keep the defaults. You can update most of these later via a [Stack Update](./updating-the-stack.md) 9. Select **"Next"** 10. Agree to Terms of Service checkboxes 11. Wait 20-30 minutes for the stack to complete deploying - - Any issues? Check out [AWS Troubleshooting](./hubs-cloud-aws-troubleshooting.md) for solutions to common problems. + - Any issues? Check out [AWS Troubleshooting](./aws-troubleshooting.md) for solutions to common problems. 12. Confirm your `Administrator Email Address` in your inbox, it will be confirming your email in **N. Virginia** 13. After stack is created, hit your site at your primary domain, wait 20 to 30 seconds 14. Login with your `Administrator Email Address` @@ -57,13 +57,13 @@ sidebar_position: 1 **Follow along:** [Video Tutorial: How to Deploy Hubs Cloud Part 3](https://www.youtube.com/watch?v=nQ85L_EeJOk) -1. Set up AWS Simple Email Service (SES) in **N. Virginia (us-east-1)** for **_all_** deploy regions to get out of the SES Sandbox [Follow #2 Send request to AWS for limit increase](./hubs-cloud-aws-troubleshooting.md#youre-in-the-aws-sandbox-and-people-dont-receive-magic-link-emails) - - For immediate entry to your HC instance, verify individual email addresses [Follow #1 Verify individual email addresses for administrators](./hubs-cloud-aws-troubleshooting.md#youre-in-the-aws-sandbox-and-people-dont-receive-magic-link-emails) +1. Set up AWS Simple Email Service (SES) in **N. Virginia (us-east-1)** for **_all_** deploy regions to get out of the SES Sandbox [Follow #2 Send request to AWS for limit increase](./aws-troubleshooting.md#youre-in-the-aws-sandbox-and-people-dont-receive-magic-link-emails) + - For immediate entry to your HC instance, verify individual email addresses [Follow #1 Verify individual email addresses for administrators](./aws-troubleshooting.md#youre-in-the-aws-sandbox-and-people-dont-receive-magic-link-emails) 2. Follow guide in **Admin Panel** > **Content CDN** menu to setup Cloudflare workers to decrease costs -3. Proceed with process to add scenes and avatars in the [Getting Started with Hubs Cloud](./hubs-cloud-getting-started.md) guide! +3. Proceed with process to add scenes and avatars in the [Getting Started with Hubs Cloud](/archive/hubs-cloud/getting-started.md) guide! **Congrats you've successfully set everything up!** #### Any issues deploying? -Check out [AWS Troubleshooting](./hubs-cloud-aws-troubleshooting.md) for solutions to common problems. +Check out [AWS Troubleshooting](./aws-troubleshooting.md) for solutions to common problems. diff --git a/website/docs/archive/hubs-cloud/hubs-cloud-aws/updating-the-stack.md b/website/docs/archive/hubs-cloud/hubs-cloud-aws/updating-the-stack.md index 5071ca0..554ea40 100644 --- a/website/docs/archive/hubs-cloud/hubs-cloud-aws/updating-the-stack.md +++ b/website/docs/archive/hubs-cloud/hubs-cloud-aws/updating-the-stack.md @@ -24,7 +24,7 @@ Some of the things you can do via a stack update: Some things you should **not** update or change after the stack is created, and should leave as-is: - Your domains or mail settings -- Everything under **Restore from Backup** section (to restore from a backup, see [Backup and Restore](./hubs-cloud-aws-backup-and-restore.md)) +- Everything under **Restore from Backup** section (to restore from a backup, see [Backup and Restore](./backup-and-restore.md)) - Everything under **Advanced** ## ✨📝 Upgrade your Hubs Cloud template to the latest @@ -33,14 +33,14 @@ Infrequently, we'll need to update the Hubs Cloud template which follows this ma Updating the template changes the underlying aws infrastructure or services such as: machine images, lambdas, autoscaling groups, or machine startup scripts. -💾 Before following the steps below, make sure you've backed up your stack just in case: [💾 Backup and Restore](./hubs-cloud-aws-backup-and-restore.md) +💾 Before following the steps below, make sure you've backed up your stack just in case: [💾 Backup and Restore](./backup-and-restore.md) 1. 🔎 **Determine whether your stack is Hubs Cloud Personal, Enterprise single server, or Enterprise multi-server** 1. Cloudformation > Stacks > Select your stack > Parameters tab 1. Does your stack have # of App Servers or # of Streaming Servers listed? 1. If yes, you have Enterprise multi-server 1. If no, you have Personal or Enterprise single server -1. 💤 **Update your stack to Offline Mode see [⬆️ Updating the stack](./hubs-cloud-aws-updating-the-stack.md)** +1. 💤 **Update your stack to Offline Mode see [⬆️ Updating the stack](./updating-the-stack.md)** 1. ⌛ **Wait for the Offline Mode update to complete** 1. 📎 **Next, get the latest Template URL from the AWS Marketplace flow (_DO NOT CREATE A NEW STACK_)** 1. Open new tab and go to [hubs.mozilla.com/cloud](https://hubs.mozilla.com/cloud) @@ -56,5 +56,5 @@ Updating the template changes the underlying aws infrastructure or services such 1. Click Next 1. ✅ Do all filled in values look correct? If they do **NOT** look correct, then you may have copied the wrong Personal/Enterprise template! Go back to replace template step. Then copy and paste the correct template from step 4 again. 1. ⌛ **Finish the stack update with the new template stay in Offline Mode** -1. 🌅 **After the update is complete, [⬆️ update the stack](./hubs-cloud-aws-updating-the-stack.md) to Online Mode (out of Offline Mode)** +1. 🌅 **After the update is complete, [⬆️ update the stack](./updating-the-stack.md) to Online Mode (out of Offline Mode)** 1. 🎉 **Finished! Congrats!** 🎉 diff --git a/website/docs/archive/hubs-cloud/importing-content.md b/website/docs/archive/hubs-cloud/importing-content.md index 9f7bd4a..cccc59b 100644 --- a/website/docs/archive/hubs-cloud/importing-content.md +++ b/website/docs/archive/hubs-cloud/importing-content.md @@ -6,11 +6,11 @@ sidebar_position: 4 The two forms of content you can import into Hubs Cloud are **avatars** and **scenes**. Avatars are 3D figures like robots, humans, and ducks that can be worn by visitors to represent themselves, and scenes are 3D environments like interiors and landscapes that provide visual grounding for a room. -Mozilla offers a number of [Asset Packs](./hubs-cloud-asset-packs.md) you can import to add some initial content to your hub. Additionally, you can import any custom content you've created, either on [hubs.mozilla.com](https://hubs.mozilla.com), or using the tools like the [Scene Editor](./hubs-cloud-enable-scene-editor.md) available on your hub. For more information about the Scene Editor, see [Spoke Documentation](http://hubs.local:3000/docs/docs/spoke-creating-projects.html)[^1]. +Mozilla offers a number of [Asset Packs](./asset-packs.md) you can import to add some initial content to your hub. Additionally, you can import any custom content you've created, either on [hubs.mozilla.com](https://hubs.mozilla.com), or using the tools like the Scene Editor available on your hub. For more information about the Scene Editor, see [Spoke Documentation](/creators/spoke/create-project.html)[^1]. ### Admin Import Tool -To start importing content, navigate to the "Import Content" tool from the Admin Console. If you don't remember how to get to the Admin Console, see the [Getting Started](./hubs-cloud-getting-started.md) Guide. +To start importing content, navigate to the "Import Content" tool from the Admin Console. If you don't remember how to get to the Admin Console, see the [Getting Started](./getting-started.md) Guide. [^1]: 'Spoke' is the Mozilla trademarked name used for the Scene Editor on [hubs.mozilla.com](https://hubs.mozilla.com). @@ -20,7 +20,7 @@ Once there, you'll need to specify a URL to import: ![Hubs Cloud Import Content URL](/img/hubs-cloud-import-content-url.jpeg) -You can enter comma-separated URLs to scenes or avatars on another hub ([example scene](https://hubs.mozilla.com/scenes/rWgv5zN/winter-cheer), [example avatar](https://hubs.mozilla.com/avatars/PcJ8Sxb)). Or, you can specify a link to an [asset pack](./hubs-cloud-asset-packs.md). +You can enter comma-separated URLs to scenes or avatars on another hub ([example scene](https://hubs.mozilla.com/scenes/rWgv5zN/winter-cheer), [example avatar](https://hubs.mozilla.com/avatars/PcJ8Sxb)). Or, you can specify a link to an [asset pack](./asset-packs.md). Once you've specified the content URL, you will see a preview of the content you're planning to import. You can then choose to exclude or include certain items and set special tags: @@ -37,7 +37,7 @@ You should also set the proper tags for the imported items for your hub to be re - Import at least one **Base** avatar, which can easily be re-skinned by visitors. - Optionally **Feature** one or more items, which will cause those items to be easily discoverable by visitors. -For more information about special tags, see [Managing Content](./hubs-cloud-managing-content.md). +For more information about special tags, see [Managing Content](./managing-content.md). ### Updating Imported Content diff --git a/website/docs/archive/hubs-cloud/introduction.md b/website/docs/archive/hubs-cloud/introduction.md index c1bebbf..da59296 100644 --- a/website/docs/archive/hubs-cloud/introduction.md +++ b/website/docs/archive/hubs-cloud/introduction.md @@ -14,9 +14,9 @@ READ MORE [HERE](https://hubs.mozilla.com/#subscribe)** ### Set up your own Hubs Cloud server: -- For AWS, see the [AWS Quick Start](./hubs-cloud-aws-quick-start.md) -- For DigitalOcean, see the [DigitalOcean Quick Start](./hubs-cloud-do-quick-start.md) -- Once your hub is up, see the [Getting Started Guide](./hubs-cloud-getting-started.md) +- For AWS, see the [AWS Quick Start](./hubs-cloud-aws/quick-start.md) +- For DigitalOcean, see the [DigitalOcean Quick Start](./hubs-cloud-do/do-quick-start.md) +- Once your hub is up, see the [Getting Started Guide](./getting-started.md) ### Hubs Cloud Key Features: @@ -28,4 +28,4 @@ READ MORE [HERE](https://hubs.mozilla.com/#subscribe)** **Currently, Hubs Cloud is offered on AWS and DigitalOcean.** -**Note: If you're looking for community Edition, which is the replacement for hubs cloud that you can bring anywhere as a dev, read [Hubs Community Edition](./hubs-community-edition-intro.md)** +**Note: If you're looking for community Edition, which is the replacement for hubs cloud that you can bring anywhere as a dev, read [Hubs Community Edition](/developers/community-edition/intro-ce.md)** diff --git a/website/docs/archive/hubs-cloud/limiting-access.md b/website/docs/archive/hubs-cloud/limiting-access.md index 1f67182..9c0cc2b 100644 --- a/website/docs/archive/hubs-cloud/limiting-access.md +++ b/website/docs/archive/hubs-cloud/limiting-access.md @@ -11,22 +11,22 @@ This guide shows you how to lockdown your hub and rooms by **account only access To lockdown your instance, you remove account creation for non-admins and lock your instance to account access only. Before or after you lockdown your instance to accounts, as the hub admin, you can create accounts for a list of emails or disable existing accounts. 1. **(Account management) Create accounts for approved emails** - 1. Admin Panel > Accounts menu - [_NetworkError?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) + 1. Admin Panel > Accounts menu - [_NetworkError?_](./hubs-cloud-aws/aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) 2. Batch create accounts (with optional identities) - Single example: email1,identity1 - Multiple example: email1,identity1;email2;email3,identity3 with spaces;email4 2. **(Account management) Remove access to existing accounts by "Disabling" accounts** - 1. Admin Panel > Accounts menu - [_NetworkError?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) + 1. Admin Panel > Accounts menu - [_NetworkError?_](./hubs-cloud-aws/aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) 2. Paste email address in "Find an account with an email address" text box 3. Select "FIND" 4. Change "State" dropdown to "disabled" 5. Click "Save" 3. **Remove account creation for non-admins** - 1. Admin Panel > Setup: App Settings - [_Not Found page?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) + 1. Admin Panel > Setup: App Settings - [_Not Found page?_](./hubs-cloud-aws/aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) 2. Select "Features" tab 3. Enable "Disable account creation" 4. **Lock your hub to only accounts can access** - 1. Admin Panel > Setup: App Settings - [_Not Found page?_](./hubs-cloud-aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) + 1. Admin Panel > Setup: App Settings - [_Not Found page?_](./hubs-cloud-aws/aws-troubleshooting.md#in-my-hubs-admin-panel-i-see-networkerror-or-not-found-page-or-no-data-populates-in-any-of-the-admin-menus) 2. Select "Rooms" tab 3. Enable "Require accounts for room access" @@ -38,10 +38,10 @@ To lockdown your instance, you remove account creation for non-admins and lock y - Room-by-room access or channel-by-channel: If the user does not have access to that room bound channel, they will not have access - User's identity is tied to their identity in Discord -[Learn more about the Discord bot here](./hubs-discord-bot.md) +[Learn more about the Discord bot here](/archive/discord-bot.md) -[Enable the Discord bot for your Hubs Cloud instance](./hubs-cloud-discord-bot.md) +[Enable the Discord bot for your Hubs Cloud instance](/archive/hubs-cloud/discord-bot.md) ## Room Access Settings -Individual rooms can also limit access via [Room Access Settings](./hubs-room-settings.md#room-access). +Individual rooms can also limit access via [Room Access Settings](/fundamentals/room-settings.md#room-access). diff --git a/website/docs/archive/hubs-cloud/managing-content.md b/website/docs/archive/hubs-cloud/managing-content.md index 4cd7299..68e22ec 100644 --- a/website/docs/archive/hubs-cloud/managing-content.md +++ b/website/docs/archive/hubs-cloud/managing-content.md @@ -12,7 +12,7 @@ However, as the administrator of a hub, you don't always want the content contri When a visitor creates a custom avatar or scene, they are offered the option to mark it as _remixable_ and/or _promotable_. _Remixable_ content confers a Creative Commons 3 license to the content so others are free to use or modify it, and _promotable_ content will be enqueued for review to be added to your hub's content library. Once it is approved, content in the library can be discovered by users through tools like the Media Browser. -All content marked as _Promotable_ will be added to the **Pending Scene/Avatar Queue** when it is either created or updated. You can find these queues in your [Admin Console](./hubs-cloud-getting-started.md): +All content marked as _Promotable_ will be added to the **Pending Scene/Avatar Queue** when it is either created or updated. You can find these queues in your [Admin Console](./getting-started.md): ![Hubs Cloud Pending Queue Menu](/img/hubs-cloud-pending-queue-menu.jpeg) diff --git a/website/docs/archive/hubs-cloud/permissive-rooms.md b/website/docs/archive/hubs-cloud/permissive-rooms.md index 8b8dafe..9bcb64d 100644 --- a/website/docs/archive/hubs-cloud/permissive-rooms.md +++ b/website/docs/archive/hubs-cloud/permissive-rooms.md @@ -6,11 +6,11 @@ sidebar_position: 11 Out of the box, the default permissions set on rooms is highly restrictive. This means that if you create a room, only yourself and visitors you choose to promote will have access to all features. Other visitors to your room will be restricted from using most features other than appearing as avatars and speaking. -Room Permissions can be set on a room-by-room basis to allow more access to room visitors (to see how, see [Room Settings](./hubs-room-settings.md).) +Room Permissions can be set on a room-by-room basis to allow more access to room visitors (to see how, see [Room Settings](/fundamentals/room-settings.md).) However, sometimes you want to enable all permissions for all visitors for newly created rooms. For example, you may trust all visitors to your hub use features like media spawning and drawing responsibly. -To change the default permissions of new rooms to be more permissive. First, open the [Admin Console](./hubs-cloud-getting-started.md) then choose **App Settings**: +To change the default permissions of new rooms to be more permissive. First, open the [Admin Console](./getting-started.md) then choose **App Settings**: ![Hubs Cloud App Settings](/img/hubs-cloud-app-settings.jpeg) diff --git a/website/docs/archive/hubs-cloud/ssh-access.md b/website/docs/archive/hubs-cloud/ssh-access.md index 1ec6938..4e5d71a 100644 --- a/website/docs/archive/hubs-cloud/ssh-access.md +++ b/website/docs/archive/hubs-cloud/ssh-access.md @@ -4,7 +4,7 @@ sidebar_position: 15 # Advanced: SSH Access -To access your servers over SSH, in 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. +To access your servers over SSH, in the [Admin Console](./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. Your servers are running [Ubuntu 18.04 Bionic Beaver](http://releases.ubuntu.com/18.04/). diff --git a/website/docs/archive/hubs-cloud/third-party-integrations.md b/website/docs/archive/hubs-cloud/third-party-integrations.md index fc70c29..838911e 100644 --- a/website/docs/archive/hubs-cloud/third-party-integrations.md +++ b/website/docs/archive/hubs-cloud/third-party-integrations.md @@ -10,7 +10,7 @@ Your hub includes integrations for searching useful content for visitors to spaw However, before these various content tabs will be enabled for your hub, you will need to add the necessary API keys to enable the integrations. -In the [Admin Console](./hubs-cloud-getting-started.md) choose **Server Settings**: +In the [Admin Console](./getting-started.md) choose **Server Settings**: ![Hubs Cloud ](/img/hubs-cloud-server-settings.jpeg) diff --git a/website/docs/creators/spoke/create-project.md b/website/docs/creators/spoke/create-project.md index ea7f442..dc1f65d 100644 --- a/website/docs/creators/spoke/create-project.md +++ b/website/docs/creators/spoke/create-project.md @@ -20,7 +20,7 @@ Select "New Project" and you'll be able to pick existing scenes from the communi ![Spoke Templates](/img/spoke-template.jpeg) -From here you can customize your scene entirely to your liking! Try [adding content](./spoke-adding-scene-content.md) to your scene, or building a house with our [architecture kit](./spoke-architecture-kit.md). +From here you can customize your scene entirely to your liking! Try [adding content](./adding-content.md) to your scene, or building a house with our [architecture kit](./architecture-kit.md).