Skip to content

Commit bbe3ca9

Browse files
committed
Update README.md for version 1.0.2
1 parent 3900ef1 commit bbe3ca9

1 file changed

Lines changed: 38 additions & 2 deletions

File tree

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@ Sqlar: Stores files in a SQLite database, see [sqlar](https://sqlite.org/sqlar.h
1919

2020
S3: Stores files in an S3 compatible storage.
2121

22+
RocksDB: Stores files in a RocksDB database, see [rocksdb](https://rocksdb.org/) for more information.
23+
2224
### Features
2325

2426
- File de-duplication based on content
2527
- File encryption with AES-256-GCM
28+
- File compression with gzip
2629
- Metadata sqlite database that can be queried with SQL
2730
- File name mangling with the content SHA512 hash
2831

@@ -70,13 +73,46 @@ innerfs export-files --path ./output --format zip
7073
Will export all files in the filesystem to the specified path in the specified format. Supports `zip`, `tar`
7174
and `directory`.
7275

76+
- Stats
77+
78+
```bash
79+
innerfs stats
80+
```
81+
82+
Will print a JSON file with statistics about the filesystem, number of files, directories, sizes, etc.
83+
84+
- Verify integrity
85+
86+
```bash
87+
innerfs verify
88+
```
89+
90+
Will verify the integrity of the filesystem, checking the metadata database and the file contents.
91+
7392
### Configuration
7493

7594
The default configuration file contains comments that explain the options, can be seen [here](./src/default_config.yml).
7695

96+
### Installation
97+
98+
You can download the latest release from the [releases page](https://github.com/cout970/InnerFS/releases) or build from
99+
source using `cargo build --release` on a copy of the repo.
100+
101+
It is necessary to have FUSE installed, it is usually available in the package manager of most distributions named '
102+
fuse' or 'fuse3'.
103+
104+
### Limitations
105+
106+
- The filesystem is not fully POSIX compliant, some operations may not work as expected: append, fallocate, symlinks,
107+
hardlinks, etc.
108+
- If the database file is lost, the access to the files could be lost, for example, if encryption is enabled, the key
109+
salt and nonce are stored in the database.
110+
- Performance will be worse than a traditional filesystem, as every operation is done in a single thread.
111+
- Files will be fully loaded in memory for read/write operations, so be careful with huge files.
112+
77113
### Planned features
78114

79-
- [ ] File compression
80-
- [ ] File verification
115+
- [x] File compression
116+
- [x] File verification
81117
- [ ] Sync between instances
82118
- [ ] Encryption of the metadata database

0 commit comments

Comments
 (0)