Merge pull request #435 from silversword411/develop

Docs and tips update
This commit is contained in:
Dan 2021-04-25 00:20:05 -07:00 committed by GitHub
commit 3f51dd1d2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 72 additions and 7 deletions

View File

@ -15,14 +15,14 @@ Needs an official install_devbox.sh script
## Install Ubuntu 20.04 LTS ## Install Ubuntu 20.04 LTS
Don't forget to Don't forget to
``` ```bash
sudo apt-get updates && sudo apt-get upgrade sudo apt-get updates && sudo apt-get upgrade
``` ```
### Optional ### Optional
Set all users in sudo group not to require password every time: Set all users in sudo group not to require password every time:
``` ```bash
sudo visudo sudo visudo
``` ```
@ -36,14 +36,14 @@ Add this:
Create folder to dump into Create folder to dump into
``` ```bash
sudo mkdir /rmm sudo mkdir /rmm
sudo chown ${USER}:${USER} -R /rmm sudo chown ${USER}:${USER} -R /rmm
cd /rmm cd /rmm
``` ```
Get dev install script Get dev install script
``` ```bash
wget https://raw.githubusercontent.com/silversword411/tacticalrmm-devdocs/blob/main/install_devbox.sh wget https://raw.githubusercontent.com/silversword411/tacticalrmm-devdocs/blob/main/install_devbox.sh
``` ```
@ -53,7 +53,7 @@ and replace with your forked repo URL (example commented out below)
## Run it ## Run it
``` ```bash
./install_devbox.sh ./install_devbox.sh
``` ```
## Watch for ## Watch for
@ -98,7 +98,16 @@ pip install -r requirements.txt
Then run tests Then run tests
``` ```bash
python manage.py test python manage.py test
``` ```
## Misc Notes
### Spinning up front end web interface in development
```bash
cd /web
npm run serve
```

View File

@ -0,0 +1,48 @@
## Install WSL2
https://docs.microsoft.com/en-us/windows/wsl/install-win10
## Install Docker Desktop
https://www.docker.com/products/docker-desktop
### Configure Docker
Make sure it doesn't look like this
![img](images/docker_WSL2_distros_missing.png)
This is better
![img](images/docker_with_ubuntu-20.04.png)
### Check and make sure WSL is v2 and set Ubuntu as default
[https://docs.microsoft.com/en-us/windows/wsl/install-win10#set-your-distribution-version-to-wsl-1-or-wsl-2](https://docs.microsoft.com/en-us/windows/wsl/install-win10#set-your-distribution-version-to-wsl-1-or-wsl-2)
![img](images/wls2_upgrade_and_set_default.png)
## Create .env file
Under .devcontainer duplicate
```
.env.example
```
as
```
.env
```
Customize to your tastes (it doesn't need to be internet configured, just add records in your `hosts` file) eg
```
127.0.0.1 rmm.example.com
127.0.0.1 api.example.com
127.0.0.1 mesh.example.com
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 375 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

View File

@ -53,6 +53,12 @@
</q-badge> </q-badge>
<span> To use a domain CA </span> <span> To use a domain CA </span>
</div> </div>
<div class="q-pa-xs q-gutter-xs">
<q-badge class="text-caption q-mr-xs" color="grey" text-color="black">
<code>-desc "Desired custom description on agent"</code>
</q-badge>
<span> Set agent description field during install </span>
</div>
</q-expansion-item> </q-expansion-item>
<br /> <br />
<p class="text-italic">Note: the auth token above will be valid for {{ info.expires }} hours.</p> <p class="text-italic">Note: the auth token above will be valid for {{ info.expires }} hours.</p>

View File

@ -25,7 +25,9 @@
<div class="text-subtitle2">General</div> <div class="text-subtitle2">General</div>
<hr /> <hr />
<q-card-section class="row"> <q-card-section class="row">
<q-checkbox v-model="settings.agent_auto_update" label="Enable agent automatic self update" /> <q-checkbox v-model="settings.agent_auto_update" label="Enable agent automatic self update">
<q-tooltip> Runs at 35mins past every hour </q-tooltip>
</q-checkbox>
</q-card-section> </q-card-section>
<q-card-section class="row"> <q-card-section class="row">
<div class="col-4">Default agent timezone:</div> <div class="col-4">Default agent timezone:</div>