immers

immers

ActivityPub server for immers.space - a decentralized virtual reality metaverse platform powered by Mozilla Hubs and activitypub-express.

Installation & setup

Domains

For the best user experience, install your hubs-cloud on a subdomain (e.g. hub.yourdomain.com) when running the hubs-cloud setup and then use the main domain (e.g. yourdomain.com) for your immer. This way users only need to use the main domain in the immers handle ([e-mail]). Attempts to navigate to the main domain will be redirected to the hub homepage automatically.

Immers server deploy

Setup a web server with MongoDB (v4.x), NodeJS (v12.x), pm2, authbind, and Let's Encrypt certbot. See detailed instructions for these steps if needed.

• Install immers from github

git clone https://github.com/wmurphyrd/immers.git
cd immers
npm ci

• Copy SSL certificates (replace domain name, username)

sudo cp -RL /etc/letsencrypt/live/example.com/. certs/
sudo chown -R myuser certs/.

• Copy config-template.json to config.json and edit to configure immers server

Key	Value
port	Port number for immers sever (usually 443)
domain	Immers server host
hub	Hubs cloud host
homepage	Optonal, redirect root html requests to this url (defaults to hub)
name	Name of your immer
dbName	Database name to use with MongoDb
smtpHost	Mail service domain
smtpPort	Mail delivery port
smtpFrom	From address for emails (match mail domain configured in hubs)
keyPath	Relative path to SSL private key (privkey.pem)
certPath	Relative path to SSL certificate (cert.pem)
caPath	Relative path to SSL certificate authority (chain.pem)
monetizationPointer	Optional. Adding a payment pointer here activates Web Monetization
theme	Object containing optional theme properties
theme.googleFont	Font family name from to fetch from Google Fonts
theme.backgroundColor	CSS color,
theme.backgroundImage	Image file,
theme.imageAttributionText	Attribution for backgroundImage, if needed,
theme.imageAttributionUrl	Attribution for backgroundImage, if needed

• Copy secrets-template.json to secrets.json and edit to configure secrets

Key	Value
sessionSecret	Secret key for session cookie encryption
easySecret	Secret key for login token encryption
smtpUser	Username for mail service
smtpPassword	Password for mail service

• Start server with pm2 & authbind

authbind --deep pm2 start npm --name="redirector" -- run https-redirect
authbind --deep pm2 start npm --name="immer" -- run start
# one-time setup for autorestart
pm2 startup
pm2 save

Hubs cloud setup

1. Deply custom hubs client from immers-space/hubs#immers-integration
2. Add config in hubs cloud admin -> setup -> sever settings -> advanced

• Extra room Header HTML: <meta name="env:immers_server" content="https://your.immers.server"> (replace value in content with your immers server url)
• Extra Content Security Policy connect-src Rules: https: wss: (allows API and streaming connections to remote users home instances)
• Allowed CORS origins: * (temporary measure cross-hub for avatar sharing)

Local dev

immers

• Clone and install immers

git clone https://github.com/immers-space/immers.git
cd immers
npm ci

• Install a self-signed certificate

mkdir certs
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout certs/server.key -out certs/server.cert

• Install mongodb
• Run immer with npm run dev

hubs

• Clone and install our fork

git clone https://github.com/immers-space/hubs.git
cd hubs
git checkout immers-integration
npm ci

• Run hub with either npm run dev (use Hubs dev networking servers) or npm run start (to connect to your hubs cloud networking server).
• Visit hub at https://localhost:8080, create a room, and you will be redirected to login or register with your immer. You'll encounter and need to bypass certificate warnings for both the hub and immer domains. To get e-mail confirmation links, check the immers console for a link to read the email

Default immers server is https://localhost:8081, override with entry IMMERS_SERVER in hubs repo root folder .env file.