wsl install and add vpn configs
This commit is contained in:
5
content/docs/Installation/Install_with_vpn/_index.md
Normal file
5
content/docs/Installation/Install_with_vpn/_index.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Install with VPN
|
||||
weight: 1
|
||||
---
|
||||
It is possible to install Glympse with a VPN connection. This allows for multi site connectivity and remote productions.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Install With Netbird
|
||||
type: docs
|
||||
prev: /docs
|
||||
weight: 2
|
||||
---
|
||||
Insted of using Tailscale as your VPN options, it is possible to use Netbird istead. Netbird works in a very similar way to Tailscale however it can be completely selfhosted. This means you could run Netbird on a VPS for a few £ per month and have unlimited users accessing Glympse adn any other services you wish to include.
|
||||
|
||||
The reasons for doing this are mainly for security purposes. It gives you a couple of options. First you can create a tunnel to your Glympse webUI from a cheap VPS. This hides your IP address and does not require you to open any ports in your firewall. You can also limit the traffic to only entering your Glympse WebUI contianer.
|
||||
|
||||
Another option which is even more secure but has an additional cost, is you can require your users be on your tailnet. This would mean that there is zero access to Glympse from the internet, but your users who have the netbird client installed can access Glympse through the netbird VPN.
|
||||
|
||||
Connecting your containers to Netbird uses the Netbird sidecar containers. To read more about how this works click [here](https://netbird.io/knowledge-hub).
|
||||
## Install sidecar container
|
||||
Adding a sidecar container to your Glympse compose file is pretty simple. first add the Netbird container to the top of your Glympse compose file:
|
||||
|
||||
```yaml {filename="compose.yml"}
|
||||
...
|
||||
|
||||
glympse-nb:
|
||||
image: netbirdio/netbird
|
||||
container_name: glympse-nb
|
||||
cap_add:
|
||||
- net_admin
|
||||
- sys_module
|
||||
environment:
|
||||
- NB_SETUP_KEY=<your netbird key>
|
||||
- NB_MANAGEMENT_URL=<netbird management url>
|
||||
hostname: glympse-<machine name>
|
||||
restart: unless-stopped
|
||||
|
||||
...
|
||||
|
||||
```
|
||||
|
||||
You then need to make a small tweak to your Glympse container's networking settings:
|
||||
|
||||
```yaml {filename="compose.yml"}
|
||||
...
|
||||
network_mode: service:glympse-nb
|
||||
...
|
||||
|
||||
```
|
||||
This will tell your Glympse container to route it's traffic through the Netbird Container.
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Install With Tailscale
|
||||
type: docs
|
||||
prev: /docs
|
||||
weight: 1
|
||||
---
|
||||
It is possible to use Tailscale as a private vpn proxy between all your Glympse containers. This connect nodes to nodes on other networks.
|
||||
|
||||
The reasons for doing this are mainly for security purposes. It gives you a couple of options. First you can create a tunnel to your Glympse webUI from a cheap VPS. This hides your IP address and does not require you to open any ports in your firewall. You can also limit the traffic to only entering your Glympse WebUI contianer.
|
||||
|
||||
Another option which is even more secure but has an additional cost, is you can require your users be on your tailnet. This would mean that there is zero access to Glympse from the internet, but your users who have tailscale installed can access Glympse through the tailscale VPN.
|
||||
|
||||
## Install sidecar container
|
||||
Connecting your containers to tailscale uses the tailscale sidecar containers. To read more about how this works click [here](https://tailscale.com/kb/1282/docker).
|
||||
|
||||
Adding a sidecar container to your Glympse compose file is pretty simple. first add the Tailscale container to the top of your Glympse compose file:
|
||||
|
||||
```yaml {filename="compose.yml"}
|
||||
...
|
||||
|
||||
glympse-ts:
|
||||
image: tailscale/tailscale
|
||||
container_name: glympse-ts
|
||||
cap_add:
|
||||
- net_admin
|
||||
- sys_module
|
||||
volumes:
|
||||
- /dev/net/tun:/dev/net/tun
|
||||
environment:
|
||||
- TS_AUTHKEY=<tailscale auth key>
|
||||
- TS_STATE_DIR=/var/lib/tailscale
|
||||
hostname: glympse-<machine name>
|
||||
restart: unless-stopped
|
||||
|
||||
...
|
||||
|
||||
```
|
||||
|
||||
You then need to make a small tweak to your Glympse container's networking settings:
|
||||
|
||||
```yaml {filename="compose.yml"}
|
||||
...
|
||||
network_mode: service:glympse-ts
|
||||
...
|
||||
|
||||
```
|
||||
This will tell your Glympse container to route it's traffic through the Tailscale Container.
|
||||
55
content/docs/Installation/wsl_install.md
Normal file
55
content/docs/Installation/wsl_install.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Docker system setup on WSL for Windows
|
||||
type: docs
|
||||
next: docs/installation/services
|
||||
next: docs/installation/install_glympse
|
||||
---
|
||||
|
||||
Whilst it is possible to run docker desktop on Windows/MacOS. This may have some potential licensing costs. As such the below script will allow you to install docker and the requirements to run Glympse on Ubuntu on WSL.
|
||||
|
||||
Open the windows terminal app and run the following commands.
|
||||
|
||||
```powershell
|
||||
# Install WSL
|
||||
wsl --install
|
||||
wsl --set-default-version 2
|
||||
# Install Ubuntu on WSL
|
||||
wsl --install -d Ubuntu
|
||||
```
|
||||
|
||||
The following commands need to be run from within the Ubuntu system. You can access this by typing `wsl -d Ubuntu` to enter a cmd prompt.
|
||||
|
||||
```bash
|
||||
#install the prerequisit dependancies
|
||||
sudo apt install -y apt-transport-https ca-certificates curl software-properties-common
|
||||
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
|
||||
sudo echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
|
||||
curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
|
||||
&& curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | \
|
||||
sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
|
||||
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list
|
||||
|
||||
|
||||
# install docker and docker compose
|
||||
sudo apt update
|
||||
sudo apt install -y docker-ce
|
||||
|
||||
sudo mkdir -p ~/.docker/cli-plugins/
|
||||
sudo curl -SL https://github.com/docker/compose/releases/download/v2.3.3/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose
|
||||
sudo chmod +x ~/.docker/cli-plugins/docker-compose
|
||||
|
||||
#Enable the nvidia runtime
|
||||
sudo apt-get install -y nvidia-container-toolkit nvidia-utils-535-server
|
||||
sudo nvidia-ctk runtime configure --runtime=docker
|
||||
sudo systemctl restart docker
|
||||
|
||||
#Optional step to allow you to run docker commands without root or sudo access
|
||||
sudo usermod -aG docker ${USER}
|
||||
su - ${USER}
|
||||
|
||||
```
|
||||
|
||||
|
||||
You can check that your Nvidia GPU is working in WSL by typing `nvidia-smi`.
|
||||
|
||||
You are now ready to install Glympse
|
||||
Reference in New Issue
Block a user