Update some stuff, add advanced deployment tutorial
This commit is contained in:
Green!
GitHub
parent
f897346724
commit
95629f4546
1 changed files with 73 additions and 21 deletions
94
README.md
94
README.md
|
|
@ -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
|
||||
|
|
@ -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
|
||||
[](https://heroku.com/deploy/?template=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://replit.com/github/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://glitch.com/edit/#!/import/github/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://cloud.ibm.com/devops/setup/deploy?repository=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://deploy.cloud.run/?git_repo=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://railway.app/new/template/pBzeiN)
|
||||
<br>
|
||||
[](https://app.koyeb.com/deploy?type=git&repository=github.com/NebulaServices/Nebula&branch=main&name=NebulaProxy)
|
||||
|
||||
|
||||
### Self Hosting
|
||||
```bash
|
||||
|
|
@ -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
|
||||
[](https://heroku.com/deploy/?template=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://replit.com/github/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://glitch.com/edit/#!/import/github/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://cloud.ibm.com/devops/setup/deploy?repository=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://deploy.cloud.run/?git_repo=https://github.com/NebulaServices/Nebula)
|
||||
<br>
|
||||
[](https://railway.app/new/template/pBzeiN)
|
||||
<br>
|
||||
[](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
|
||||
|
||||
|
|
@ -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>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue