+
+## 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
+
+[](https://discord.gg/unblock)
+
+---
+
+## Features
+
+- Lots and lots of games
+
+- Multiple Proxy "Backends":
+ - [Ultraviolet](https://github.com/titaniumnetwork-dev/ultraviolet)
+ - [RammerHead](https://github.com/binary-person/rammerhead)
+---
+
+## Contributors
+
+- [MotorTruck1221](https://motortruck1221.com) - Maintainer
+- [Rifting](https://github.com/rifting) - Maintainer
+- [caracal-js](https://github.com/caracal-js) - Original Creator
+---
+
+## Tech Stack
+
+- [Astro](https://astro.build)
+- [Fastify](https://fastify.dev)
+- [Bare Server Node](https://github.com/tomphttp/bare-server-node)
+- [Ultraviolet](https://github.com/titaniumnetwork-dev/ultraviolet)
+- [RammerHead](https://github.com/binary-person/rammerhead)
+- [Epoxy](https://github.com/mercuryworkshop/epoxy-tls)
+- HTML, CSS, and JavaScript (DUH)
+---
+
+## Roadmap
+
+- [ ] - [i18n](https://github.com/alexandre-fernandez/astro-i18n)
+- [ ] - More themes
+- [ ] - Other transports
+---
+
+## Deployment
+
+### Terminal
+
+Prerequisites:
+- Node & npm
+- Git
+
+1. Clone the repo:
+```bash
+git clone https://github.com/nebulaservices/nebula && cd incognito
```
-[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
-[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
-[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
-
-> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
-
-
-
-## 🚀 Project Structure
-
-Inside of your Astro project, you'll see the following folders and files:
-
-```text
-/
-├── public/
-│ └── favicon.svg
-├── src/
-│ ├── components/
-│ │ └── Card.astro
-│ ├── layouts/
-│ │ └── Layout.astro
-│ └── pages/
-│ └── index.astro
-└── package.json
+2. Install all of the dependencies:
+```bash
+npm i
```
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+3. Create a .env file
+```bash
+cp .env.example .env
+```
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+4. Modify the .env file to you liking (docs [here](#environment))
+```
+nano .env
+```
-Any static assets, like images, can be placed in the `public/` directory.
+5. Build the frontend:
+```bash
+npm run build
+```
-## 🧞 Commands
+6. Start the server
+```bash
+npm start
+```
-All commands are run from the root of the project, from a terminal:
+> [!NOTE]
+> You can run `npm run bstart` to build and start together
+---
-| Command | Action |
-| :------------------------ | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:4321` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI |
+### Games
-## 👀 Want to learn more?
+- By default, games are reverse proxied by the server
+ - Game assets are located [here](https://github.com/ruby-network/ruby-assets)
+- To turn off Games, and access to them see [#environment](#environment)
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+
+### Docker
+
+- There are two ways to deploy with docker:
+ - [Normal docker](#normal-docker)
+ - [Docker Compose](#docker-compose)
+
+#### Normal Docker
+
+Prerequisites:
+- Git
+- Docker
+
+1. Clone the repo (skip if using prebuilt image):
+```bash
+git clone https://github.com/titaniumnetwork/incognito && cd incognito
+```
+
+2. Create an .env file (if using prebuilt image, copy the example from the repo):
+```bash
+cp .env.example .env
+```
+
+3. Modify the .env file to your liking (docs [here](#environment))
+```bash
+nano .env
+```
+
+4. Build the docker image (skip if using prebuilt):
+```bash
+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](#environment)
+
+5. Run the docker images:
+
+ - Prebuilt:
+ ```bash
+ docker run --env-file ./.env motortruck1221/incognito:latest
+ ```
+ - Image you built yourself:
+ ```bash
+ docker run --env-file ./.env incog:latest
+ ```
+
+#### Docker Compose
+
+Prerequisites:
+- Git
+- Docker w/compose
+
+1. Clone the repo (skip if using prebuilt image):
+```bash
+git clone https://github.com/nebulaservices/nebula
+```
+
+2. Create an .env file (if using prebuilt image, copy the example from the repo):
+```bash
+cp .env.example .env
+```
+
+3. Modify the .env file to your liking (docs on that [here](#environment)]
+```bash
+nano .env
+```
+
+4. Build the docker image (skip if using prebuilt):
+```bash
+docker compose -f ./docker-compose.build.yml build
+```
+
+5. Run the docker image:
+
+ - Prebuilt:
+ ```bash
+ docker compose up
+ ```
+ - Image you built yourself:
+ ```bash
+ 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 |
+|------------------------|----------------------------------------------------------------------------------------------------------|---------|
+| | | |
+
+
+
+
+
+
+
+
+ 
+
+
+