Skip to content

Commit

Permalink
Merge pull request #27 from GreenyDEV/main
Browse files Browse the repository at this point in the history 
fix minor vocabulary and change cyclone to legacy, docs update
  • Loading branch information
@GreenyDEV
GreenyDEV committed Oct 10, 2022
2 parents 2cab377 + 95629f4 commit 3229601
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 58 deletions.
94 changes: 73 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<div align=center>

<div align=center>
<img src='https://nebulaproxy.nebula.bio/images/logo.png' width="100px" height="100px">
<h1> Nebula </h1>
Nebula Web is an official flagship of Nebula Services. Nebula Web is a stunning and sleak webproxy with support for hundreds of popular sites, and partial support for WebRTC, used in GfN. With Nebula Web, the sky is the limit. Enjoy.
</div>


_this readme is 95% done_
## Features

- Stunning UI with multiple themes
Expand All @@ -14,24 +15,7 @@ _this readme is 95% done_
- *limited* mobile support
- StealthMode (buffed `about:blank` cloaking)

## Deployment
(Nebula's license is now GNU AGPL V3 as of v7.10)
### Quick Deployment
[![Deploy to Heroku](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/heroku.svg)](https://heroku.com/deploy/?template=https://github.com/NebulaServices/Nebula)
<br>
[![Run on Replit](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/replit.svg)](https://replit.com/github/NebulaServices/Nebula)
<br>
[![Remix on Glitch](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/glitch.svg)](https://glitch.com/edit/#!/import/github/NebulaServices/Nebula)
<br>
[![Deploy to IBM Cloud](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/ibmcloud.svg)](https://cloud.ibm.com/devops/setup/deploy?repository=https://github.com/NebulaServices/Nebula)
<br>
[![Deploy to Amplify Console](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/amplifyconsole.svg)](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/NebulaServices/Nebula)
<br>
[![Run on Google Cloud](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/googlecloud.svg)](https://deploy.cloud.run/?git_repo=https://github.com/NebulaServices/Nebula)
<br>
[![Deploy on Railway](https://binbashbanana.github.io/deploy-buttons/buttons/remade/railway.svg)](https://railway.app/new/template/pBzeiN)
<br>
[![Deploy To Koyeb](https://binbashbanana.github.io/deploy-buttons/buttons/remade/koyeb.svg)](https://app.koyeb.com/deploy?type=git&repository=github.com/NebulaServices/Nebula&branch=main&name=NebulaProxy)


### Self Hosting
```bash
Expand Down Expand Up @@ -60,6 +44,74 @@ For support, email chloe@nebula.bio or join our discord: discord.nebula.bio

[Click here to see a demo of Nebula](https://tutorialread.beauty/)

# Deployment

## Quick Deployment Options
[![Deploy to Heroku](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/heroku.svg)](https://heroku.com/deploy/?template=https://github.com/NebulaServices/Nebula)
<br>
[![Run on Replit](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/replit.svg)](https://replit.com/github/NebulaServices/Nebula)
<br>
[![Remix on Glitch](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/glitch.svg)](https://glitch.com/edit/#!/import/github/NebulaServices/Nebula)
<br>
[![Deploy to IBM Cloud](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/ibmcloud.svg)](https://cloud.ibm.com/devops/setup/deploy?repository=https://github.com/NebulaServices/Nebula)
<br>
[![Deploy to Amplify Console](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/amplifyconsole.svg)](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/NebulaServices/Nebula)
<br>
[![Run on Google Cloud](https://raw.githubusercontent.com/BinBashBanana/deploy-buttons/master/buttons/remade/googlecloud.svg)](https://deploy.cloud.run/?git_repo=https://github.com/NebulaServices/Nebula)
<br>
[![Deploy on Railway](https://binbashbanana.github.io/deploy-buttons/buttons/remade/railway.svg)](https://railway.app/new/template/pBzeiN)
<br>
[![Deploy To Koyeb](https://binbashbanana.github.io/deploy-buttons/buttons/remade/koyeb.svg)](https://app.koyeb.com/deploy?type=git&repository=github.com/NebulaServices/Nebula&branch=main&name=NebulaProxy)

---
## Advanced Deployment

### Initial configuration

credits to @ProgrammerIn-wonderland for writing this wonderful tutorial (which can also be found in the docs :)

* Create an account at https://www.cloudflare.com/
* Create an account at https://www.freenom.com/ (or any registrars)
* Find a free domain name at Freenom
* Click checkout
* Select (12 Months @ FREE)
* Select "Use DNS"
* Select Use your own DNS
* Go to cloudflare, click add new site, and enter the free domain name
* Select "Free Plan"
* Click continue, ignore DNS
* Copy the name servers cloudflare gives you
* Go back to your Freenom tab, enter in the name servers which cloudflare gave you
* You can keep IP blank
* Click continue
* Click complete order
* Go back to cloudflare tab, click "Check Nameservers"
* Select DNS on your right bar
* Enter in the IP of the server which will be hosting Nebula
* Target will be `@`
* Click Enable proxy (little gray cloud icon, if active its orange)
* Select SSL/TLS in your right bar
* Click "Flexible"

---

### Server configuration

* SSH into the server you'll be using, I'll assume its running Ubuntu 22.04 (though the commands are the same for debian 10+ versions, and Ubuntu versions 20.04+)
* run
```
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - \ &&
sudo apt-get install -y nodejs npm
git clone https://github.com/NebulaServices/Nebula.git
cd Nebula
npm i
npm ci
sudo nohup PORT=80 node . &
```

**Make sure your firewall is configured to let through port 80 traffic!** \
*Note: Server will need to run` cd Nebula && sudo nohup PORT=80 node . &` on reboot*
(Nebula's license is now GNU AGPL V3 as of v7.10)

## Acknowledgements

Expand All @@ -74,4 +126,4 @@ For support, email chloe@nebula.bio or join our discord: discord.nebula.bio
Copyright Nebula Services 2021 - Present
<br>
This project uses the MIT license.
<div align=center>

34 changes: 2 additions & 32 deletions docs/guides/PATREON.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,3 @@
## huh..

# How to access Patreon links!
Welcome to this amazing guide :)

## Step 1
**Become a patron...**

*To follow this tutorial, you must be a patron, duh.*


## Step 2
Find a supporter link in Patreon. Posts with links will have the `New links` tag, so just search for that.
Some links are experimental and may not work as intended, but we will always tell you if it's experimental.
## Step 3

Use the password from the Patreon post *Same post you got the link from, duh*
## Step 4

Enter the password and Start using Nebula
## Troubleshooting

If the password is incorrect:
- Make sure you entered the correct password
- Check the latest Patreon post to see if it changed *-- Only happens in emergencies, like password leaking*
- If none of those work, then and only then contact chloe@nebula.bio or GreenWorld#0001 on discord.
## Authors

- [@green](https://www.git.holy.how/green)


## Appendix

This guide is 96% complete. If you are having any trouble accessing or using Patreon/supporter only links, contact chloe@nebula.bio or GreenWorld#0001 on Discord.
We no longer have a patreon, weird...
10 changes: 5 additions & 5 deletions static/options/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h1 class="nebHeader" style='margin-left: .5%; font-family: "Roboto"; color: #4d


<div class="settings-cont">
<p class="name"> Stealth Mode</p>
<p class="name">Stealth Mode</p>
<p class="description">Stops extensions from peeping</p>

<input id="undefined" type="checkbox" onclick="saveIc();toggleNoGG()">
Expand All @@ -114,13 +114,13 @@ <h1 class="nebHeader" style='margin-left: .5%; font-family: "Roboto"; color: #4d
<span class="custom-dropdown big">
<a onclick="unsavedChanges();"> <select class="dropdown" id="proxySwitcher">
<option value="uv">UltraViolet</option>
<option value="cyclone">Cyclone (BETA)</option>
<option value="osana">Osana (BETA)</option>deez
<option value="osana">Osana (beta)</option>
<option value="cyclone">Cyclone (Legacy)</option>
</select>
</a>

</span>
<a onclick="saveIc();switchProxy()" class="button-save"> Save! </a>
<a onclick="saveIc();switchProxy()" class="button-save"> Apply </a>



Expand All @@ -139,7 +139,7 @@ <h1 class="nebHeader" style='margin-left: .5%; font-family: "Roboto"; color: #4d
</a>

</span>
<a onclick="saveIc();switchTheme();" class="button-save"> Save! </a>
<a onclick="saveIc();switchTheme();" class="button-save"> Apply </a>


</div>
Expand Down

0 comments on commit 3229601

Please sign in to comment.