more docs

docs/docs/faq.md

@@ -0,0 +1,56 @@
+# FAQ
+
+
+#### How do I do X feature in the web UI?
+Alot of features in the web UI are hidden behind right-click menus; almost everything has a right click menu so if you don't see something, try right clicking on it.
+#### Where are the linux / mac agents?
+Linux / Mac agents are currently under development.
+
+#### I am locked out of the web UI. How do I reset my password?
+
+SSH into your server and run these commands:
+
+!!!note
+    The code below will reset the password for the account that was created during install.
+    To reset a password for a different user, you should use the web UI (see the next question below), but can also do so through the command line by replacing<br/>
+    `user = User.objects.first()`<br/>
+    with<br/>
+    `user = User.objects.get(username='someuser')`
+    <br/>
+    in the code snippet below.
+
+
+```python
+tactical@tacrmm:~$ /rmm/api/env/bin/python /rmm/api/tacticalrmm/manage.py shell
+Python 3.9.2 (default, Feb 21 2021, 00:50:28)
+[GCC 9.3.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+(InteractiveConsole)
+>>> from accounts.models import User
+>>> user = User.objects.first()
+>>> user.set_password("superSekret123")
+>>> user.save()
+>>> exit()
+```
+
+<br/>
+
+#### How do I reset password or 2 factor token?
+From the web UI, click **Settings > User Administration** and then right-click on a user:<br/><br/>
+![reset2fa](images/reset2fa.png)
+<br/><br/>
+Or from the command line:<br/>
+```python
+tactical@tacrmm:~$ /rmm/api/env/bin/python /rmm/api/tacticalrmm/manage.py shell
+Python 3.9.2 (default, Feb 21 2021, 00:50:28)
+[GCC 9.3.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+(InteractiveConsole)
+>>> from accounts.models import User
+>>> user = User.objects.get(username='someuser')
+>>> user.totp_key = None
+>>> user.save(update_fields=['totp_key'])
+>>> exit()
+```
+<br/>
+Then simply log out of the web UI and next time the user logs in they will be redirected to the 2FA setup page which will present a barcode to be scanned with the Authenticator app.

docs/docs/install_agent.md

@@ -0,0 +1,51 @@
+# Installing an agent
+
+!!!warning
+    You must add antivirus exlusions for the tactical agent.<br/>
+    Any decent AV will flag the agent as a virus, since it technically is one due to the nature of this app.<br/>
+    Adding the following exlucions will make sure everything works, including agent update:<br/>
+    `C:\Program Files\TacticalAgent\*`<br/>
+    `C:\Program Files\Mesh Agent\*`<br/>
+    `C:\Windows\Temp\winagent-v*.exe`<br/>
+    `C:\Windows\Temp\trmm\*`<br/>
+    
+
+
+
+#### Dynamically generated executable
+
+The generated exe is simply a wrapper around the Manual install method, using a single exe/command without the need to pass any command line flags to the installer.<br/><br/>
+All it does is download the generic installer from the agent's github [release page](https://github.com/wh1te909/rmmagent/releases) and call it using predefined command line args that you choose from the web UI.<br/><br/>
+It "bakes" the command line args into the executable.<br/><br/>
+From the UI, click **Agents > Install Agent**<br/>
+You can also **right click on a site > Install Agent**. This will automatically fill in the client/site dropdown for you.<br/><br/>
+![siteagentinstall](images/siteagentinstall.png)
+
+#### Powershell
+The powershell method is very similar to the generated exe in that it simply downloads the installer from github and calls the exe for you.
+
+#### Manual
+The manual installation method requires you to first download the generic installer and call it using command line args.<br/><br/>
+This is useful for scripting the installation using Group Policy or some other batch deployment method.<br/>
+
+
+!!!tip
+    You can reuse the installer for any of the deployment methods, you don't need to constantly create a new installer for each new agent.<br/>
+    The installer will be valid for however long you specify the token expiry time when generating an agent.
+
+<br/>
+#### Using a deployment link
+
+Creating a deployment link is the recommended way to deploy agents.<br/><br/>
+The main benefit of this method is that the exectuable is generated only whenever the deployment download link is accessed, whereas with the other methods it's generated right away and the agent's version hardcoded into the exe.<br/><br/>
+Using a deployment link will allow you to not worry about installing using an older version of an agent, which will fail to install if you have updated your RMM to a version that is not compatible with an older installer you might have lying around.<br/><br/>
+
+To create a deployment, from the web UI click **Agents > Manage Deployments**.<br/><br/>
+![managedeployments](images/managedeployments.png)
+
+
+!!!tip
+    Create a client/site named "Default" and create a deployment for it with a very long expiry to have a generic installer that can be deployed anytime at any client/site.<br/><br/>
+    You can then move the agent into the correct client/site from the web UI after it's been installed.
+
+Copy/paste the download link from the deployment into your browser. It will take a few seconds to dynamically generate the executable and then your browser will automatically download the exe.

docs/docs/install_server.md

@@ -22,12 +22,14 @@ apt install -y wget curl sudo
 apt -y upgrade
 ```
 If a new kernel is installed, then reboot the server with the `reboot` command<br/><br/>
-Create a user to run the rmm and add it to the sudoers group. For this example we'll be using a user named `tactical` but feel free to create whatever name you want.
+Create a linux user to run the rmm and add it to the sudoers group.<br/>For this example we'll be using a user named `tactical` but feel free to create whatever name you want.
 ```bash
 adduser tactical
 usermod -a -G sudo tactical
 ```
-- *Optional: [enable passwordless sudo to make your life easier](https://linuxconfig.org/configure-sudo-without-password-on-ubuntu-20-04-focal-fossa-linux)*<br/><br/>
+
+!!!tip
+    [Enable passwordless sudo to make your life easier](https://linuxconfig.org/configure-sudo-without-password-on-ubuntu-20-04-focal-fossa-linux)
 
 #### Setup the firewall (optional but highly recommended)
 

docs/docs/license.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-present wh1te909
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/mkdocs.yml

@@ -1,12 +1,13 @@
-site_name: "Tactical RMM"
+site_name: "Tactical RMM Documentation"
 nav:
   - Home: index.md
-  - Installation:
+  - RMM Installation:
       - "Traditional Install": install_server.md
       - "Docker Install": install_docker.md
-  - Troubleshooting: troubleshooting.md
+  - Agent Installation: install_agent.md
   - FAQ: faq.md
-site_description: "A remote monitoring and management tool for Windows computers"
+  - License: license.md
+site_description: "A remote monitoring and management tool"
 site_author: "wh1te909"
 
 dev_addr: "0.0.0.0:8005"