Skip to content

Commit 42b55b3

Browse files
authored
Update README.md
1 parent 605d5ea commit 42b55b3

File tree

1 file changed

+40
-20
lines changed

1 file changed

+40
-20
lines changed

README.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
11
# LAPS-WebUI
2-
A nice and simple Web Interface for LAPS (Local Administrator Password Solution)
32

4-
## Version 1.6.0 breaking change
3+
A simple web interface for Microsoft LAPS (Local Administrator Password Solution).
54

6-
Version 1.6.0 adds multidomain support. Due this change the configurations changes. Please see `appsettings.json.example` and
5+
---
76

8-
## Setup Preqesites
7+
## 📚 About
98

10-
### Setup Preqesites
9+
This is a modern frontend for Microsoft LAPS, supporting:
10+
- LAPS v1 and v2
11+
- Multiple Active Directory domains
12+
- Authentication directly via Active Directory
13+
- Bare-metal and Docker deployment
1114

12-
- A working Active Directory with Microsoft LAPS installed
13-
- .NET Core 9.0 compatible Operating System (Ubuntu/Debian/CentOS/Alpine Linux/Windows/macOS) or a Docker Host
15+
No additional user management is needed — access is fully controlled by Active Directory permissions.
16+
17+
---
18+
19+
## ⚠️ Version 1.6.0 Notice
20+
21+
> Starting with version 1.6.0, multi-domain support was added.
22+
> As a result, the configuration format has changed.
23+
> Review the updated `appsettings.json.example` for details and adjust your setup accordingly.
24+
25+
---
26+
27+
## 🛠 Requirements
28+
29+
- Active Directory with Microsoft LAPS installed
30+
- .NET 9 runtime or a Docker host
31+
- Python 3 with `dpapi-ng` installed:
32+
```bash
33+
pip install dpapi-ng[kerberos]
1434

1535
### Bare Metal:
1636

@@ -42,24 +62,24 @@ docker run -d \
4262
--restart unless-stopped \
4363
ghcr.io/seji64/laps-webui:1.6
4464
```
45-
## Advanced configuration
46-
47-
### Change Listen Address and/or Port
48-
49-
There are a few options to configure this. [Here](https://andrewlock.net/exploring-the-dotnet-8-preview-updates-to-docker-images-in-dotnet-8/) is a quite good writeup with explains all options.
5065
66+
## ⚙️ Advanced Configuration
67+
- Listen address and port: [Learn more](https://andrewlock.net/exploring-the-dotnet-8-preview-updates-to-docker-images-in-dotnet-8/)
68+
- Behind a reverse proxy: WebSocket support must be enabled!
5169
52-
### Reverse Proxy
53-
If you are using a reverse proxy ensure `WebSockets` are allowed / enabled
5470
55-
## Usage:
56-
- Navigate with your WebBrowser to the LAPS WebUI Page (Default: http://127.0.0.1:8080 )
57-
- Login with any Active Directory User which can access the LAPS LDAP Properties
58-
- Type any Computername in the Searchbox and click a result to view the LAPS Password.
71+
## 🧑‍💻 Usage
72+
- Access the app at: http://127.0.0.1:8080
73+
- Authenticate with your Active Directory user credentials
74+
- Search for a computer by its name
75+
- Click on the result to display the LAPS-managed password
5976
60-
## Why is there no User Management?
77+
## ❓ FAQ
78+
### Why is there no user management?
79+
Authentication and authorization are fully handled by Active Directory.
6180
62-
There is none cause *LAPS-WebUI* authenticates against your ActiveDirectory. There is also defined who can read those LAPS Passwords.
81+
### What LAPS versions are supported?
82+
Both Microsoft LAPS v1 (legacy) and LAPS v2 (modern) are supported.
6383
6484
## Screenshots:
6585

0 commit comments

Comments
 (0)