Skip to content

Latest commit

 

History

History
140 lines (96 loc) · 4.72 KB

README.md

File metadata and controls

140 lines (96 loc) · 4.72 KB
Raw

Serving over 8+ million users since 2023.

Interstellar is a web proxy with a Clean and Sleek UI and easy to use menus. Our goal is to provide the best user experience to everyone.

inpreview

Important

If you fork this project, consider giving it a star in the original repository!

Join Our Discord Community for support, more links, and an active community!

Features

  • About:Blank Cloaking
  • Tab Cloaking
  • Wide collection of apps & games
  • Clean, Easy to use UI
  • Inspect Element
  • Various Themes
  • Password Protection (Optional)
  • Built-in Tab System
  • Now.gg Support
  • Fast Speeds
  • Geforce NOW Support

Deployment

Important

You cannot deploy to static web hosts, including Netlify, Cloudflare Pages, and GitHub Pages.

Password Protection

  1. Go to the config.js file and set challenge to true. Then, set the environment variable as follows:
  2. For PNPM: Run either config=true pnpm start or $env:config=true; pnpm start, depending on your server.
  3. For Bun: Run either config=true bun start or $env:config=true; bun start if you prefer Bun.
  4. For NPM: Run either config=true npm start or $env:config=true; npm start if you prefer NPM.

Server Deployment

You must run these commands on your server:

git clone https://github.com/UseInterstellar/Interstellar
cd Interstellar

Ad-Free Deployment

git clone --branch Ad-Free https://github.com/UseInterstellar/Interstellar
cd Interstellar

Next depending on your package manager, run one of the following commands:

Bun

If you are using Bun, run the following commands:

bun i
bun start

pnpm

If you are using pnpm, run the following commands:

pnpm i
pnpm start

npm

If you are using npm, run the following commands:

npm i
npm run start

Updating

cd Interstellar
git pull --force --allow-unrelated-histories # This may overwrite your local changes

Deploy to Heroku Deploy to Koyeb

Deployment Alternatives

For more deployment options, join our Discord Server for various ways to deploy Interstellar. This includes methods of deploying to Render/OnRender.

What happened to Replit Deployment?

As of January 1st, 2024, Replit is no longer free. Try GitHub Codespaces instead.

GitHub Codespaces

Note

If you're setting the port below 1023, then you must run sudo PORT=1023

  1. Create a GitHub account if you haven't already.
  2. Click "Code" (green button) and then "Create Codespace on main."
  3. In the terminal at the bottom, paste pnpm i && pnpm start.
  4. Respond to the application popup by clicking "Make public."

Important

Make sure you click the "Make public." button, or the proxy won't function properly.

  1. Access the deployed website from the ports tab.
  2. For subsequent uses in the same codespace, just run pnpm start

Solution for if there is no popup.

  1. Run pnpm i, and before pnpm start, prepend PORT=8080, replacing 8080 with another port. For example, PORT=6969 pnpm start.
  2. If this does not work then you can prepend $env:PORT=8080;, replacing 8080 with another port. For example, $env:PORT=6969; pnpm start
  3. Go to the ports tab, Click Forward A Port, And type the port number.
  4. Right-click Visibility and set Port Visibility to Public.

Note

We are committed to making Interstellar easy and personalized however, as of now we need your support in making it ad-free. Consider keeping ads so Interstellar can run freely or contribute by being a supporter.

Report Issues

If you encounter problems, open an issue on GitHub, and we'll address it promptly.

Tip

If you're having trouble, don't hesitate to reach out to us on Discord for personalized support.

Credits

A huge thanks goes out to all of the people who have contributed to Interstellar.

Contributors