diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index a5c92c99..e5eea5b2 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -16,9 +16,7 @@ jobs: - uses: actions/checkout@v3 - name: Build run: cargo build --verbose + - name: Check + run: cargo check --verbose - name: Clippy - run: cargo clippy -- -W clippy::pedantic -W warnings - - name: Run tests - run: cargo test --tests --lib --verbose - - name: Run doctests - run: cargo test --package rencfs --doc --verbose + run: cargo clippy --all-features --verbose diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 00000000..3cfd18bd --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,24 @@ +name: test + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +env: + CARGO_TERM_COLOR: always + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Check + run: cargo check --verbose + - name: Run tests + run: cargo test --tests --lib --verbose + - name: Run doctests + run: cargo test --package rencfs --doc --verbose diff --git a/README.md b/README.md index 9fa0bd49..542203e4 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ # RencFs -An encrypted file system that mounts with FUSE on Linux. It can be used to create encrypted directories. - -You can then safely backup the encrypted folder on an untrusted server without worrying about the data being exposed. -You can also store it in any cloud storage like Google Drive, Dropbox, etc. and have it synced across multiple devices. - [![rencfs-bin](https://img.shields.io/aur/version/rencfs-bin?color=1793d1&label=rencfs-bin&logo=arch-linux)](https://aur.archlinux.org/packages/rencfs-bin/) [![crates.io](https://img.shields.io/crates/v/rencfs.svg)](https://crates.io/crates/rencfs) [![docs.rs](https://img.shields.io/docsrs/rencfs?label=docs.rs)](https://docs.rs/rencfs/) -[![check](https://github.com/radumarias/rencfs/actions/workflows/test.yml/badge.svg)](https://github.com/radumarias/rencfs/actions/workflows/check.yml) +[![check](https://github.com/radumarias/rencfs/actions/workflows/check.yml/badge.svg)](https://github.com/radumarias/rencfs/actions/workflows/check.yml) +[![test](https://github.com/radumarias/rencfs/actions/workflows/test.yml/badge.svg)](https://github.com/radumarias/rencfs/actions/workflows/test.yml) [![Discord](https://img.shields.io/discord/1236855443486277653)](https://discord.com/channels/1236855443486277653/1236855448515252306) [![](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://rencfs.zulipchat.com) > ⚠️ **Warning** > ***This is early in development. Please do not use it with sensitive data just yet. Please wait for a -stable release. +stable release. > It's mostly ideal for experimental and learning projects.*** +An encrypted file system that mounts with FUSE on Linux. It can be used to create encrypted directories. + +You can then safely backup the encrypted folder on an untrusted server without worrying about the data being exposed.\ +You can also store it in any cloud storage like Google Drive, Dropbox, etc. and have it synced across multiple devices. + # Functionality -I keeps all encrypted data and master encryption key in a dedicated directory with files structured on inodes (with meta +It keeps all encrypted data and master encryption key in a dedicated directory with files structured on inodes (with meta info), files for binary content and directories with files/directories entries. All data, metadata and also filenames are encrypted. For new files it generates inode number randomly in `u64` space so it reduces the chance of conflicts when used offline and synced later. diff --git a/_config.yml b/_config.yml new file mode 100644 index 00000000..ed40ee21 --- /dev/null +++ b/_config.yml @@ -0,0 +1,5 @@ +title: Rencfs homepage +#description: +theme: pages-themes/hacker@v0.2.0 +plugins: +- jekyll-remote-theme