Skip to content

Commit 22c0d01

Browse files
committed
Update docs
1 parent 66b1e44 commit 22c0d01

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

docs/features.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Self-Host Ready File Hoster
2+
3+
This repository contains a self-hosted file hosting solution that offers a wide range of features for secure and convenient file management.
4+
5+
## Features
6+
- **Configurability**: Modify specific server options and properties without the need to touch the code, Hdrop provides a list of configurable options for tailoring the file hoster to your specific needs.
7+
- **Minimal Data Collection**: The server does not require user accounts, does not store passwords, and avoids unnecessary metadata on the servers.
8+
- **Multiple Storage Options**: Choose between local storage hosting or seamless integration with S3-compatible storage providers.
9+
- **End-to-End Encryption (E2EE)**: Ensure security with encryption applied both at rest and during transit, protecting your files end-to-end.
10+
- **Web Crypto API Integration**: Utilize the Web Crypto API to leverage cryptographic primitives for enhanced security and data integrity.
11+
- **Automated Secure Password/Key Generation**: Generate strong and secure passwords/keys automatically, eliminating the need for manual key management.
12+
- **Full Backend and UI Frontend**: Benefit from a complete solution that includes both a rust backend for file management and a nextjs UI frontend for easy interaction.
13+
- **Metrics with Prometheus**: Monitor and analyze system performance and usage statistics using Prometheus.
14+
- **Extensive Logging/Tracing**: Gain valuable insights into system operations through comprehensive logging and tracing capabilities, facilitating troubleshooting and auditing.
15+
- **Protection Against Unauthorized Downloads**: Implemented safeguards to prevent unauthorized downloads by requiring the correct password.
16+
- **Direct Accessibility of Content**: Enables users to directly access and view downloaded content, such as text files, images, and videos, directly in their browsers.
17+
18+
Refer to the repository documentation and guides for detailed instructions on deploying and configuring Hdrop.

docs/metrics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Metrics
2-
> Prometheus metrics are exposed on the `/v1/metrics` endpoint.
2+
> Prometheus metrics are exposed on the `/metrics` endpoint.
33
44
| Metric | Type | Description |
55
| -------------------------------- | ----------- | -------------------------------------------------------- |

0 commit comments

Comments
 (0)