Skip to content

Hidden docs, needs work

For local Hyper-v Devbox notes

From https://raw.githubusercontent.com/silversword411/tacticalrmm-devdocs

Needs an official install_devbox.sh script

Setup Local Dev Box in Hyper-V VM

Install Ubuntu 20.04 LTS

Don't forget to:

sudo apt-get updates && sudo apt-get upgrade

Optional

Set all users in sudo group not to require password every time:

sudo visudo

Add this:

%sudo ALL=(ALL) NOPASSWD: ALL

Download Customized Install Script and Tweak

Create folder to dump into:

sudo mkdir /rmm
sudo chown ${USER}:${USER} -R /rmm
cd /rmm

Get dev install script:

wget https://raw.githubusercontent.com/silversword411/tacticalrmm-devdocs/blob/main/install_devbox.sh

Edit, and search for REPLACEMEWITHYOURFORKEDREPOURL and replace with your forked repo URL (example commented out below).

Run It

./install_devbox.sh

Watch For

Image

Note

Unlike regular installs, don't worry about the QR code.

Celebrate

Image

Misc Commands

Start MKDocs on Dev Box

cd /rmm/api
source env/bin/activate
pip install --upgrade pip
pip install --upgrade setuptools wheel
pip install -r tacticalrmm/requirements-dev.txt
cd /rmm/docs
mkdocs serve

Running Tests Locally

Prep and update:

source /rmm/api/env/bin/activate
cd /rmm/api/tacticalrmm
pip install -r requirements.txt

Then run tests:

python manage.py test

Misc Notes

Spinning up Frontend Web Interface in Development

cd /web
npm run serve