Skip to content

Commit

Permalink
improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JojiiOfficial committed Apr 20, 2020
1 parent c329a9b commit e932281
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# DMM - DataManagerMount
Mount your datamanager files into your filesystem
Mount your datamanager files into your filesystem.

# Prerequisites
1. A linux kernel with FUSE support
2. A compiled [binary](https://github.com/DataManager-Go/DMM---DataManagerMount/releases).
3. A vaild config and session. You can create one using the [cli client](https://github.com/DataManager-Go/DataManagerCLI)

# Get started
You can mount your dataManager files into your local filesystem using `<dmount> mountPoint`. Thats it.<br>

### Opions
`--config` use a different configuration file, created by the [CLI client](https://github.com/DataManager-Go/DataManagerCLI) or [GUI client](https://github.com/DataManager-Go/DataManagerGUI)<br>
`--debug` view more informations about the client server process<br>
`--debug-fs` view logs for the mount process<br>

# Mapping
Since the way the datamanager stores your files is different than your Operating Systems fs does, the mapping between Dmanager and your OS filetree isn't that easy.<br>
The DManager is built to store files assigned to multiple folders (groups) and your FS (usually) allows to store a file in one folder only. In addition, you (usually) can't have multiple files with the same name in one folder.<br>
The DmanagerFS supports that. This is one of the main differences between Filesystems like ext4 or NTFS and the DataManagerFS.<br>

#### The mapping:
```bash
MountPoint
├── default # The default namespace. Equal to <username>_default
│   ├── all_files # all files in the default namespace
│   │   ├── file_in_group1_and_ns_default
│   │   ├── some other file
│   │   ├── settings.json
│   │   ├── Shortcuts
│   │ ├── settings.json
│   │ └── shareShortcuts
│   ├── group1 # Group 1
│   │   ├── file_in_group1_and_ns_default
│   │   └── some other file
│   ├── condig_files
│   │   ├── settings.json
│   │   └── Shortcuts
│   └── Projects
│   ├── settings.json
│   └── shareShortcuts
└── androidApps # androidApps namespace
   └── all_files
   └── Whatsapp.apk
```
1 change: 1 addition & 0 deletions dmfs/fsGroup.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ func newGroupNode(namespace, group string) *groupNode {

return groupNode
}

func (groupNode *groupNode) getRequestAttributes() libdatamanager.FileAttributes {
// Don't send any group to get
// all files without groups
Expand Down

0 comments on commit e932281

Please sign in to comment.