Difference between revisions of "Using the JFileServer Docker Images"
| Line 17: | Line 17: | ||
=== Using the filesysorg/jfileserver Docker Image === | === Using the filesysorg/jfileserver Docker Image === | ||
| − | The filesysorg/jfileserver Docker image contains a core JFileServer setup. The default setup enables the SMB server. The default configuration can be overridden using environment variables. Also the shared folder and the logs folder can be redirected to use host folders via volume mapping. | + | The filesysorg/jfileserver Docker image contains a core JFileServer setup. The default setup enables the SMB server. |
| + | |||
| + | To run the default JFileServer setup use the following command :- | ||
| + | |||
| + | docker run -d --rm --name jfileserver -p 445:445 filesysorg/jfileserver | ||
| + | |||
| + | The Docker image will be downloaded from the Docker hub if you have not already downloaded it. This will start a JFileServer running the SMB server on the native SMB port 445. On linux, macOS and other Unix systems you should be able to connect to the SMB file server by using the host name or IP address in the UNC path when mapping the shared drive path. For example, if the host IP address is 192.168.1.2 you would use a UNC path of '''\\192.168.1.2\jfileshare''' to map to the default shared path of the JFileServer, the username to use for the connection is '''jfilesrv''' with a password of '''java'''. | ||
| + | |||
| + | The default configuration can be overridden using environment variables. Also the shared folder and the logs folder can be redirected to use host folders via volume mapping. | ||
As the JFileServer is running in a Docker container it can use the default privileged ports for the various file servers. The SMB server will use TCP ports 139 and 445, and UDP ports 137 and 138, by default. The FTP server will use port 21 by default. | As the JFileServer is running in a Docker container it can use the default privileged ports for the various file servers. The SMB server will use TCP ports 139 and 445, and UDP ports 137 and 138, by default. The FTP server will use port 21 by default. | ||
Revision as of 13:57, 3 January 2019
There are a number of Docker images available with various configurations of the JFileServer. The following Docker images are available :-
| Image | Description |
| filesysorg/jfileserver | JFileServer file server configured with the SMB server enabled |
| filesysorg/jfileserver-db-postgres | JFileServer file server plus the PostGres database filesystem add-on |
| filesysorg/jfileserver-enterprise | JFileServer file server plus the Enterprise add-on to add support for SMB2 and SMB3 |
Using the filesysorg/jfileserver Docker Image
The filesysorg/jfileserver Docker image contains a core JFileServer setup. The default setup enables the SMB server.
To run the default JFileServer setup use the following command :-
docker run -d --rm --name jfileserver -p 445:445 filesysorg/jfileserver
The Docker image will be downloaded from the Docker hub if you have not already downloaded it. This will start a JFileServer running the SMB server on the native SMB port 445. On linux, macOS and other Unix systems you should be able to connect to the SMB file server by using the host name or IP address in the UNC path when mapping the shared drive path. For example, if the host IP address is 192.168.1.2 you would use a UNC path of \\192.168.1.2\jfileshare to map to the default shared path of the JFileServer, the username to use for the connection is jfilesrv with a password of java.
The default configuration can be overridden using environment variables. Also the shared folder and the logs folder can be redirected to use host folders via volume mapping.
As the JFileServer is running in a Docker container it can use the default privileged ports for the various file servers. The SMB server will use TCP ports 139 and 445, and UDP ports 137 and 138, by default. The FTP server will use port 21 by default.
The following environment variables are used :-
| Variable Name | Description | Default Value |
| JFSRV_SMB_ENABLE | Enable the SMB server | true |
| JFSRV_FTP_ENABLE | Enable the FTP server | false |
| JFSRV_NFS_ENABLE | Enable the NFS server | false |
| JFSRV_SMB_SERVERNAME | Name of the SMB server, for NetBIOS connections | jfilesrv |
| JFSRV_SMB_DOMAIN | Domain or workgroup that the SMB server belongs to | domain |
| JFSRV_SMB_DIALECTS | SMB dialects that the SMB server will negotiate | SMB1 |
| JFSRV_SMB_DEBUGFLAGS | SMB debug flags | Negotiate,Socket,State |
| JFSRV_FTP_PORT | Port that the FTP server listens on | 21 |
| JFSRV_FTP_DEBUGFLAGS | FTP debug flags | File,Search,Error,DataPort,Directory |
| JFSRV_NFS_DEBUGFLAGS | NFS debug flags | File,FileIO |
| JFSRV_SHARE_NAME | Shared filesystem name | jfileshare |
| JFSRV_SHARE_COMMENT | Comment for the shared filesystem | Test shared filesystem |
| JFSRV_DEBUG_OUTPUT | Debug output destination, 'File' or 'Console' | File |
| JFSRV_DEBUG_LOGPATH | Log file path when using 'File' debug output | /jfileserver/logs/jfileserver.log |
