All in one installer for your yiimp server.
**Dirty Harry YiiMP Server Installer! ** Automates most of the tedious tasks of the following releases:
- YiiMP
Installation:
Requires a fresh Ubuntu 16.04 or Ubuntu 18.04 installation.
curl https://raw.githubusercontent.com/angelolisa26/Yiimp-Server-Installer/master/bootstrap.sh | bash
You may run the installer under root or an existing account. If you already have a user account created on your server that account must already be part of the sudo group.
If you are running as root the installer will prompt you to create a new account.
After creating the new user account or updating your existing account, you MUST reboot the machine in order for the accounts permissions to be updated properly.
After rebooting the server to your user to start the installer type:
yiimpserver
The Yiimp Single Server Install is recommend for private or very small pools. It is recommended to have at least 4GB ram in order to function properly. Setup is automated after the following questions are answered:
| Question | Default | Help |
|---|---|---|
| Are you using a domain name | no | If you plan to use something like example.com, make sure DNS is updated |
| Are you using a sub-domain as the main domain | no | If you plan to use something like pool.example.com |
| Domain Name | localhost | Change to your domain either example.com or pool.example.com |
| Stratum Domain | stratum.domain.name | This should be something other then your domain name |
| Install SSL | yes | Installs a 90 day cert from LetsEncrypt |
| Support Email | root@localhost | Used to send you system alerts |
| Your Public IP | pulls ip last used to acess web server | To verify go to http://www.whatsmyip.org |
| DB Root Password | autogenerated 36 character password | Default mysql root password |
| DB Panel User Password | autogenerated 36 character password | Default mysql frontend password |
| DB Stratum Password | autogenerated 36 character password | Default mysql stratum password |
| Admin Portal Access Location | AdminPortal | to access example.com/site/AdminPortal |
Installation will take about 25 minutes to fully complete. You will get a message on the screen letting you know it has finished.
On first reboot it may take up to 10 minutes before the cron screens auto-start. After waiting ten minutes type:
motd
To help make your server more secure we have changed the install locations and directory structure of YiiMP as follows:
| Directory | Files |
|---|---|
| /home/yiimp-data/yiimp | General install location for YiiMP |
| /home/yiimp-data/yiimp/starts | screens and stratum sh files - you do not need to run these |
| /home/yiimp-data/yiimp/site | - |
| /home/yiimp-data/yiimp/site/web | New location for YiiMP web files |
| /home/yiimp-data/yiimp/site/backup | backup location for mysql DB |
| /home/yiimp-data/yiimp/site/configuration | New location of your serverconfig.php |
| /home/yiimp-data/yiimp/site/crons | New location of the main:blocks:loop2 sh files |
| /home/yiimp-data/yiimp/site/log | New location for debug.log and your nginx server log |
| /home/yiimp-data/yiimp/site/stratum | New location for your stratum files |
| /home/yiimp-data/wallets | New location for wallets |
Permissions have been setup correctly allowing your main user write acess to the /home/yiimp-data directories! Changing file or directory permissions after install will cause your YiiMP to not function correctly, you have been warned!!
By default even though all stratum algos start on server start, the ports have been blocked by the firewall. To open a port type:
sudo ufw allow port number
From there your YiiMP Single Server installation is fully completed. You can now go to example.com/site/AdminPortal to access your admin section and start adding your coins.
To view a screen type:
screen -r main|loop2|blocks|debug
To detach from a screen type:
ctrl+a+d
To start, stop or restart main|loop2|blocks|debug type:
screens start|stop|restart main|loop2|blocks|debug
We also suggest that you type:
yiimp
and get to know those commands as well!
The YiiMP Multi-Server Install is recommended for those that want to run larger public pools. This offers the most security and is a lot more complex on the setup.
The following two tables show you the perfered server setup for the multi-server setup:
| Role | OS Version | Recommended Ram |
|---|---|---|
| Web Server | Ubuntu 16.04 or Ubuntu 18.04 | 2GB |
| DB & Stratum Server | Ubuntu 16.04 or Ubuntu 18.04 | 16GB |
| Daemon Server | Ubuntu 16.04 or Ubuntu 18.04 | 8GB+ |
or
| Role | OS Version | Recommended Ram |
|---|---|---|
| Web Server | Ubuntu 16.04 or Ubuntu 18.04 | 2GB |
| DB Server | Ubuntu 16.04 or Ubuntu 18.04 | 2GB |
| Stratum Server | Ubuntu 16.04 or Ubuntu 18.04 | 8GB |
| Daemon Server | Ubuntu 16.04 or Ubuntu 18.04 | 8GB+ |
It is also highly recommended to use a provider that offers private IP's between your servers. If your provider only offers public IP's you must install Wireguard (Installer provided). This will setup a secure VPN connection between your servers for the backend communication.
If installing wireguard do not modify the default private IP's that are provide. Installation will fail!
Just like with the single server install there must be a user account created. If you attempt to run the script under root, it will force you to create a new user account and log in to it.
After the user accounts are created on each server, setup MUST begin on the server that is hosting your database. You do not need to run the installer individually on each server.
During the setup process you will be prompted to enter the user name and password for each of your servers. This is required for the installer to be able to SSH in to each server to perform the installation tasks on that server.
Installation will take about 25 minutes to fully complete. You will get a message on the screen letting you know it has finished.
On first reboot it may take up to 1 minute before the cron screens auto-start. After waiting one minute type:
motd
To help make your server more secure we have changed the install locations and directory structure of YiiMP as follows:
| Directory | Files | Server |
|---|---|---|
| /home/yiimp-data/yiimp | General install location for YiiMP | All |
| /home/yiimp-data/yiimp/starts | screens and stratum sh files - you do not need to run these | Web and Stratum |
| /home/yiimp-data/yiimp/site | - | Web and Stratum |
| /home/yiimp-data/yiimp/site/web | New location for YiiMP web files | Web |
| /home/yiimp-data/yiimp/site/backup | backup location for mysql DB | Web |
| /home/yiimp-data/yiimp/site/configuration | New location of your serverconfig.php | Web |
| /home/yiimp-data/yiimp/site/crons | New location of the main:blocks:loop2 sh files |
Web |
| /home/yiimp-data/yiimp/site/log | New location for debug.log and your nginx server log | Web |
| /home/yiimp-data/yiimp/site/stratum | New location for your stratum files | Stratum |
| /home/yiimp-data/wallets | New location for wallets | Daemon |
Permissions have been setup correctly allowing your main user write acess to the /home/yiimp-data directories! Changing file or directory permissions after install will cause your YiiMP to not function correctly, you have been warned!!
By default even though all stratum algos start on server start, the ports have been blocked by the firewall. To open a port type:
sudo ufw allow port number
You MUST also open the RPC Port number on the daemon server when adding new coins. Failing to open the port will result in a connection time out error.
From there your YiiMP Multi Server installation is fully completed. You can now go to example.com/site/AdminPortal to access your admin section and start adding your coins.
To view a screen type:
screen -r main|loop2|blocks|debug
To detach from a screen type:
ctrl+a+d
To start, stop or restart main|loop2|blocks|debug type:
screens start|stop|restart main|loop2|blocks|debug
We also suggest that you type:
yiimp
and get to know those commands as well!
The following GitHubs have been a source of inspiration and code:
The following forks have been used in the making of the script:
Join our active discord channel: