gawells/Self-Service-Dashboard
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
gawells
2026-04-06 18:41:30 -04:00
parent 0ab1e95690
commit 387bd2d0ae
1 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -6,20 +6,20 @@ A simple, lightweight web application for managing user profile photos in a Free
* **LDAP Authentication**: Secure login with existing FreeIPA credentials. * **LDAP Authentication**: Secure login with existing FreeIPA credentials.
* **Profile Management**: View user details (Display Name, Email). * **Profile Management**: View user details (Display Name, Email).
* **Photo Upload**: Users can upload and update their profile picture (`jpegPhoto` attribute). * **Photo Upload**: Users can upload and update their profile picture (`jpegPhoto` attribute).
* **Change Password**: Users can change there password once logged in
* **Session Management**: Secure, cookie-based sessions with CSRF protection. * **Session Management**: Secure, cookie-based sessions with CSRF protection.
* **Customizable**: Configurable styling (logo, favicon) and LDAP settings. * **Customizable**: Configurable styling (logo, favicon) and LDAP settings.
## Prerequisites ## Prerequisites
* **Go 1.26+** installed on your machine.
* **Go 1.20+** installed on your machine. * Access to a **FreeIPA Server**.
* Access to an **FreeIPA Server**. * A Service Account with permission to search and modify the `jpegPhoto` attribute.
* A Service Account (Bind DN) with permission to search users and modify the `jpegPhoto` attribute.
## Setup & Installation ## Setup & Installation
1. **Clone the Repository** 1. **Clone the Repository**
```bash ```bash
git clone https://git.astraltech.xyz/gawells/Self-Service-Dashboard git clone https://git.astraltech.xyz/gawells/Self-Service-Dashboard.git
cd Self-Service-Dashboard cd Self-Service-Dashboard
``` ```
@@ -30,7 +30,10 @@ A simple, lightweight web application for managing user profile photos in a Free
``` ```
5. **Edit config** 5. **Edit config**
put in your config values for ldap, and whatevery styling guidelines you would want to use Edit the config file
```bash
nvim data/config.json
```
4. **Install Dependencies** 4. **Install Dependencies**
```bash ```bash
@@ -41,15 +44,7 @@ A simple, lightweight web application for managing user profile photos in a Free
```bash ```bash
go run ./src/main/ go run ./src/main/
``` ```
The application will be available at `http://<host>:<port>`. The application will be available at `http://localhost:<port>`.
## Directory Structure
* `src/`: Go source code (`main.go`, `ldap.go`, `session.go`, etc.).
* `src/pages/`: HTML templates for login and profile pages.
* `static/`: CSS files, images, and other static assets.
* `data/`: Configuration files and local assets (logos).
* `avatars/`: Stores cached user profile photos.
## License ## License