Skip to content

Commit a618d36

Browse files
authored
Update readme to reflect new config variables
1 parent dca3268 commit a618d36

File tree

1 file changed

+37
-14
lines changed

1 file changed

+37
-14
lines changed

README.md

+37-14
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Scan-to-SMB1 #
22

3-
[
4-
![](https://img.shields.io/docker/v/jandi/scan-to-smb1?sort=semver)
5-
![](https://img.shields.io/docker/pulls/jandi/scan-to-smb1)
6-
![](https://img.shields.io/docker/stars/jandi/scan-to-smb1)
7-
![](https://img.shields.io/docker/image-size/jandi/scan-to-smb1)
8-
![](https://img.shields.io/docker/cloud/build/jandi/scan-to-smb1)
9-
](https://hub.docker.com/repository/docker/jandi/scan-to-smb1)
3+
[![](https://img.shields.io/docker/v/jandi/scan-to-smb1?sort=semver)](https://hub.docker.com/r/jandi/scan-to-smb1/tags)
4+
[![](https://img.shields.io/docker/pulls/jandi/scan-to-smb1)](https://hub.docker.com/r/jandi/scan-to-smb1)
5+
[![](https://img.shields.io/docker/stars/jandi/scan-to-smb1)](https://hub.docker.com/r/jandi/scan-to-smb1)
6+
[![](https://img.shields.io/docker/image-size/jandi/scan-to-smb1)](https://hub.docker.com/r/jandi/scan-to-smb1)
7+
[![](https://img.shields.io/docker/cloud/build/jandi/scan-to-smb1)](https://hub.docker.com/r/jandi/scan-to-smb1/builds)
108

119
This container is used to proxy an existing secure smb share (version 2+) to allow legacy scanning devices, that only support cifs/smb v1 the access to a specific share or folder on the secure share - without downgrading the complete server to smb v1. Its designed to forward all files to the secure share, without overwriting files on the destination
1210

@@ -27,13 +25,20 @@ services:
2725
TZ: 'Europe/Berlin'
2826
USERID: 1000
2927
GROUPID: 1000
30-
PROXY_SHARE: legacyshare
31-
PROXY_USERNAME: user
32-
PROXY_PASSWORD: password
33-
SERVER_SHARE: //secure-host/share/path/to/folder
34-
SERVER_DOMAIN: DOM
35-
SERVER_USERNAME: User
36-
SERVER_PASSWORD: password
28+
SAMBA_USERNAME: scanuser
29+
SAMBA_PASSWORD: secret1
30+
PROXY1_ENABLE: 1
31+
PROXY1_SHARE_NAME: scanshare10
32+
PROXY1_REMOTE_PATH: //secure-host/share/path/to/folder
33+
PROXY1_REMOTE_DOMAIN: DOM
34+
PROXY1_REMOTE_USERNAME: UserA
35+
PROXY1_REMOTE_PASSWORD: password
36+
PROXY2_ENABLE: 1
37+
PROXY2_SHARE_NAME: scanshare30
38+
PROXY2_REMOTE_PATH: //other-host/share
39+
PROXY2_REMOTE_DOMAIN: DOM
40+
PROXY2_REMOTE_USERNAME: UserB
41+
PROXY2_REMOTE_PASSWORD: password
3742
ports:
3843
- "445:445/tcp"
3944
tmpfs:
@@ -43,3 +48,21 @@ services:
4348
tty: true
4449
privileged: true
4550
```
51+
52+
## Config ##
53+
54+
The configuration is done via environment variables:
55+
56+
- `TZ`: Timezone
57+
- `USERID`: Linux User ID
58+
- `GROUPID`: Linux Group ID
59+
- `SAMBA_USERNAME`: Global Username for the created shares
60+
- `SAMBA_PASSWORD`: Global Password for the created shares
61+
- `PROXYx_ENABLE`: 0 = disabled, 1 = enabled
62+
- `PROXYx_SHARE_NAME`: Samba Share name
63+
- `PROXYx_REMOTE_PATH`: Can be just a share (//host/share) or a complete path (//host/share/path/to/folder)
64+
- `PROXYx_REMOTE_DOMAIN`: Domain for remote path (optional)
65+
- `PROXYx_REMOTE_USERNAME`: Username for remote path
66+
- `PROXYx_REMOTE_PASSWORD`: Password for remote path
67+
68+
You can substitute x with an incremented number starting at 1 to create multiple entries. See example configuration.

0 commit comments

Comments
 (0)