Skip to content

Commit dda4d49

Browse files
committed
Update README.md for samples and bump version
1 parent 3f1c30f commit dda4d49

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

pyfilebrowser/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pyfilebrowser.main import FileBrowser # noqa: F401
66
from pyfilebrowser.squire import otp # noqa: F401
77

8-
version = "0.2.0"
8+
version = "0.2.1"
99

1010

1111
def _cli() -> None:

samples/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
### Server Configuration
1+
## Server Configuration
2+
Filebrowser's server configuration.
23

34
File source: `.config.env`
45

@@ -48,6 +49,7 @@ Configuration for list of the commands to be executed before or after a certain
4849
- **commands_before_upload** - List of commands to be executed before uploading a file.
4950

5051
#### Server
52+
Configuration for the server.
5153

5254
- **root** - The root directory for the server. Contents of this directory will be served.
5355
- **symlinks** - List of symlinks to be created in the root directory. Accepts file or directory paths.
@@ -66,6 +68,7 @@ Configuration for list of the commands to be executed before or after a certain
6668
- **tokenExpirationTime** - The token expiration time for the server.
6769

6870
#### Config
71+
Configuration for the user authentication.
6972

7073
- **signup** - Enable signup option for new users.
7174
- **createUserDir** - Auto create user home dir while adding new user.
@@ -76,10 +79,13 @@ Configuration for list of the commands to be executed before or after a certain
7679
- **rules** - This is a global set of allow and disallow rules. They apply to every user.
7780

7881
#### Auther
82+
Configuration for server security.
83+
7984
- **auth_recaptcha** - ReCaptcha settings for the server.
8085
- **auth_token** - The authenticator token for TOTP.
8186

82-
### User Profiles
87+
## User Profiles
88+
Configuration for user profiles.
8389

8490
File source: `.user*.env`
8591

@@ -97,22 +103,26 @@ File source: `.user*.env`
97103
- **hideDotfiles** - Default setting to hide dotfiles.
98104
- **dateFormat** - Default setting to set the exact date format.
99105

100-
### GitHub
106+
## GitHub
107+
Configuration to download the `filebrowser` executable from GitHub.
101108

102-
GitHub account information to download the ``filebrowser`` executable.
109+
File source: `.github.env`
103110

104111
- **owner** - GitHub account username or organization name.
105112
- **repo** - Repository name where the executable is stored in the releases.
106113
- **token** - GitHub account PAT.
107114
- **version** - Release version to download the asset.
108115

109-
### Extra (specific for [thevickypedia/filebrowser])
110-
116+
## Extra (specific for [thevickypedia/filebrowser])
111117
Extra configuration that needs to be added for the server.
112118

113-
### Proxy
119+
File source: `extra.yaml` or `extra.json`
114120

121+
## Proxy
115122
Proxy server configuration.
123+
124+
File source: `.proxy.env`
125+
116126
> Use proxy server only after reading [proxy-readme] and [proxy-runbook]
117127
118128
- **host**: The host address for the server.

0 commit comments

Comments
 (0)