Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial server quick start guide docs added. #94

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -191,3 +191,11 @@ def setup(app):

# -- Markdown Setup ---------------------------------------------------------
extensions = ['recommonmark']

# Variables

rst_prolog = """
.. |serverdeb| replace:: https://cdn.vircadia.com/dist/domain-server/ubuntu/vircadia-server_2020.3.1-demeter-20201026-5c945c1-0ubuntu1-1_amd64.deb
.. |serverdebfile| replace:: vircadia-server_2020.3.1-demeter-20201026-5c945c1-0ubuntu1-1_amd64.deb
.. |serverrpm| replace:: https://cdn.vircadia.com/dist/domain-server/amazon-linux/vircadia-server-2020.3.1_DEMETER_20201026_5c945c1-1.amzn2.x86_64.rpm
"""
2 changes: 1 addition & 1 deletion docs/source/create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Create

Vircadia enables people connected by interest, community, and friendship to come together and express their creativity with each other. We invite you to personalize your own experience by creating avatars and wearables, building immersive experiences, and developing apps to make the metaverse your own.

No matter your level of expertise, Athena provides the tools you need to create anything you can imagine.
No matter your level of expertise, Vircadia provides the tools you need to create anything you can imagine.

Throughout this chapter, learn how to create, build, and bring to life your own VR experience:

Expand Down
7 changes: 5 additions & 2 deletions docs/source/host.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
Host
####

Vircadia's vision is a decentralized network of virtual worlds, created and controlled by our users. To achieve this vision, we want you to have the power to express your creativity, build your own virtual worlds, and be a part of an expanding metaverse.
Vircadia's vision is a decentralized network of virtual worlds, created and controlled by its users. To achieve this vision, we want you to have the power to express your creativity, build your own virtual worlds, and be a part of an expanding metaverse.

Throughout this chapter, learn what its like to create your own domain, host it on a server, and maintain it so that it can be enjoyed by users for years to come.
Throughout this chapter, learn what its like to create your own domain, host it on a server, and maintain it so that it can be enjoyed by users for years to come.

If you want to jump right in, consider reading the :doc:`quick start guide <host/quick-start>`. Otherwise, let's :doc:`get started <host/start-hosting>`.

.. toctree::
:maxdepth: 2
:titlesonly:

Quick Start Guide <host/quick-start>
Get Started with Hosting <host/start-hosting>
Set Up a Domain Server <host/server-setup>
Configure Your Domain Settings <host/configure-settings>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/source/host/quick-start.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
########################
Hosting Quick Start
########################

.. contents:: On This Page
:depth: 2

----------------------------
Notice: Port Forwarding
----------------------------

There are two ways to make a domain accessible from the Internet.

1. You may register your domain with the Metaverse server by creating a `Domain ID` in the domain's web panel found at http://localhost:40100/. Replacr localhost with your server's address if it is not hosted on the same machine you are accessing it with.
2. Alternatively, you can manually open the following ports on your router and firewall:
digisomni marked this conversation as resolved.
Show resolved Hide resolved

* 40100 : (tcp) administration web portal
* 40102 : (udp) main connection for clients

----------------------------
Windows
----------------------------

1. Download the Vircadia Installer.
2. Use the `Express` install option, or if you use the `Custom` option ensure that both the `Vircadia Interface` and `Vircadia Server` options are checked. Vircadia Server is the domain server.

.. image:: _images/full-install-components.png

3. In your start menu, search for and run `Vircadia Server`.
4. Go to ``http://localhost:40100/`` in your web browser and complete the wizard to set up your domain. If the server is on a different machine, then replace 'localhost' with its IP address.
5. In your Vircadia Interface, open the `Explore` app and enter `localhost` (or the server's address) to get there.

----------------------------
Amazon Linux 2
----------------------------

1. Open your terminal.
2. Run the following command to download and install the server:

sudo yum install |serverrpm|

4. Go to ``http://[IP address of your server]:40100/`` in your web browser and complete the wizard to set up your domain.
5. In your Vircadia Interface, open the `Explore` app and enter your server's address to get there.

----------------------------
Ubuntu 18.04
----------------------------

1. Open your terminal.
2. Run the following command to download the server:

wget |serverdeb|

3. Then run this command to update and install the server:

sudo apt update && sudo apt install ./|serverdebfile|

4. Go to ``http://[IP address of your server]:40100/`` in your web browser and complete the wizard to set up your domain.
5. In your Vircadia Interface, open the `Explore` app and enter your server's address to get there.
9 changes: 5 additions & 4 deletions docs/source/host/start-hosting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Get Started with Hosting

We are thrilled you've decided to host a custom domain with us on the metaverse! We also understand that setting up a server, configuring it, and creating a domain takes some time and technical knowledge. Hopefully, this section will help you become familiar with the basics of hosting domains in Vircadia, so that you can create the space you want and be a part of building a bigger, more expansive metaverse.

You can also follow the :doc:`quick start guide <quick-start>` to quickly boot up a domain to tinker with.

.. contents:: On This Page
:depth: 2

Expand All @@ -13,9 +15,9 @@ Overview of Hosting

Vircadia's hosting interface consists of the following components that work together to create an immersive VR experience for your visitors:

* The *Sandbox* is a testing environment hosted locally on your computer that gives you a space to play around and build content without affecting any domains in the metaverse. Note that it is possible to configure Vircadia so that your Sandbox is also a registered domain that is hosted directly from your local computer. The Sandbox application can be download from the `Vircadia website <https://www.highfidelity.com/download#sandbox>`_.
* A *domain* is a registered location in the metaverse. Each domain is assigned a unique ID to identify it. You can sign up for a new domain in one of two ways: either by setting up a Vircadia server or by logging into your account via the Vircadia website.
* A *server* hosts a domain, and processes incoming network requests for the domain. The server for your domain is either a physical computer or a cloud-hosted server.
* The Vircadia *Server* is a locally hosted environment on your computer that gives you a space to play around and build content in. You can register your server with the Metaverse to make it accessible from the outside world. The server is included with full Windows installers from the `Vircadia website <https://vircadia.com/download-vircadia/#windows>`_.
* A *Domain* is a registered location in the metaverse. Each Domain is assigned a unique ID to identify it. You can run a Domain on a Windows or Linux machine.
* A *server* hosts a Domain, and processes incoming network requests for the Domain.
* A *droplet* or *cloud domain* is a cloud server hosted on DigitalOcean.
* A *content set* is the content that you've designed to make your domain unique and pretty.

Expand All @@ -32,4 +34,3 @@ Here is an overview of the steps you'll need to take to host your domain up and
5. :doc:`Invite users to your domain <invite-users>`

Once your domain is running, we'll cover how to :doc:`configure your domain settings <configure-settings>`, from the most basic to the more advanced, and how to :doc:`maintain your domain <maintain-domain>`.