forked from UseInterstellar/Interstellar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
13e7e8c
commit 6a0c57d
Showing
1 changed file
with
24 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,140 +1,40 @@ | ||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/UseInterstellar/Interstellar/main/.github/branding/in.png"> | ||
| <p>Serving over 8+ million users since 2023.<p> | ||
| <p>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.</p> | ||
| </div> | ||
| <h1 align="center">Welcome to Interstellar 👋</h1> | ||
| <p> | ||
| <img alt="Version" src="https://img.shields.io/badge/version-.1-blue.svg?cacheSeconds=2592000" /> | ||
| <a href="https://github.com/ewarggg776/Interstellar/blob/main/README.md" target="_blank"> | ||
| <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" /> | ||
| </a> | ||
| <a href="fsf.org" target="_blank"> | ||
| <img alt="License: GNU AFFERO GENERAL PUBLIC LICENSE" src="https://img.shields.io/badge/License- GNU AFFERO GENERAL PUBLIC LICENSE-yellow.svg" /> | ||
| </a> | ||
| </p> | ||
|
|
||
|  | ||
| > A version of Interstellar with simple instructions for codespaces. | ||
| > [!IMPORTANT] | ||
| > If you fork this project, consider giving it a star in the original repository! | ||
| ### 🏠 [Homepage](https://github.com/ewarggg776/Interstellar) | ||
|
|
||
| **Join Our [Discord Community](https://discord.gg/interstellar) for support, more links, and an active community!** | ||
| ## Install | ||
|
|
||
| ## 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: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/UseInterstellar/Interstellar | ||
| cd Interstellar | ||
| ``` | ||
|
|
||
| #### Ad-Free Deployment | ||
|
|
||
| ```bash | ||
| 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: | ||
|
|
||
| ```bash | ||
| bun i | ||
| bun start | ||
| ``` | ||
|
|
||
| #### pnpm | ||
|
|
||
| If you are using pnpm, run the following commands: | ||
|
|
||
| ```bash | ||
| ```sh | ||
| pnpm i | ||
| pnpm start | ||
| ``` | ||
|
|
||
| #### npm | ||
| ## Usage | ||
|
|
||
| If you are using npm, run the following commands: | ||
|
|
||
| ```bash | ||
| npm i | ||
| npm run start | ||
| ```sh | ||
| 1. pnpm start. 2. make port 8080 public. 3. localhost:8080 | ||
| ``` | ||
|
|
||
| ### Updating | ||
|
|
||
| ```bash | ||
| cd Interstellar | ||
| git pull --force --allow-unrelated-histories # This may overwrite your local changes | ||
| ``` | ||
|
|
||
| <a target="_blank" href="https://heroku.com/deploy/?template=https://github.com/UseInterstellar/Interstellar"><img alt="Deploy to Heroku" src="https://binbashbanana.github.io/deploy-buttons/buttons/remade/heroku.svg"></a> | ||
| <a target="_blank" href="https://app.koyeb.com/deploy?type=git&repository=github.com/UseInterstellar/Interstellar"><img alt="Deploy to Koyeb" src="https://binbashbanana.github.io/deploy-buttons/buttons/remade/koyeb.svg"></a> | ||
|
|
||
| ### Deployment Alternatives | ||
|
|
||
| For more deployment options, join our [Discord Server](https://discord.gg/interstellar) 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](https://blog.replit.com/hosting-changes). 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. | ||
| 5. Access the deployed website from the ports tab. | ||
| 6. 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. | ||
| ## Author | ||
|
|
||
| ## Report Issues | ||
| * Github: [@ewarggg776](https://github.com/ewarggg776) | ||
|
|
||
| If you encounter problems, open an issue on GitHub, and we'll address it promptly. | ||
| ## Show your support | ||
|
|
||
| > [!TIP] | ||
| > If you're having trouble, don't hesitate to reach out to us on [Discord](https://discord.gg/interstellar) for personalized support. | ||
| Give a ⭐️ if this project helped you! | ||
|
|
||
| # Credits | ||
| ## 📝 License | ||
|
|
||
| A huge thanks goes out to all of the people who have contributed to Interstellar. | ||
| This project is [ GNU AFFERO GENERAL PUBLIC LICENSE](fsf.org) licensed. | ||
|
|
||
| [](https://github.com/UseInterstellar/Interstellar/graphs/contributors) | ||
| *** |