Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create info.md #169

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Create info.md #169

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa42e8d
Create info.md
mu-arch Jan 3, 2024
f1cb6e3
Update info.md
mu-arch Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Helpful Info for SecureFS users

This document covers random topics that may be of use to users of SecureFS.

## Remote Mounting Considerations

### GVFS incompatibility and solution

At this time SecureFS does not work with GVFS (GNOME Virtual File System), which is used in Ubuntu and other GNOME-based Linux distributions. Instead, install and use SSHFS which is confirmed to work.

### Remote mounting MacOS

MacOS has a low number of available file descriptors by default. When running SecureFS on Mac, this number is automatically raised. However, when remote mounting there is no way to automatically raise this, so it must be raised manually.

On your mac, run `launchctl limit maxfiles 8192 unlimited` (it doesn't persist across reboot) before you mount the sshfs volume. Or you can run this with ssh, exit it, and then mount sshfs.

### Other issues

In lite mode, files may appear to upload correctly, however an error spam of "Operation not permitted" may be printed to the console. This is because FUSE and SSHFS in particular all have problems mapping user ids. If it doesn't affect your usage, you can ignore these logs.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the help of improving the documentation. However, I prefer the doc to be more organized. I suggest that we remove the last two sections and rename the title from "Helpful Info for SecureFS users" to "Combination with other FUSE".

### Renaming the SecureFS meta file

You can rename the `.securefs.json` file however you like. You can even move it to another location. During mounting, specify the whole path of the file by `--config` option.

## Security Audits

SecureFS has not been formally audited for security.