fix readme
This commit is contained in:
parent
35a8b14af2
commit
cd42a6b0bf
51
README.md
51
README.md
|
@ -47,57 +47,6 @@ This project provides a web interface to change the password for XMPP accounts m
|
||||||
|
|
||||||
- **main.go**: The entry point of the application. It initializes the services and starts the web server.
|
- **main.go**: The entry point of the application. It initializes the services and starts the web server.
|
||||||
|
|
||||||
Certainly! Here's the updated README.md with the "Requirements" section:
|
|
||||||
Prosody Password Manager
|
|
||||||
|
|
||||||
This project provides a web interface to change the password for XMPP accounts managed by Prosody. It interfaces with the Prosody server to securely handle password changes.
|
|
||||||
Project Structure
|
|
||||||
|
|
||||||
go
|
|
||||||
|
|
||||||
.
|
|
||||||
├── cmd
|
|
||||||
│ └── http
|
|
||||||
│ ├── main.go
|
|
||||||
│ └── views
|
|
||||||
│ ├── error.hbs
|
|
||||||
│ ├── index.hbs
|
|
||||||
│ ├── styles.hbs
|
|
||||||
│ └── success.hbs
|
|
||||||
├── go.mod
|
|
||||||
├── go.sum
|
|
||||||
├── internal
|
|
||||||
│ ├── api
|
|
||||||
│ │ ├── handler
|
|
||||||
│ │ │ ├── helper.go
|
|
||||||
│ │ │ └── prosody_hdl.go
|
|
||||||
│ │ └── server.go
|
|
||||||
│ └── services
|
|
||||||
│ ├── fail2ban
|
|
||||||
│ │ └── fail.go
|
|
||||||
│ └── prosody
|
|
||||||
│ ├── account.go
|
|
||||||
│ ├── change_password.go
|
|
||||||
│ ├── change_password_test.go
|
|
||||||
│ └── prosody.go
|
|
||||||
├── kit
|
|
||||||
│ ├── config
|
|
||||||
│ │ └── config.go
|
|
||||||
│ └── path.go
|
|
||||||
└── LICENSE
|
|
||||||
|
|
||||||
Key Files
|
|
||||||
|
|
||||||
change_password.go: Contains the logic to change the password in the Prosody server. It interfaces with the Prosody server's command-line tools and verifies the current password before making any changes.
|
|
||||||
|
|
||||||
prosody.go: Provides utility functions related to the Prosody server, including constructing paths to account data files.
|
|
||||||
|
|
||||||
account.go: Contains utility functions to load account details from Prosody's data files.
|
|
||||||
|
|
||||||
server.go: Sets up the web server, routes, and middleware for the application.
|
|
||||||
|
|
||||||
main.go: The entry point of the application. It initializes the services and starts the web server.
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- **Prosody Server**: Ensure that the Prosody server is installed and running on your machine. This application interfaces with Prosody's command-line tools to manage XMPP accounts.
|
- **Prosody Server**: Ensure that the Prosody server is installed and running on your machine. This application interfaces with Prosody's command-line tools to manage XMPP accounts.
|
||||||
|
|
Loading…
Reference in New Issue