Skip to content

Commit b19eb33

Browse files
committed
docs: add Docker Compose example, add better information on updating using the Deployer
1 parent 43ddccc commit b19eb33

2 files changed

Lines changed: 35 additions & 7 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
> [!IMPORTANT]
44
> This project is in active development. **Expect bugs.**
55
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.
711

812
## Installation
913

@@ -17,7 +21,24 @@ Download the latest Filen Relay Deployer from the [release page](https://github.
1721
docker run -e FILEN_RELAY_ADMIN_EMAIL='your-filen-account@email.com' -e FILEN_RELAY_DB_DIR='/usr/app/data' -v /some/host/path:/usr/app/data -p 80:80 ghcr.io/filenclouddienste/filen-relay:latest
1822
```
1923

20-
Configuration options (choose one):
24+
Two ways to configure (choose one):
2125
- Set options (or environment variables) `--admin-email` (`FILEN_RELAY_ADMIN_EMAIL`) and `--db-dir` (`FILEN_RELAY_DB_DIR`) to create a normal deployment.
2226
- 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.
2327
- 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:
31+
```yaml
32+
# compose.yaml
33+
services:
34+
filen-relay:
35+
image: ghcr.io/filenclouddienste/filen-relay:<version>
36+
restart: always
37+
environment:
38+
FILEN_RELAY_ADMIN_EMAIL: "<admin email>"
39+
FILEN_RELAY_DB_DIR: "/data"
40+
ports:
41+
- "<host port>:80"
42+
volumes:
43+
- ./filen-relay-data:/data
44+
```

filen-relay-deployer/src/scaleway/mod.rs

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -197,11 +197,18 @@ The Organization ID can be found on the same page.",
197197
"https://console.scaleway.com/containers/namespaces/{}/{}/containers/{}",
198198
region, namespace.id, container.id
199199
);
200-
cliclack::log::success(format!(
201-
"Deployed Filen Relay to Scaleway!\nView it in the Scaleway Console: {}\nFilen Relay soon available at: https://{}",
202-
console_url,
203-
container.domain_name
204-
))?;
200+
cliclack::log::success("Deployed Filen Relay to Scaleway!")?;
201+
cliclack::log::remark(format!("View it in the Scaleway Console:\n{}", console_url))?;
202+
cliclack::log::remark(format!(
203+
"Your Filen Relay will soon be available at:\nhttps://{}",
204+
container.domain_name
205+
))?;
206+
cliclack::note(
207+
"Install updates using the Deployer",
208+
"When you want to install an update, download the latest Filen Relay Deployer
209+
from https://github.com/FilenCloudDienste/filen-relay/releases/latest
210+
and execute it to update your existing container.",
211+
)?;
205212

206213
Ok(())
207214
}

0 commit comments

Comments
 (0)