Skip to content

Commit 0070527

Browse files
camelidJoshua Nelson
and
Joshua Nelson
committed
Update doc comment
Co-authored-by: Joshua Nelson <[email protected]>
1 parent c129c4e commit 0070527

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/db/file.rs

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
//! Simple module to store files in database.
22
//!
3-
//! docs.rs is generating more than 5 million files, they are small and mostly html files.
4-
//! They are using so many inodes and it is better to store them in database instead of
5-
//! filesystem. This module is adding files into database and retrieving them.
3+
//! docs.rs supports two ways of storing files: in a postgres database and in an S3 bucket.
4+
//! It does not support storing files on disk because of the sheer number of files:
5+
//! doing so would quickly run into file descriptor limits when running the web server.
6+
//!
7+
//! It's recommended that you use the S3 bucket in production to avoid running out of disk space.
8+
//! However, postgres is still available for testing and backwards compatibility.
69
710
use crate::error::Result;
811
use crate::storage::{CompressionAlgorithms, Storage};

0 commit comments

Comments
 (0)