Misc. scripts for GoPlugin $PLI node setup using the SCRIPT METHOD.
Thanks to all the Plugin discord community for their input / feedback with special mention to;
- @samsam
- @go140point6
NOTE: All values used in this code are for test purposes only & deployed to a test environment that is regularly deleted.
NOTE: Please ensure that you clone/fork and update with your own values as necessary.
Follow the node setup 101 steps
When connecting to your nodes plugin GUI as outlined in 'fund your node', you must use 'https://your_node_ip:6689' instead due to the configuration applied by the main script
Accompanying youtube of the setup process for specific VPS providers;
A sample vars file is included 'sample.vars'. This file will be copied to your user $HOME folder as part of the main script and the permissions to the file updated to restrict access to the owner of the $HOME folder.
The scripts check that the local node variables file exists. The code prompts you to confirm that the file has been updated.
By using a dedicated variables file, any updates to the main script should not involve any changes to the node specific settings.
The following VARIABLES should be updated at a minimum for your individual implementation;
| VARIABLE | NOTE |
|---|---|
| API_EMAIL="user123@gmail.com" | |
| API_PASS="passW0rd123" | Must be 8 - 50 characters & NO special characters. (error creating api initializer) |
| PASS_KEYSTORE="$oM3$tr*nGp4$$w0Rd$" | Min. 12 characters, 3 lower, 3 upper, 3 numbers, 3 symbols & no more than 3 identical consecutive characters |
| DB_PWD_NEW="testdbpwd1234" | This is your new secure Postgres DB password & NO special characters |
You can reveiw the 'sample.vars' file for the full list of VARIABLES.
This script performs file manipulations & executes the various plugin bash scripts in order to successfully deploy the node.
The scripts has 2 main functions, one of which must be passed to run the scripts
fullnode initiators
Usage: ./pli_node_scripts.sh { fullnode | initiator }
please provide one of the above values to run the scripts
example: ./pli_node_scripts.sh fullnode
As the name suggest, this executes all code to provision a full working node ready for the contract & jobs creation on remix. This function calls the 'initiator' function as part of executing all code.
This function performs just the external initiator section and skips the main node deployment. The key aspect to this function is the file manipulation to extract the access secrets/tokens and complete the registration process vastly reducing the chances of any errors.
NOTE: The script uses a base install folder is your linux users $HOME folder - which is now set as a VARIABLE.
The script performs the following actions;
- Updates Postgres DB password 'sed' find/replace on BASH_FILE1
- Removes existing Golang install as part of pre-requisite for BASH_FILE1
- Updates BASH_FILE2 to use new '.env' files & Postgres password
- Updates BASH_FILE2 with TLS certificate files & TLS Port
- Creates local certificate authority & TLS certificate for use with local job server (enabling HTTPS)
- Updates BASH_FILE2 with EXTERNAL_INITIATORS parameter
- Checks for the Golang path & updates bash profile as necessary
- Initialises the BASH_FILE2 PM2 service & sets PM2 to auto start on boot
- External Initiators install & setup
- Performs authentication the plugin module & generates the initiator keys & output to file
- Manipulates the stored keys file & transfers to VARIABLES
- Auto generates the BASH_FILE3 file required to run the Initiator process
- Initialises the BASH_FILE3 PM2 service & updates PM2 to auto start on boot
As the name suggests this script does a full reset of you local Plugin installation.
User account deletion: The script does NOT delete any other user or system accounts beyond that of 'postgres'.
Basic function is to;
- stop & delete all PM2 processes
- stop all postgress services
- uninstall all postgres related components
- delete all postgres related system folders
- remove the postgres user & group
- delete all plugin installaton folders under the users $HOME folder
Updated to use modular functions allowing for individial functions to be run or You can reveiw the 'sample.vars' file for the full list of VARIABLES.
This script performs OS level commands as follows;
- Apply ubuntu updates
- Install misc. services & apps e.g. UFW, Curl, Git, locate
- New Local Admin user & group (Choice of interactive user input OR hardcode in VARS definition)
- SSH keys for the above
- Applies UFW firewall minimum configuration & starts/enables service
- Modifies UFW firewall logging to use only the ufw.log file
- Modify SSH service to use alternate service port, update UFW & restart SSH
You can reveiw the 'sample.vars' file for the full list of VARIABLES.
Usage: ./base_sys_setup.sh {function}
where {function} is one of the following;
-D == performs a normal base setup (excludes User acc & Securing SSH)"
-- this assumes you are installing under your current admin session (preferable not root)"
-os == perform OS updates & installs required packages (see sample.vars 'BASE_SYS_PACKAGES')
-user == Adds a new admin account (to install the plugin node under) & SSH keys
-ports == Adds required ports to UFW config (see sample.vars for 'PORT' variables )
-ufw == Starts the UFW process, sets the logging to 'ufw.log' only & enables UFW service
-S == Secures the SSH service:
-- sets SSH to use port number 'your_defined_new_port'
-- sets authentication method to SSH keys ONLY (Password Auth is disabled)
-- adds port number 'your_defined_new_port' to UFW ruleset
-- restarts the SSH service to activate new settings (NOTE: Current session is unaffected)
NOTE: The script does read the local node specific vars file.
As the code is updated it will be necessary to update your local repo from time to time. To do this you have two options;
-
Force git to update the local repo by overwriting the local changes, which in this case are the file permission changes. Copy and paste the following code;
git fetch git reset --hard HEAD git merge '@{u}' chmod +x *.shsource: https://www.freecodecamp.org/news/git-pull-force-how-to-overwrite-local-changes-with-git/
-
Manually delete the folder and re-run the clone & permissions commands. Copy and paste the following code;
cd $HOME rm -rf pli_node_conf git clone https://github.com/inv4fee2020/pli_node_conf.git cd pli_node_conf chmod +x *.sh
NOTE: None of the above steps will overwrite your local nodes variables file as it is stored in your $HOME folder.
The scripts have been developed on ubuntu 20.x linux distros deployed within both a vmware esxi environment & racknerd VPS.
Full deployment of the base node & external initiators was recorded at 15mins on racknerd with no user interaction.