diff --git a/README.md b/README.md index 7e04993..955d43c 100644 --- a/README.md +++ b/README.md @@ -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. * **Profile Management**: View user details (Display Name, Email). * **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. * **Customizable**: Configurable styling (logo, favicon) and LDAP settings. ## Prerequisites - -* **Go 1.20+** installed on your machine. -* Access to an **FreeIPA Server**. -* A Service Account (Bind DN) with permission to search users and modify the `jpegPhoto` attribute. +* **Go 1.26+** installed on your machine. +* Access to a **FreeIPA Server**. +* A Service Account with permission to search and modify the `jpegPhoto` attribute. ## Setup & Installation 1. **Clone the Repository** ```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 ``` @@ -30,7 +30,10 @@ A simple, lightweight web application for managing user profile photos in a Free ``` 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** ```bash @@ -41,15 +44,7 @@ A simple, lightweight web application for managing user profile photos in a Free ```bash go run ./src/main/ ``` - The application will be available at `http://:`. - -## 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. + The application will be available at `http://localhost:`. ## License