Skip to main content

​
Setting up Orbit in your server

You require basic knowledge in usage of terminal as well as NextJS.
Planetary is not responsible for any user errors caused during the setup process or usage.

​
Prerequisites

  • A machine that is capable of running Command/Console tasks (e.g. Ubuntu)
  • Root access
  • PostgreSQL Database
  • Package manager (e.g. npm)
  • Domain and SSL Encryption

​
Installing Orbit

Once you’re connected to your server, follow the command guide below in your terminal/console session.
  1. Update your Server
sudo apt update
sudo apt upgrade
  1. Install Required packages
sudo apt install git curl build-essential -y
  1. Install Node.js (v20+) and your package manager
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs
  1. Install PostgresSQL
sudo apt install postgresql postgresql-contrib -y
sudo systemctl enable --now postgresql
  1. Create PostgreSQL User and Database
sudo -u postgres psql

CREATE USER orbituser WITH PASSWORD 'strongpassword';
CREATE DATABASE orbitdb OWNER orbituser;
\q
Ensure you replace “strongpassword” with your own unique password.
  1. Clone Orbit Repository
git clone https://github.com/PlanetaryOrbit/orbit && cd orbit
  1. Install Orbit Dependencies
npm install
  1. Create .env configuration file
nano .env
Paste the following: 
DATABASE_URL="postgresql://orbituser:strongpassword@localhost:5432/orbitdb"
SESSION_SECRET="your_32_character_generated_key"
Remember to replace “strongpassword” with your chosen secure password from earlier.Generate a 32-character session key here: 1Password Generator
Save and close (Ctrl + X -> Y -> Enter)
  1. Build Orbit
npm run build
  1. Initialize Database
npx prisma db push
  1. Start Orbit
npm run start
  1. Run Orbit in Background with PM2 (RECOMMENDED)
npm install -g pm2

pm2 start npm --name="Orbit" -- start

pm2 startup
pm2 save
Remember to build your database otherwise you won’t be able to access your workspace.
  1. Complete setup via Web Interface
  2. Go to https://your.server.com - Must be SSL
  3. Enter your Roblox Group ID
  4. Enter your Roblox username and a password
  5. 🎉 You’re all set!

​
Looking to make your syncing automatic?

View our Automation Setup guide here.