Ripple Auto Installer

Ripple Stack Installation Helper

ATTENTION

FOR ADVANCED USERS!
This project gives you a base and foundation if you're willing to setup your own Ripple instance. You’re to think for yourself. Ripple is not a stack system where Ripple/I document everything so you’ll need a basic understanding of how full stack web applications and unix or GNU/Linux systems work to be able to set up Ripple properly and work out with problems efficiently when necessary.

• Check out Light-Ripple-Windows if you want to host a local Ripple instance on your windows system.
• You might want to look at Ripple's wiki(old): https://github.com/osuripple/ripple/wiki/How-to-setup-ripple
• Ripple Too Hard? aka you're incompetent then Try Gulag (dev-friendly osu! server): https://github.com/cmyui/gulag
• Note: The Script has not been fully tested (100%) properly. Bugs may be expected, Report it Contact.

REQUIREMENTS

• Knowledge on Computers, Softwares, *nix or GNU/Linux, Servers, Game Hosting, Database, Computer Networks, Computer Security, Virtual Private Server, Web hosting, Software Programming & Full stack web development. All of them are not 100% required but essential.
• Virtual Private Server.
• Arch/Debian/Gentoo/Exherbo GNU/Linux Based Distro with APT, Pacman, Portage or Paludis package manager.
• systemd or OpenRC.

SUPPORTED SYSTEMS

• Operating System: Arch Linux, Debian, Gentoo Linux & Exherbo Linux.
• Package Manager: APT, Pacman, Portage & Paludis package manager.
• Init System: systemd & OpenRC.

FEATURES

• A configurable shell script for installing Ripple Stack
• Everything is Pre-ready
• Simple and user friendly installation
• Integrated Error-logging system
• Ability to Install specific stack software(s) chosen by a user
• Higly Productive & Customizable
• OS and Package manager detection
• Posix compatible
• Configuration File

Pre-Configuration

DOMAIN

Make sure you set your DNS like this:

* YOUR-DOMAIN
* c.YOUR-DOMAIN
* i.YOUR-DOMAIN
* a.YOUR-DOMAIN
* s.YOUR-DOMAIN
* old.YOUR-DOMAIN

VPS

Make sure you've configured your inbound-rules properly.

CLOUDFLARE

Make sure you've configured cloudflare properly.

RUNNING THE SCRIPT

With Git

# Clone and cd into the Repository
git clone https://github.com/Uniminin/Ripple-Auto-Installer ; \
cd Ripple-Auto-Installer/Main

# Make the script readable, writable, and executable to root and your user
chmod 770 ripple.sh

# Edit the ripple.sh or config.sh file located in `./Main/` if necessary (optional)

# Finally read the output of
./ripple.sh --help

With wget (Recommended)

# Download the latest script
wget -O "ripple.sh" https://raw.githubusercontent.com/Uniminin/Ripple-Auto-Installer/master/Main/ripple.sh

# Make the script readable, writable, and executable to root and your user
chmod 770 ripple.sh

# Edit the ripple.sh or config.sh file located in `./Main/` directory if necessary (optional)

# Finally read the output of
./ripple.sh --help

Bedrock How To:

$ strat -r stratum ./ripple.sh -h  # stratum --> stratum name

Note: Execute the script as superuser. For example: sudo/X/doas -- ./ripple.sh ....

Configuring/Starting/connecting (The Server)

• For manual configuration, see all markdowns in Miscellaneous.
• To start the server: start.md.
• To connect to the server (with osu client): connect.md.

FILE STRUCTURE

.
├── Database files
│  └── ripple.sql
├── LICENSE
├── Main
│  ├── config.sh
│  ├── gencert.sh
│  ├── openssl.cnf
│  ├── ripple.conf
│  ├── ripple.sh
│  └── tmux.sh
├── Miscellaneous
│  ├── certificate.md
│  ├── cloudflare.png
│  ├── configs.md
│  ├── connect.md
│  ├── inbound-rules.png
│  ├── old_ripple.svg
│  ├── ripple.svg
│  └── start.md
├── Nginx
│  ├── N1.conf
│  ├── N2.conf
│  └── old-frontend.conf
└── README.md

CREDITS

• Aoba-Suzukaze and osuthailand for their help, stack softwares, certificate & Database schema.
• semyon422 for their open-ripple.
• EmilySunpy for their lets & secret.
• And others who supported and contributed to the project.

LICENSE

All of the Ripple code including the project itself is licenced under the GNU Affero General Public License V3. For more information, see the LICENSE file or visit https://www.gnu.org/licenses/agpl-3.0.