SDGDen/CloudDeploy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
SDGDen
2026-03-10 05:16:44 +01:00
parent 08d451fb3c
commit 306c8df92c
1 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -55,6 +55,7 @@ and for option 3, you'll have to port-forward port 53 (DNS), you can also do thi
to set up from scratch, we must begin with the hardware. to set up from scratch, we must begin with the hardware.
## hardware
to run this cloud, you need at least 4GB of RAM, though 8GB is the realistic minimum and 16GB is recommended for multiple users (more than 16GB is not needed), this *can* be older RAM (like DDR3) to run this cloud, you need at least 4GB of RAM, though 8GB is the realistic minimum and 16GB is recommended for multiple users (more than 16GB is not needed), this *can* be older RAM (like DDR3)
you will also need *any* 4 core, 8 thread CPU and the fastest networking your network supports (usually gigabit ethernet internally) you will also need *any* 4 core, 8 thread CPU and the fastest networking your network supports (usually gigabit ethernet internally)
you do not need a GPU unless you plan on adding more components yourself (for example an LLM) later. you do not need a GPU unless you plan on adding more components yourself (for example an LLM) later.
@@ -65,12 +66,15 @@ if you have a system with 16+ GB RAM, more than 4 cores with hyperthreading and
this does require better hardware, so it's not required. if you have an old Dell with 8GB RAM, 4 cores on a 4th gen i5 and a single 4TB harddrive, that'll work just fine, giving you and your family ~3.8TB of cloud storage. this does require better hardware, so it's not required. if you have an old Dell with 8GB RAM, 4 cores on a 4th gen i5 and a single 4TB harddrive, that'll work just fine, giving you and your family ~3.8TB of cloud storage.
## installing ubuntu
if you are installing ubuntu directly, download the ubuntu server LTS ISO file from the official website and use software like rufus or balena etcher to flash the ISO file to any 4GB+ USB stick. if you are installing ubuntu directly, download the ubuntu server LTS ISO file from the official website and use software like rufus or balena etcher to flash the ISO file to any 4GB+ USB stick.
insert the USB stick into the computer and boot from it. you may have to press a button on your keyboard to enter the boot menu and select the USB stick manually there. This button differs per vendor, so check the documentation for your computer's manufacturer or for your motherboard's manufacturer if it uses aftermarket parts. insert the USB stick into the computer and boot from it. you may have to press a button on your keyboard to enter the boot menu and select the USB stick manually there. This button differs per vendor, so check the documentation for your computer's manufacturer or for your motherboard's manufacturer if it uses aftermarket parts.
once you're booted into ubuntu server install, go through the steps. once you're booted into ubuntu server install, go through the steps.
## ubuntu network configuration
ensure that for the network configuration, you configure a static ip address. ensure that for the network configuration, you configure a static ip address.
for this, you'll want to get the network configuration for one of your existing devices first. the easiest is on windows: for this, you'll want to get the network configuration for one of your existing devices first. the easiest is on windows:
@@ -121,13 +125,13 @@ It is recommended to pick something high so it doesn't accidentally get reserved
i'd recommend just taking your gateway IP and replacing the last quarter with 250. i'd recommend just taking your gateway IP and replacing the last quarter with 250.
## ubuntu storage configuration
for the storage, it'll likely try to not use your whole drive, make sure to read through *the entire menu*, you only need to increase the amount of space used up by the LV to encompass the entire drive (i tend to just add a bunch of 1s at the start of the entry, which will then automatically set it to its cap) for the storage, it'll likely try to not use your whole drive, make sure to read through *the entire menu*, you only need to increase the amount of space used up by the LV to encompass the entire drive (i tend to just add a bunch of 1s at the start of the entry, which will then automatically set it to its cap)
continue through the menu until the software installs, then reboot and take out the flash drive. continue through the menu until the software installs, then reboot and take out the flash drive.
## router port-forwarding
you will also have to do some port-forwarding on your router. if you have an ISP-provided router, this should be either very straight-forward, or you'll have to ask your ISP for help. you will also have to do some port-forwarding on your router. if you have an ISP-provided router, this should be either very straight-forward, or you'll have to ask your ISP for help.
With aftermarket routers, follow a guide online. With aftermarket routers, follow a guide online.
@@ -143,7 +147,14 @@ port 53 is only needed if you want users outside of your network to have access
ports 80 and 443 only need to be forwarded if you want your websites to be available outside of your local network, if you only forward port 51820, you will still be able to access everything internally and you'll be able to access everything externally when you use a VPN. ports 80 and 443 only need to be forwarded if you want your websites to be available outside of your local network, if you only forward port 51820, you will still be able to access everything internally and you'll be able to access everything externally when you use a VPN.
## DNS records
if you are using a public DNS, you will need to add the following two records:
name | type | value
@ | A | <insert_your_public_ip_here>
* | CNAME | @
## Running the script
we can now start using CloudDeploy: we can now start using CloudDeploy:
if you get an error at the start, run the following: if you get an error at the start, run the following:
@@ -166,3 +177,12 @@ then follow the prompts on screen.
Once you are done, check the post-install.txt file that was placed in your home directory (if you were logged in as root, it may be under your root home. log in as the same user and run `cd ~` to go to your home folder) Once you are done, check the post-install.txt file that was placed in your home directory (if you were logged in as root, it may be under your root home. log in as the same user and run `cd ~` to go to your home folder)
when you finished the tasks in the post-install.txt file, your cloud should be fully up and running! be sure to restart it at least once. when you finished the tasks in the post-install.txt file, your cloud should be fully up and running! be sure to restart it at least once.
the whole install from scratch will take a bit, depending on your internet speed. However, I am confident that start-to-finish, this is a one-day project. You can start this on a saturday morning and have it done before it's time for dinner.
If you struggle with downloads timing out during the script, you can run the pre-download.sh script, which pre-downloads all the containers. to do this:
`sudo chmod a+x ./pre-download.sh`
`sudo ./pre-download.sh`