Skip to content

Commit e932281

Browse files
author
JojiiOfficial
committed
improve README.md
1 parent c329a9b commit e932281

File tree

2 files changed

+46
-1
lines changed

2 files changed

+46
-1
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
11
# DMM - DataManagerMount
2-
Mount your datamanager files into your filesystem
2+
Mount your datamanager files into your filesystem.
3+
4+
# Prerequisites
5+
1. A linux kernel with FUSE support
6+
2. A compiled [binary](https://github.com/DataManager-Go/DMM---DataManagerMount/releases).
7+
3. A vaild config and session. You can create one using the [cli client](https://github.com/DataManager-Go/DataManagerCLI)
8+
9+
# Get started
10+
You can mount your dataManager files into your local filesystem using `<dmount> mountPoint`. Thats it.<br>
11+
12+
### Opions
13+
`--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>
14+
`--debug` view more informations about the client server process<br>
15+
`--debug-fs` view logs for the mount process<br>
16+
17+
# Mapping
18+
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>
19+
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>
20+
The DmanagerFS supports that. This is one of the main differences between Filesystems like ext4 or NTFS and the DataManagerFS.<br>
21+
22+
#### The mapping:
23+
```bash
24+
MountPoint
25+
26+
├── default # The default namespace. Equal to <username>_default
27+
│   ├── all_files # all files in the default namespace
28+
│   │   ├── file_in_group1_and_ns_default
29+
│   │   ├── some other file
30+
│   │   ├── settings.json
31+
│   │   ├── Shortcuts
32+
│   │ ├── settings.json
33+
│   │ └── shareShortcuts
34+
│   ├── group1 # Group 1
35+
│   │   ├── file_in_group1_and_ns_default
36+
│   │   └── some other file
37+
│   ├── condig_files
38+
│   │   ├── settings.json
39+
│   │   └── Shortcuts
40+
│   └── Projects
41+
│   ├── settings.json
42+
│   └── shareShortcuts
43+
└── androidApps # androidApps namespace
44+
   └── all_files
45+
   └── Whatsapp.apk
46+
```

dmfs/fsGroup.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ func newGroupNode(namespace, group string) *groupNode {
4747

4848
return groupNode
4949
}
50+
5051
func (groupNode *groupNode) getRequestAttributes() libdatamanager.FileAttributes {
5152
// Don't send any group to get
5253
// all files without groups

0 commit comments

Comments
 (0)