Skip to content

Commit 3e67d0c

Browse files
committed
Update README.md and update sample for containerization
1 parent 4471d7b commit 3e67d0c

File tree

6 files changed

+73
-5
lines changed

6 files changed

+73
-5
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,20 @@ User profile's permissions are automatically set based on the `admin` flag set i
113113

114114
</details>
115115

116+
<details>
117+
<summary><strong>filebrowser binary/executable</strong></summary>
118+
119+
> `.github.env` - Loads GitHub config to download the `filebrowser` executable/binary.
120+
121+
</details>
122+
123+
<details>
124+
<summary><strong>filebrowser with docker</strong></summary>
125+
126+
> `.container.env` - Loads the docker env vars to run `filebrowser` in a Docker container.
127+
128+
</details>
129+
116130
> `.env` files can be placed in a dedicated directory, whose path can be set using the env var `SECRETS_PATH`
117131
> before importing `pyfilebrowser`
118132
@@ -126,7 +140,9 @@ root (current working directory)
126140
| ├ .config.env
127141
| ├ .github.env
128142
| ├ .proxy.env
129-
| └ .user.env
143+
| ├ .user1.env
144+
| ├ .user2.env
145+
| └ .container.env
130146
├ venv/
131147
└ main.py
132148
```

docs/README.html

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,14 @@ <h3><code class="docutils literal notranslate"><span class="pre">.env</span></co
137137
</div></blockquote>
138138
<p>Multiple user profiles can be loaded using <code class="docutils literal notranslate"><span class="pre">.user1.env</span></code>, <code class="docutils literal notranslate"><span class="pre">.user2.env</span></code> and so on.<br>
139139
User profile’s permissions are automatically set based on the <code class="docutils literal notranslate"><span class="pre">admin</span></code> flag set in the env-var <code class="docutils literal notranslate"><span class="pre">authentication</span></code></p>
140+
</details><details>
141+
<summary><strong>filebrowser binary/executable</strong></summary><blockquote>
142+
<div><p><code class="docutils literal notranslate"><span class="pre">.github.env</span></code> - Loads GitHub config to download the <code class="docutils literal notranslate"><span class="pre">filebrowser</span></code> executable/binary.</p>
143+
</div></blockquote>
144+
</details><details>
145+
<summary><strong>filebrowser with docker</strong></summary><blockquote>
146+
<div><p><code class="docutils literal notranslate"><span class="pre">.container.env</span></code> - Loads the docker env vars to run <code class="docutils literal notranslate"><span class="pre">filebrowser</span></code> in a Docker container.</p>
147+
</div></blockquote>
140148
</details><blockquote>
141149
<div><p><code class="docutils literal notranslate"><span class="pre">.env</span></code> files can be placed in a dedicated directory, whose path can be set using the env var <code class="docutils literal notranslate"><span class="pre">SECRETS_PATH</span></code>
142150
before importing <code class="docutils literal notranslate"><span class="pre">pyfilebrowser</span></code></p>
@@ -148,7 +156,9 @@ <h3><code class="docutils literal notranslate"><span class="pre">.env</span></co
148156
| ├ .config.env
149157
| ├ .github.env
150158
| ├ .proxy.env
151-
| └ .user.env
159+
| ├ .user1.env
160+
| ├ .user2.env
161+
| └ .container.env
152162
├ venv/
153163
└ main.py
154164
</pre></div>

docs/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,20 @@ User profile's permissions are automatically set based on the `admin` flag set i
113113

114114
</details>
115115

116+
<details>
117+
<summary><strong>filebrowser binary/executable</strong></summary>
118+
119+
> `.github.env` - Loads GitHub config to download the `filebrowser` executable/binary.
120+
121+
</details>
122+
123+
<details>
124+
<summary><strong>filebrowser with docker</strong></summary>
125+
126+
> `.container.env` - Loads the docker env vars to run `filebrowser` in a Docker container.
127+
128+
</details>
129+
116130
> `.env` files can be placed in a dedicated directory, whose path can be set using the env var `SECRETS_PATH`
117131
> before importing `pyfilebrowser`
118132
@@ -126,7 +140,9 @@ root (current working directory)
126140
| ├ .config.env
127141
| ├ .github.env
128142
| ├ .proxy.env
129-
| └ .user.env
143+
| ├ .user1.env
144+
| ├ .user2.env
145+
| └ .container.env
130146
├ venv/
131147
└ main.py
132148
```

docs/_sources/README.md.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,20 @@ User profile's permissions are automatically set based on the `admin` flag set i
113113

114114
</details>
115115

116+
<details>
117+
<summary><strong>filebrowser binary/executable</strong></summary>
118+
119+
> `.github.env` - Loads GitHub config to download the `filebrowser` executable/binary.
120+
121+
</details>
122+
123+
<details>
124+
<summary><strong>filebrowser with docker</strong></summary>
125+
126+
> `.container.env` - Loads the docker env vars to run `filebrowser` in a Docker container.
127+
128+
</details>
129+
116130
> `.env` files can be placed in a dedicated directory, whose path can be set using the env var `SECRETS_PATH`
117131
> before importing `pyfilebrowser`
118132

@@ -126,7 +140,9 @@ root (current working directory)
126140
| ├ .config.env
127141
| ├ .github.env
128142
| ├ .proxy.env
129-
| └ .user.env
143+
| ├ .user1.env
144+
| ├ .user2.env
145+
| └ .container.env
130146
├ venv/
131147
└ main.py
132148
```

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

samples/.container.env

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
DETACH=false
2+
NAME="pyfilebrowser"
3+
IMAGE="vickyliin/filebrowser"
4+
TAG="v2.49.0-release"
5+
CREDENTIALS='{"username": "admin", "password": "admin"}'
6+
DATA_VOLUME="/data"
7+
CONFIG_VOLUME="/config"
8+
DATA_MODE="ro"
9+
CONFIG_MODE="rw"
10+
RESTART="unless-stopped"

0 commit comments

Comments
 (0)