README.md

Get Started

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

NOTE:

• For Cyclic users this will unfortunatley not work due to Cyclic supporting very little languages
• 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

• Lots and lots of games

• Multiple Proxy "Backends":

  • Ultraviolet
  • RammerHead

---

Contributors

• MotorTruck1221 - Maintainer
• Rifting - Maintainer
• caracal-js - Original Creator

---

Tech Stack

• Astro
• Fastify
• Bare Server Node
• Ultraviolet
• RammerHead
• Epoxy
• HTML, CSS, and JavaScript (DUH)

---

Roadmap

• - i18n
• - More themes
• - Other transports

---

Deployment

Terminal

Prerequisites:

• Node & npm
• Git

1. Clone the repo:

git clone https://github.com/titaniumnetwork-dev/incognito && cd incognito

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/titaniumnetwork/incognito && cd incognito

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/incognito: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/titaniumnetwork-dev/incognito

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

---

Environment

• There are a couple of environment variables for incognito. Most of the time, the defaults are fine, but there are instances where you may not want certain options enabled or certain things running.

Variable	Description	Default
MASQR	Enables (true)/Disables (false) Masqr (most people don't want this)	false
BARE_SERVER_ENABLED	Enables (true)/Disables (false) the integrated bare server. Use this if you already have a server (e.g., reverse proxy) or don't want users accessing it.	true
PORT	The port that the server listens on IGNORED IN THE DOCKER ENVIRONMENTS	8080
GAMES	Disable (false)/Enable (true) the reverse proxy for Games	true
RAMMERHEAD_SERVER_ENABLED	Disable (false)/Enabled (true) the integrated Rammerhead server	true
SITE	Your websites domain (eg: https://example.com)	http://localhost:8080
BARE_SERVER_OPTION	Enables (true)/Disables (false) the option to use a bare server in the frontend. THIS IS A BUILD TIME ONLY VARIABLE	true
GAMES_LINK	Enables (true)/Disables (false) access to the games page BUILD TIME ONLY	true
RAMMERHEAD_OPTION	Enabled (true)/Disables (false) the option to use Rammerhead in the frontend. BUILD TIME ONLY	true