mirror of
https://github.com/NebulaServices/Nebula.git
synced 2025-05-12 19:40:02 -04:00
a stunning and sleek web proxy with support for hundreds of popular sites.
https://docs.nebulaproxy.io/
.vscode | ||
database_assets | ||
public | ||
src | ||
upload | ||
.gitignore | ||
asgard.png | ||
astro.config.mjs | ||
biome.json | ||
config.json | ||
database_back.sqlite | ||
package-lock.json | ||
package.json | ||
pnpm-lock.yaml | ||
README.md | ||
server.js | ||
svelte.config.js | ||
tailwind.config.mjs | ||
test_upload.js | ||
tsconfig.json |
NOTE:
- 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
- Multiple Proxy "Backends":
Contributors
- Rifting - Owner & Maintainer
- MotorTruck1221 - Maintainer
Tech Stack
- Astro
- Fastify
- Ultraviolet
- RammerHead
- Epoxy
- Libcurl.js
- HTML, CSS, and JavaScript (DUH)
Deployment
Terminal
Prerequisites:
- Node & npm
- Git
- Clone the repo:
git clone https://github.com/nebulaservices/nebula && cd nebula
- Install all of the dependencies:
npm i
- Create a .env file
cp .env.example .env
- Modify the .env file to you liking (docs here)
nano .env
- Build the frontend:
npm run build
- 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
Prerequisites:
- Git
- Docker
- Clone the repo (skip if using prebuilt image):
git clone https://github.com/nebulaservices/nebula && cd nebula
- Create an .env file (if using prebuilt image, copy the example from the repo):
cp .env.example .env
- Modify the .env file to your liking (docs here)
nano .env
- 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
-
Run the docker images:
- Prebuilt:
docker run --env-file ./.env motortruck1221/nebula:latest
- Image you built yourself:
docker run --env-file ./.env incog:latest
Docker Compose
Prerequisites:
- Git
- Docker w/compose
- Clone the repo (skip if using prebuilt image):
git clone https://github.com/nebulaservices/nebula
- Create an .env file (if using prebuilt image, copy the example from the repo):
cp .env.example .env
- Modify the .env file to your liking (docs on that here]
nano .env
- 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
Environment
- There are a couple of environment variables for nebula. 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 |
---|---|---|