diff --git a/README.md b/README.md index 023a18ca..ab3dca68 100644 --- a/README.md +++ b/README.md @@ -31,4 +31,106 @@ It uses an [agent](https://github.com/wh1te909/winagent) written in python, as w ## Windows versions supported -- Windows 7, 8.1, 10, Server 2008R2, 2012R2, 2016, 2019 \ No newline at end of file +- Windows 7, 8.1, 10, Server 2008R2, 2012R2, 2016, 2019 + +## Installation example (Ubuntu server 18.04 LTS) + +Fresh VPS with latest updates\ +login as root and create a user and add to sudoers group (we will be creating a user called tactical) +``` +apt update && apt -y upgrade +adduser tactical +usermod -a -G sudo tactical +``` + +switch to the tactical user and setup the firewall +``` +su - tactical +sudo ufw default deny incoming +sudo ufw default allow outgoing +sudo ufw allow ssh +sudo ufw allow http +sudo ufw allow https +sudo ufw allow proto tcp from any to any port 4505,4506 +sudo ufw enable && sudo ufw reload +``` + +Our domain for this example is tacticalrmm.com + +In the DNS manager of wherever our domain is hosted, we will create three A records, all pointing to the public IP address of our VPS + +Create A record ```api.tacticalrmm.com``` for the django rest backend\ +Create A record ```rmm.tacticalrmm.com``` for the vue frontend\ +Create A record ```mesh.tacticalrmm.com``` for meshcentral + +Download the install script and run it + +``` +wget https://raw.githubusercontent.com/wh1te909/tacticalrmm/develop/install.sh +chmod +x install.sh +./install.sh +``` + +Enter the following values when prompted: + +![Screenshot](docs/screenshots/install1.PNG) + +The install script will begin installing stuff. When it gets to this step, create the django superuser account: + +![Screenshot](docs/screenshots/install2.PNG) + +Download the Google Authenticator app on your smartphone and scan the barcode that is generated: + +![Screenshot](docs/screenshots/install3.PNG) + +Once the install has finished, navigate to your meshcentral site\ +https://mesh.tacticalrmm.com + +![Screenshot](docs/screenshots/install4.PNG) + +Create an account. Make sure to use the same username that you entered at the beginning of the install script when prompted for "meshcentral username"\ +Create a strong password (does __not__ have to be the same as the django superuser account, recommend using a different password) + +![Screenshot](docs/screenshots/install5.PNG) + +Now create a device group. Name it whatever you want: + +![Screenshot](docs/screenshots/install6.PNG) + +Click on "add one" and download the 64bit Mesh Agent: + +![Screenshot](docs/screenshots/install7.PNG) + +You will now have a file named "meshagent64-tacticalrmm.exe" in your Downloads folder + +Navigate to the rmm frontend in a new tab\ +https://rmm.tacticalrmm.com + +Login using the username and password you created during the install script for the django superuser\ +Then enter the 6 digit code from your google authenticator app when prompted + +You will be redirected to the initial setup page + +Create your first client and site, then upload the ```meshagent64-tacticalrmm.exe``` from your downloads folder and click Finish: + +![Screenshot](docs/screenshots/install8.PNG) + +You will be taken to the homepage of the app + + +Now install the agent on a windows computer: + +Download the latest release exe from https://github.com/wh1te909/winagent/releases + +Run the installer as administrator + +Make sure to use the backend api url when installing, not the frontend url\ +Username and password is the same one you created for django superuser: + +![Screenshot](docs/screenshots/install9.PNG) + +Choose the client and site, enter a description of the computer and then install: + +![Screenshot](docs/screenshots/install10.PNG) + +Once installation finished, check the website and you will see your computer appear in the dashboard. \ No newline at end of file diff --git a/docs/screenshots/install1.PNG b/docs/screenshots/install1.PNG new file mode 100644 index 00000000..8724ddba Binary files /dev/null and b/docs/screenshots/install1.PNG differ diff --git a/docs/screenshots/install10.PNG b/docs/screenshots/install10.PNG new file mode 100644 index 00000000..f332dce3 Binary files /dev/null and b/docs/screenshots/install10.PNG differ diff --git a/docs/screenshots/install2.PNG b/docs/screenshots/install2.PNG new file mode 100644 index 00000000..f48e8957 Binary files /dev/null and b/docs/screenshots/install2.PNG differ diff --git a/docs/screenshots/install3.PNG b/docs/screenshots/install3.PNG new file mode 100644 index 00000000..a7d4826c Binary files /dev/null and b/docs/screenshots/install3.PNG differ diff --git a/docs/screenshots/install4.PNG b/docs/screenshots/install4.PNG new file mode 100644 index 00000000..a8eb2a5e Binary files /dev/null and b/docs/screenshots/install4.PNG differ diff --git a/docs/screenshots/install5.PNG b/docs/screenshots/install5.PNG new file mode 100644 index 00000000..a4842a5a Binary files /dev/null and b/docs/screenshots/install5.PNG differ diff --git a/docs/screenshots/install6.PNG b/docs/screenshots/install6.PNG new file mode 100644 index 00000000..e0283276 Binary files /dev/null and b/docs/screenshots/install6.PNG differ diff --git a/docs/screenshots/install7.PNG b/docs/screenshots/install7.PNG new file mode 100644 index 00000000..2d4d36b0 Binary files /dev/null and b/docs/screenshots/install7.PNG differ diff --git a/docs/screenshots/install8.PNG b/docs/screenshots/install8.PNG new file mode 100644 index 00000000..3aa60a69 Binary files /dev/null and b/docs/screenshots/install8.PNG differ diff --git a/docs/screenshots/install9.PNG b/docs/screenshots/install9.PNG new file mode 100644 index 00000000..9b14e122 Binary files /dev/null and b/docs/screenshots/install9.PNG differ diff --git a/install.sh b/install.sh index efbd3b90..41c23ab8 100755 --- a/install.sh +++ b/install.sh @@ -567,8 +567,6 @@ print_green 'Installing certbot' sudo add-apt-repository -y ppa:certbot/certbot sudo apt install -y certbot -sudo ufw allow http -sudo ufw allow https sudo systemctl stop nginx print_green 'Getting https certs' @@ -577,9 +575,6 @@ sudo certbot certonly --standalone --agree-tos -m ${letsemail} --no-eff-email -d sudo certbot certonly --standalone --agree-tos -m ${letsemail} --no-eff-email -d ${rmmdomain} sudo certbot certonly --standalone --agree-tos -m ${letsemail} --no-eff-email -d ${frontenddomain} -sudo ufw delete allow http -sudo ufw delete allow https - sudo chown -R $USER:$GROUP /home/${USER}/.npm sudo chown -R $USER:$GROUP /home/${USER}/.config