Merge branch 'master' of github.com:nettica-com/nettica-admin

Author: alan-nettica

README.md

@@ -13,7 +13,7 @@ A control plane for [WireGuard](https://wireguard.com).
 * nginx
 * NodeJS / Vue 2
 
-![Screenshot](nettica-architecture.webp)
+![Screenshot](https://nettica.com/wp-content/uploads/2025/01/nettica-architecture.webp)
 
 ## Features
 
@@ -35,10 +35,39 @@ A control plane for [WireGuard](https://wireguard.com).
 
 ## Running
 
+### Install dependencies
 
-### Directly
+Install MongoDB (Ubuntu 22.04 instructions):
 
-Install dependencies
+```
+sudo apt-get update
+sudo apt-get install gnupg curl
+curl -fsSL https://www.mongodb.org/static/pgp/server-8.0.asc | \
+   sudo gpg -o /usr/share/keyrings/mongodb-server-8.0.gpg \
+   --dearmor
+echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-8.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/8.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-8.0.list
+sudo apt-get update
+sudo apt-get install -y mongodb-org
+
+sudo systemctl daemon-reload
+sudo systemctl start mongod
+sudo systemctl enable mongod
+
+```
+
+
+[Download and Install Golang](https://go.dev/dl/)
+
+Install nginx:
+```
+sudo apt install nginx
+sudo apt install certbot
+sudo apt install python3-certbot-nginx
+
+sudo apt enable nginx
+sudo apt start nginx
+
+```
 
 Sample NGINX Config:
 
@@ -135,7 +164,13 @@ MONGODB_CONNECTION_STRING=mongodb://127.0.0.1:27017
 
 # valid settings: oauth2oidc, google, microsoft2, basic, fake
 
-# Basic auth requires no other parameters but OAUTH_PROVIDER_NAME
+# Basic auth is a first class citizen compatible with all the apps.  Login with the shadow file defined username/pass.
+# If the SERVER variable above is set to, for example, nettica.example.com, it will log you in as user@example.com,
+# removing the first label.  During login if you add a domain, such as user@example2.com, it will remove that
+# domain to validate the user, but preserve it for user creation, allowing for easy testing and evaluation of the product.
+
+# Basic auth requires these two variables set:
+OAUTH2_AGENT_REDIRECT_URL=com.nettica.agent://callback/agent
 OAUTH2_PROVIDER_NAME=basic
 
 ```
@@ -187,20 +222,27 @@ sudo systemctl start nettica-api
 
 Install NodeJS using NVM
 ```
-nvm use lts-latest
+wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.2/install.sh | bash
+nvm use 18
 ```
 
 Build the frontend
 
 ```
-cd ui
+cd /usr/share/nettica-admin/ui
 npm install
 npm run build
 ```
 
 With the given nginx config, you should now be able to use your website.  Don't forget
 to get a cert using certbot
 
+Run Certbot
+```
+sudo certbot
+```
+
+
 ## Need Help
 
 mailto:support@nettica.com