Add a decent README (not totally correct currently)

2024-10-08 01:08:08 -06:00 · 2024-10-08 01:08:08 -06:00 · e571cc301c
commit e571cc301c
parent ce5c4e5345
1 changed files with 199 additions and 42 deletions
--- a/README.md
+++ b/README.md
@ -1,54 +1,211 @@
-# Astro Starter Kit: Basics
+<div align="center">
+         
+<img src="https://socialify.git.ci/nebulaservices/nebula/image?description=1&font=Inter&forks=1&issues=1&language=1&name=1&owner=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Dark" alt="ruby" width="640" height="320" />

-```sh
-npm create astro@latest -- --template basics
+<img alt="repo size" src="https://img.shields.io/github/repo-size/nebulaservices/nebula?style=for-the-badge"></img>
+<img alt="website status" src="https://img.shields.io/website?url=https%3A%2F%2Fincog.nebula.christmas&style=for-the-badge"></img>
+<img alt="commit a week" src="https://img.shields.io/github/commit-activity/w/nebulaservices/nebula?style=for-the-badge"></img>
+<a href="https://github.com/caracal-js/incognito" target="_blank" rel="noopener noreferer"><img alt="original repo" src="https://img.shields.io/badge/Original-Repo-gray?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Fcaracal-js%2Fincognito"></img></a>
+
+</div>
+
+<div align="center">
+    <h2>Get Started</h2>
+    <a>To get started, press one of the buttons below to deploy Incog</a>
+    <br />
+    <br />
+    <a href="#terminal">
+        <img src="https://img.shields.io/badge/terminal-%23121011.svg?style=for-the-badge&logo=gnu-bash&logoColor=white" alt="Terminal">
+        </img>
+    </a>
+    <a href="#docker">
+        <img src="https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white" alt="Docker">
+        </img>
+    </a>
+</div>
+
+## 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
+
+[![Titanium Network Discord](https://invidget.switchblade.xyz/unblock?theme=dark)](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
 ```

-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
-
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
-
-![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
-
-## 🚀 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 |
+|------------------------|----------------------------------------------------------------------------------------------------------|---------|
+| | | |