Get Started

To get started, press one of the buttons below to deploy Incog

NOTE:

• This will NOT deploy on Github Pages, Netlify, Vercel, Gitlab Pages or any other static host
• This will NOT work on Render

---

How to get links

---

Features

• Multiple Proxy "Backends":
  • Ultraviolet
  • RammerHead

---

Contributors

• Rifting - Owner & Maintainer
• MotorTruck1221 - Maintainer

---

Tech Stack

• Astro
• Fastify
• Ultraviolet
• RammerHead
• Epoxy
• Libcurl.js
• HTML, CSS, and JavaScript (DUH)

---

Deployment

Terminal

Prerequisites:

• Node & npm
• Git

1. Clone the repo:

git clone https://github.com/nebulaservices/nebula && cd nebula

2. Install all of the dependencies:

npm i

3. Create a .env file

cp .env.example .env

4. Modify the .env file to you liking (docs here)

nano .env

5. Build the frontend:

npm run build

6. Start the server

npm start

Note

You can run npm run bstart to build and start together

---

Games

• By default, games are reverse proxied by the server
  • Game assets are located here
• To turn off Games, and access to them see #environment

Docker

• There are two ways to deploy with docker:
  • Normal docker
  • Docker Compose

Normal Docker

Prerequisites:

• Git
• Docker

1. Clone the repo (skip if using prebuilt image):

git clone https://github.com/nebulaservices/nebula && cd nebula

2. Create an .env file (if using prebuilt image, copy the example from the repo):

cp .env.example .env

3. Modify the .env file to your liking (docs here)

nano .env

4. Build the docker image (skip if using prebuilt):

docker build --build-arg BARE_SERVER_OPTION=true GAMES_LINK=true RAMMERHEAD_OPTION=true -t incog:latest

For info on the build arg check here

5. Run the docker images:

   • Prebuilt:

   docker run --env-file ./.env motortruck1221/nebula:latest
   

   • Image you built yourself:

   docker run --env-file ./.env incog:latest
   

Docker Compose

Prerequisites:

• Git
• Docker w/compose

1. Clone the repo (skip if using prebuilt image):

git clone https://github.com/nebulaservices/nebula

2. Create an .env file (if using prebuilt image, copy the example from the repo):

cp .env.example .env

3. Modify the .env file to your liking (docs on that here]

nano .env

4. Build the docker image (skip if using prebuilt):

docker compose -f ./docker-compose.build.yml build

5. Run the docker image:

   • Prebuilt:

   docker compose up
   

   • Image you built yourself:

   docker compose -f ./docker-compose.build.yml up
   

---

Config

• There are a couple of configuration options for nebula. Most of the time, the defaults are fine, but there are instances where you may not want certain options enabled or certain things running.
• An example config file is located here. Config format is TOML

Variable	Description	Default