You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,11 @@
3
3
> [!IMPORTANT]
4
4
> This project is in active development. **Expect bugs.**
5
5
6
-
Filen Relay provides a convenient way to serve your Filen Drive via HTTP/WebDAV/S3. Access the web interface to create shares mapping to multiple users, and manage basic permissions.
6
+
Filen Relay provides a convenient way to serve your Filen Drive via HTTP/WebDAV/S3.
7
+
-**Create shares** of **different directories**, which can be **read-only** and **password-protected**.
8
+
- Access shares via Web, **WebDAV** and **S3**.
9
+
-**Self-host** or deploy it to the cloud with an easy-to-use **deploy script** at **low cost**.
10
+
-**Admin interface** to manage which accounts can use your instance.
7
11
8
12
## Installation
9
13
@@ -17,7 +21,24 @@ Download the latest Filen Relay Deployer from the [release page](https://github.
- Set options (or environment variables) `--admin-email` (`FILEN_RELAY_ADMIN_EMAIL`) and `--db-dir` (`FILEN_RELAY_DB_DIR`) to create a normal deployment.
22
26
- Set `--admin-email` (`FILEN_RELAY_ADMIN_EMAIL`), `--admin-password` (`FILEN_RELAY_ADMIN_PASSWORD`) and `--admin-2fa-code` (`FILEN_RELAY_ADMIN_2FA_CODE`) if needed to create a deployment where data is stored in the admin's Filen drive. This is useful when the deployments needs to be stateless.
23
27
- You can also instead set `--admin-auth-config` (`FILEN_RELAY_ADMIN_AUTH_CONFIG`) to provide an auth config (containing email, password and API key), which was previously exported from the [Filen CLI](https://github.com/FilenCloudDienste/filen-cli-releases).
28
+
29
+
#### Example Docker Compose file
30
+
Make sure to replace the placeholders `<version>`, `<admin email>` and `<host port>` with your actual values:
0 commit comments