Phoenix web server for hubs.mozilla.com
A hybrid game networking and web API server, focused on Social Mixed Reality.
Linux:
On Ubuntu, you can use
apt install postgresql
Otherwise, consult your package manager of choice for other Linux distributions
Windows: https://www.postgresql.org/download/windows/
Windows WSL: https://github.com/michaeltreat/Windows-Subsystem-For-Linux-Setup-Guide/blob/master/readmes/installs/PostgreSQL.md
https://elixir-lang.org/install.html
https://hexdocs.pm/phoenix/installation.html
https://docs.ansible.com/ansible/latest/installationguide/introinstallation.html
Run the following commands at the root of the reticulum directory:
mix deps.get
mix ecto.create
postgresrole to match the password configured
dev.exs.
psqlshell, enter
ALTER USER postgres WITH PASSWORD 'postgres';
ret_devdatabase does not exist, (using psql again) enter
create database ret_dev;
assetsdirectory,
npm install
mkdir -p storage/dev
Run
scripts/run.shif you have the hubs secret repo cloned. Otherwise
iex -S mix phx.server
hubs.localhostname
When running the full stack for Hubs (which includes Reticulum) locally it is necessary to add a
hostsentry pointing
hubs.localto your local server's IP. This will allow the CSP checks to pass that are served up by Reticulum so you can test the whole app. Note that you must also load hubs.local over https.
On MacOS or Linux:
nano /etc/hosts
From there, add a host alias
Example:
bash 127.0.0.1 hubs.local
Clone the Hubs repository and install the npm dependencies.
git clone https://github.com/mozilla/hubs.git cd hubs npm ci
Because we are running Hubs against the local Reticulum client you'll need to use the
npm run localcommand in the root of the
hubsfolder. This will start the development server on port 8080, but configure it to be accessed through Reticulum on port 4000.
Once both the Hubs Webpack Dev Server and Reticulum server are both running you can navigate to the client by opening up:
https://hubs.local:4000?skipadmin
The
skipadminis a temporary measure to bypass being redirected to the admin panel. Once you have logged in you will no longer need this.
To log into Hubs we use magic links that are sent to your email. When you are running Reticulum locally we do not send those emails. Instead, you'll find the contents of that email in the Reticulum console output.
With the Hubs landing page open click the Sign In button at the top of the page. Enter an email address and click send.
Go to the reticulum terminal session and find a url that looks like https://hubs.local:4000/?authorigin=hubs&authpayload=XXXXX&auth_token=XXXX
Navigate to that url in your browser to finish signing in.
After you've started Reticulum for the first time you'll likely want to create an admin user. Assuming you want to make the first account the admin, this can be done in the iex console using the following code:
Ret.Account |> Ret.Repo.all() |> Enum.at(0) |> Ecto.Changeset.change(is_admin: true) |> Ret.Repo.update!()
When running locally, you will need to also run the admin portal, which routes to hubs.local:8989 Using a separate terminal instance, navigate to the
hubs/adminfolder and use:
npm run local
You can now navigate to https://hubs.local:4000/admin to access the admin control panel
./scripts/run_local_reticulum.shin the root of the spoke project
dev.exs:
dev_janus_host = "hubs.local"
dev.exs:
config :ret, Ret.JanusLoadStatus, default_janus_host: dev_janus_host, janus_port: 4443
add_csp.ex:
default_janus_csp_rule = if default_janus_host, do: "wss://#{default_janus_host}:#{janus_port} https://#{default_janus_host}:#{janus_port} https://#{default_janus_host}:#{janus_port}/meta", else: ""
psql-userdb="host=hubs.local dbname=ret_dev user=postgres password=postgres options='-c search_path=coturn' connect_timeout=30"