- 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
-
Lots and lots of games
-
Multiple Proxy "Backends":
- MotorTruck1221 - Maintainer
- Rifting - Maintainer
- caracal-js - Original Creator
- Astro
- Fastify
- Ultraviolet
- Epoxy
- Libcurl.js
- Hono as a Deno native alternative to fastify. Run with commadn:
deno task start:standalone
- Deno 2.0
- HTML, CSS, and JavaScript (DUH)
- - Implement Scramjet
- - Remove dependency on Fastify & switch completely to Hono
- - General codebase cleanup & remove all of the functions exisiting on
window
- - Games page needs to be reworked due to more games
- - i18n
- - More themes
- - Detatch from the Original repo
Prerequisites:
- Node & npm
- Deno 2.0
- Git
- Clone the repo:
git clone https://github.com/titaniumnetwork-dev/incognito && cd incognito
- Install all of the dependencies:
deno install --allow-scripts # This is here for sharp and other dependencies like bufferutil
- Create a config.toml file
cp config.example.toml config.toml
- Modify the config.toml file to you liking (docs here)
nano config.toml
- Build the frontend:
deno task build
- Start the server
deno task start
Note
You can run deno task start:standalone
to use Hono over Fastify, recommended if you're using an external Wisp server like Epoxy Server
You can run deno task bstart
to build and start the server at the same time
You can run deno task bstart:standalone
to do the same as above but use the Hono server instead
The Hono server has no built-in Wisp server so you'll have to provide one.
- By default, games are reverse proxied by the server
- Game assets are located here
- To turn off Games, and access to them see #config
- There are two ways to deploy with docker:
Prerequisites:
- Git
- Docker
- Clone the repo (skip if using prebuilt image):
git clone https://github.com/titaniumnetwork/incognito && cd incognito
- Create an config.toml file (if using prebuilt image, copy the example from the repo):
cp config.example.toml config.toml
- Modify the .env file to your liking (docs here)
nano config.toml
- Build the docker image (skip if using prebuilt):
docker build -t incog:latest
-
Run the docker images:
- Prebuilt:
docker run --volume ./config.toml:/app/config.toml motortruck1221/incognito:latest
- Image you built yourself:
docker run --volume ./config.toml:/app/config.toml incog:latest
Prerequisites:
- Git
- Docker w/compose
- Clone the repo (skip if using prebuilt image):
git clone https://github.com/titaniumnetwork-dev/incognito
- Create an config.toml file (if using prebuilt image, copy the example from the repo):
cp config.example.toml config.toml
- Modify the config.toml file to your liking (docs on that here]
nano config.toml
- Build the docker image (skip if using prebuilt):
docker compose -f ./docker-compose.build.yml build
-
Run the docker image:
- Prebuilt:
docker compose up
- Image you built yourself:
docker compose -f ./docker-compose.build.yml up
- The config is rather simple and quick, it's done in TOML and there are only two object:
buildOpts
&server
below there will be 2 tables showcasing the possible values.
Note
As it says, buildOpts
will only apply when building the website. This can be changed in the docker-compose files.
Type | Default | Description | Can be overwritten by ENV var |
---|---|---|---|
games | true |
Disables or enables the games page | - [ ] - No |
Type | Default | Description | Can be overwritten by ENV var |
---|---|---|---|
port | 8000 |
Change the default port. Note: the environment var PORT takes precedence |
- [x] - Yes |
wisp | true |
Disable or enables the in built wisp server. *Note: when using the Hono server there is no built-in wisp server | - [ ] - No |
Type | Default | Description | Can be overwritten by ENV var | Is used at build time |
---|---|---|---|---|
SEO | false |
Change whether or not to enabled SEO | - [x] - Yes - SEO |
- [x] - Yes |
DOMAIN | http://localhost:8000 |
When the both option is enable, only show the SEO stuff on this domain |
- [x] - Yes - DOMAIN |
- [ ] - No |
BOTH | false |
Works in tandem with option DOMAIN |
- [x] - Yes - BOTH |
- [ ] - No |