Skip to content

Commit

Permalink
Merge pull request #86 from VictoriqueMoe/update-readme-stats
Browse files Browse the repository at this point in the history
  • Loading branch information
nakedmcse authored Mar 4, 2024
2 parents 18aed38 + e574fb2 commit 4de015f
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,10 @@ Optional Settings

## Admin Feature

This application comes with a useful admin panel that will allow you to control the files that are uploaded, and to
This application comes with a useful admin site that will allow you to control the files that are uploaded, and to
provide security control with the ability to ban abusive IPs.

The site also features statistics to allow you to at-a-glance see information on the files that have been uploaded.

### Setup

Expand All @@ -90,32 +91,55 @@ and password.
### Usage

Once in the admin, you can see what files have been uploaded and sort them by any of the available columns.
You can also ban and unban IP addresses from here, and download any files that have been uploaded.
You can also ban and unban IP addresses from here, and download any files that have been uploaded. You can change your
username and password, and can view overall stats on the files that have been uploaded.

### File Management Operations
On the navigation bar at the top, select **File Management** to get to the file management page.

### File Operations
Delete a file, by selecting it and pressing Delete File. You will be asked if you are sure.

![Deleting Files](docs/images/deletefile.png)
![Deleting Files](https://waifuvault.moe/f/1709504564466/DeleteFile.png)

Download a file, by selecting it and pressing Download File.

![Downloading Files](docs/images/downloadfile.png)
![Downloading Files](https://waifuvault.moe/f/1709504647173/DownloadFile.png)

Details on a file, by selecting it and pressing Details. The longer fields have copy buttons on them in the details
panel.

![File Details](https://waifuvault.moe/f/1709504743287/FileDetails.png)

### IP Operations
Ban an IP by selecting the file and pressing Ban IP, then confirming you want to ban it and if you want to delete
related files.

![Banning IP Address](docs/images/banipdelete.png)
![Banning IP Address](https://waifuvault.moe/f/1709504936554/BanIP.png)

Unban an IP by selecting the IP in the lower table and pressing Un Ban, then confirming you want to unban.

![Unban IP Address](docs/images/unbanip.png)
![Unban IP Address](https://waifuvault.moe/f/1709504995039/UnBanIP.png)

### Statistics

On the navigation bar at the top, select **Statistics** to get to the statistics page.

This page shows overall statistics for the files uploaded to the site:
* Total Number of Files Uploaded
* Total Size of Files Uploaded
* File Size Distribution of Files Uploaded
* Top 10 Media Types of Files Uploaded
* File Protection Level Distribution

![Statistics](https://waifuvault.moe/f/1709505507674/Stats.png)

### User Account Operations

### Account Operations
On the navigation bar at the top, select **User** to get to the user account control page.

Click on Change Details to alter the login information for your account.
You can change the username and password from here.

![Change Account Details](docs/images/changedetails.png)
![Change Account Details](https://waifuvault.moe/f/1709505880404/UserControl.png)

## REST Endpoints
All application functionality is provided by a set of REST endpoints.
Expand Down
Binary file removed docs/images/banip.png
Binary file not shown.
Binary file removed docs/images/banipdelete.png
Binary file not shown.
Binary file removed docs/images/changedetails.png
Binary file not shown.
Binary file removed docs/images/deletefile.png
Binary file not shown.
Binary file removed docs/images/downloadfile.png
Binary file not shown.
Binary file removed docs/images/unbanip.png
Binary file not shown.

0 comments on commit 4de015f

Please sign in to comment.