Skip to content

Commit 8173b44

Browse files
committed
update readme
1 parent 4b20990 commit 8173b44

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A control plane for [WireGuard](https://wireguard.com).
1313
* nginx
1414
* NodeJS / Vue 2
1515

16-
![Screenshot](nettica-architecture.webp)
16+
![Screenshot](https://nettica.com/wp-content/uploads/2025/01/nettica-architecture.webp)
1717

1818
## Features
1919

@@ -40,6 +40,26 @@ A control plane for [WireGuard](https://wireguard.com).
4040

4141
Install dependencies
4242

43+
Install MongoDB (Ubuntu 22.04 instructions):
44+
45+
```
46+
sudo apt-get update
47+
sudo apt-get install gnupg curl
48+
curl -fsSL https://www.mongodb.org/static/pgp/server-8.0.asc | \
49+
sudo gpg -o /usr/share/keyrings/mongodb-server-8.0.gpg \
50+
--dearmor
51+
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
52+
sudo apt-get update
53+
sudo apt-get install -y mongodb-org
54+
55+
sudo systemctl daemon-reload
56+
sudo systemctl start mongod
57+
sudo systemctl enable mongod
58+
59+
```
60+
61+
62+
4363
Sample NGINX Config:
4464

4565
```
@@ -135,7 +155,13 @@ MONGODB_CONNECTION_STRING=mongodb://127.0.0.1:27017
135155
136156
# valid settings: oauth2oidc, google, microsoft2, basic, fake
137157
138-
# Basic auth requires no other parameters but OAUTH_PROVIDER_NAME
158+
# Basic auth is a first class citizen compatible with all the apps. Login with the shadow file defined username/pass.
159+
# If the SERVER variable above is set to, for example, nettica.example.com, it will log you in as user@example.com,
160+
# removing the first label. During login if you add a domain, such as user@example2.com, it will remove that
161+
# domain to validate the user, but preserve it for user creation, allowing for easy testing and evaluation of the product.
162+
163+
# Basic auth requires these two variables set:
164+
OAUTH2_AGENT_REDIRECT_URL=com.nettica.agent://callback/agent
139165
OAUTH2_PROVIDER_NAME=basic
140166
141167
```
@@ -187,13 +213,14 @@ sudo systemctl start nettica-api
187213

188214
Install NodeJS using NVM
189215
```
190-
nvm use lts-latest
216+
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.2/install.sh | bash
217+
nvm use 18
191218
```
192219

193220
Build the frontend
194221

195222
```
196-
cd ui
223+
cd /usr/share/nettica-admin/ui
197224
npm install
198225
npm run build
199226
```

0 commit comments

Comments
 (0)