Skip to content

Commit 0c35390

Browse files
committed
more docs
1 parent 115d735 commit 0c35390

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

Readme.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,4 @@ The authentication can be acheived through one of the following methods:
3535

3636
You can refer to `frontend` as an application example, `lfss/api/connector.py` for more APIs.
3737

38-
By default, the service exposes all files to the public for `GET` requests,
39-
but file-listing is restricted to the user's own files.
40-
Please refer to [docs/Permission.md](./docs/permission.md) for more details on the permission system.
41-
42-
More can be found in the [docs](./docs) directory.
38+
More information can be found in the [documentation](https://menxli.github.io/lfss/).

docs/permission.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There are different access levels for different users, which determine what oper
77
- <span class="perm">admin/all</span>: all permissions including `GET`/`PUT`/`POST`/`DELETE` and listing directories.
88
- <span class="perm">write</span>: same as admin except for [directory configuration](./lfssdir.md) file.
99
- <span class="perm">read</span>: only `GET` permission and listing directories.
10-
- <span class="perm">none</span>: no permissions.
10+
- <span class="perm">none</span>: no permissions as above, but may have `GET` permission on files via direct link, depending on the file and path-owner's **permission** settings (refer to the [section below](#file-access-with-get-permission)).
1111

1212
:::info
1313
**directory** path ends with `/` and **file** does not end with `/`.

docs/server-intro.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@ Now the server is running at `http://localhost:8000`.
1313

1414
By default, the data will be stored in `.storage_data`.
1515
You can change the storage directory using the `LFSS_DATA` environment variable,
16-
more details can be found in [environment-variables](./environment-variables.md).
16+
more details can be found in [Environment variables](./environment-variables.md).
1717

1818
## Create a user
1919
Create a user using the following command:
2020
```bash
2121
lfss-user add <username> <password> --admin
2222
```
2323
This command will create an admin user, which can manage other users.
24-
More user management commands can be found in `lfss-user --help` and `lfss-user <subcommand> --help`.
24+
More sub commands can be found in `lfss-user --help` and `lfss-user <subcommand> --help`.
25+
Details on user management can be found in [User Management](./userman.md).
2526

2627
## Interact with the server
2728
Please refer to [Client-side tools](./client-intro.md) for more details on how to use the client CLI tools to interact with the server.

docs/virtual-user.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ This makes virtual users essentially "access keys" to some users' paths.
1111

1212
The virtual user always have a name starting with `.v-`,
1313
a typical virtual user name looks like `.v-{tag}-{id}`.
14-
The tag is used to identify the purpose of the virtual user, and the id is a unique random string.
14+
The tag is used to identify the purpose of the virtual user, and the id is a unique random string.
15+
16+
The virtual user is hidden from the user list by default.
17+
To list virtual users, you can use the `-a/--all` flag with the `lfss-user list` command.
1518

1619
To create a virtual user, you can use either the CLI command or the admin API. For example:
1720

0 commit comments

Comments
 (0)