Incognito
Access the world wide web! Incognito is a dynamic web proxy service stylized as a search engine.
Setup
Deployment
To get started, press one of the buttons below to deploy Incognito
Terminal
Prerequisites:
- Node & npm
- Deno 2
- Git
- Clone the repo:
git clone https://github.com/titaniumnetwork-dev/incognito && cd incognito
- Install all of the dependencies:
deno install --allow-scripts
- Create a .env 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
Docker
- There are two ways to deploy with docker:
Normal 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 config.toml file to your liking (docs here)
nano config.toml
- Build the docker image (skip if using prebuilt):
docker build -t incog:latest
For info on the build arg check here
-
Run the docker images:
- Prebuilt:
Terminal window docker run --volume ./config.toml:/app/config.toml motortruck1221/incognito:latest- Image you built yourself:
Terminal window docker run --volume ./config.toml:/app/config.toml incog:latest
Docker Compose
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:
Terminal window docker compose up- Image you built yourself:
Terminal window docker compose -f ./docker-compose.build.yml up
Games
- By default, games are reverse proxied by the server
- Game assets are located here
- To turn off Games, and access to them see #config
Config
- The config is rather simple and quick, it’s done in TOML and there are only two objects:
buildOpts
&server
. - Below, there will be 2 tables showcasing the possible values.
Build Opts
Variable | Description | Default |
---|---|---|
games | Enables (true )/Disables (false ) the games page | true |
Server
Variable | Description | Default |
---|---|---|
port | Change the default port. Note: the environment var PORT takes precedence | 8000 |
wisp | Disable or enables the in built wisp server. (Note: when using the Hono server there is no built-in wisp server) | true |