Difference between revisions of "Using JFileServer Enterprise From The Command Line"

From FileSys.Org Wiki
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
To run JFileServer Enterprise from the command line you first need to download the latest JFileServer Enterprise Kit zip file from [www.filesys.org/kits/jfileserver-enterprise/|here].
+
To run JFileServer Enterprise from the command line you first need to download the latest JFileServer Enterprise Kit zip file from [http://www.filesys.org/kits/jfileserver-enterprise/ here].
  
 
Unpack the JFileServer Enterprise Kit zip file into a new folder. You should now have a folder with the following files and folders :-
 
Unpack the JFileServer Enterprise Kit zip file into a new folder. You should now have a folder with the following files and folders :-
Line 29: Line 29:
 
   +- runsrv.bat
 
   +- runsrv.bat
 
   +- runsrv.sh
 
   +- runsrv.sh
 +
 +
The included scripts, runsrv.bat for Windows and runsrv.sh for Unix platforms, start JFileServer Enterprise using the main class ''org.filesys.app.EnterpriseFileServer''. The JFileServer Enterprise application requires a single command line parameter with the path to the XML configuration file.
  
 
== Using JFileServer Enterprise On Windows ==
 
== Using JFileServer Enterprise On Windows ==
On Windows the default JFileServer Enterprise configuration runs the SMB server using the native SMB port 445. In order for this not to clash with Windows using the same port a registry edit is needed. The JFileServer Enterprise kit includes the ''port445.reg'' file to switch off the Windows OS use of port 445. To apply the registry edit double click the ''port445.reg'' file, then restart Windows.
+
On Windows it is recommended to use the Docker image to run JFileServer Enterprise due to problems with the Windows OS already using the native SMB port 445. Details of how to use the JFileServer Enterprise Docker image is available [[Using the JFileServer Enterprise Docker Image|here]].
 
 
Switching off port 445 on Windows may have other side effects on the Windows host, an alternative way to run JFileServer Enterprise is by using the Docker images, details of how to use the Docker images are [[Using the JFileServer Enterprise Docker Images|here]].
 
 
 
Once the registry edit has been applied, use a terminal command line or shell and set the current working directory as the folder where you unpacked the JFileServer Enterprise kit zip file.
 
 
 
To start JFileServer Enterprise on Windows use the ''runsrv.bat'' batch file :-
 
 
 
runsrv
 
 
 
The default JFileServer Enterprise configuration will output debug logging to the console, on startup of the server you should see the following :-
 
 
 
Enterprise JFileServer starting, enter 'x' to shutdown server, 'r' to restart server ...
 
*** JFileServer Enterprise edition licenced to FileSys.Org (Evaluation/eval@filesys.org/5)
 
***  For version 1.*
 
***  Licence expires in 60 days, at Mon Mar 11 12:05:34 GMT 2019
 
Starting server SMB ...
 
[SMB] SMB Server JFILESRV starting
 
[SMB] Version 1.0.0, Java VM 25.152-b16, Windows, version 10
 
[SMB] Using authenticator org.filesys.server.auth.EnterpriseSMBAuthenticator, mode=USER
 
[SMB] Server timezone offset = 0hrs
 
[SMB] Dialects enabled = [SMB 2.002,SMB 2.210,SMB 2.ANY]
 
[SMB] Shares:
 
[SMB]  [JFILESHARE,DISK,,[./testShare]] [./testShare]
 
[SMB] Binding TCP-SMB session handler to address : ALL
 
[SMB] Request handler SMBRequestHandler_1 waiting for session ...
 
[SMB] Listening for connections on [SMB,TCP-SMB,ALL:445]
 
[SMB] Waiting for new connection ...
 
 
 
To stop the running JFileServer Enterprise enter ''x'' into the console and hit <Return>, the file server should shutdown within a few seconds, but may take up to a minute or so :-
 
 
 
x
 
Shutting server SMB ...
 
[SMB] SMB Server shutting down ...
 
[SMB] Packet pool at shutdown: [BufferLists: [Bufsize=256,Init=20,Max=100,Avail=20,Alloc=0,Stats=0/0/0] [Bufsize=4096,Init=20,Max=50,Avail=20,Alloc=0,Stats=0/0/0] [Bufsize=16384,Init=5,Max=50,Avail=5,Alloc=0,Stats=0/0/0]  [Bufsize=66000,Init=5,Max=50,Avail=5,Alloc=0,Stats=0/0/0] ]
 
Shutting server NetBIOS ...
 
[SMB] Closed session handler [SMB,TCP-SMB,ALL:445]
 
[SMB] Closed request handler, SMBRequestHandler_1
 
[SMB] Closed SMB request handler, SMBRequestHandler_1
 
NotifyChangeHandler thread exit
 
  
 
== Using JFileServer Enterprise on linux, macOS, Unix ==
 
== Using JFileServer Enterprise on linux, macOS, Unix ==
Line 122: Line 85:
 
Using a command line terminal or shell set your current working directory as the JFileServer directory.
 
Using a command line terminal or shell set your current working directory as the JFileServer directory.
  
JFileServer Enterprise requires a licence file to enable the Enterprise features, there is a time limited trial licence included in the JFileServer Enterprise kit in the''licence/'' folder. If you have purchased your own licence you should copy the licence file into the ''licence/'' folder, the default name for the licence file is ''jfileserver.lic''. The location and name of the licence file can be changed in the XML server configuration file.
+
JFileServer Enterprise requires a licence file to enable the Enterprise features, there is a time limited trial licence included in the JFileServer Enterprise kit in the ''licence/'' folder. If you have purchased your own licence you should copy the licence file into the ''licence/'' folder, the default name for the licence file is ''jfileserver.lic''. The location and name of the licence file can be changed in the XML server configuration file.
  
 
There is a default JFileServer Enterprise configuration file that configures the SMB server to use SMB2 and will share the ''testShare'' folder, which contains a single text file. For details on configuring JFileServer see [[Configuring JFileServer|here]].
 
There is a default JFileServer Enterprise configuration file that configures the SMB server to use SMB2 and will share the ''testShare'' folder, which contains a single text file. For details on configuring JFileServer see [[Configuring JFileServer|here]].

Latest revision as of 16:45, 14 January 2019

To run JFileServer Enterprise from the command line you first need to download the latest JFileServer Enterprise Kit zip file from here.

Unpack the JFileServer Enterprise Kit zip file into a new folder. You should now have a folder with the following files and folders :-

/jfileserver
 |
 +- /testShare
     |
     +- sharedFile.txt
 +- /lib
     |
     +- bcprov-jdk5on-1.48.jar
     +- hazelcast-3.10.1.jar
     +- jfileserver-1.1.1.jar
     +- jna-5.1.0.jar
     +- jna-platform-5.1.0.jar
 +- /licence
     +- README.txt
     +- jfileserver.lic
 +- /licencing
     +- BouncyCastle.txt
     +- Hazelcast.txt
     +- JFileServer.txt
     +- JNA.txt
 +- EULA.txt
 +- fileSrvConfig.xml
 +- fileSrvConfig-windows.xml
 +- port445.reg
 +- runsrv.bat
 +- runsrv.sh

The included scripts, runsrv.bat for Windows and runsrv.sh for Unix platforms, start JFileServer Enterprise using the main class org.filesys.app.EnterpriseFileServer. The JFileServer Enterprise application requires a single command line parameter with the path to the XML configuration file.

Using JFileServer Enterprise On Windows

On Windows it is recommended to use the Docker image to run JFileServer Enterprise due to problems with the Windows OS already using the native SMB port 445. Details of how to use the JFileServer Enterprise Docker image is available here.

Using JFileServer Enterprise on linux, macOS, Unix

On linux, macOS and Unix systems the default JFileServer Enterprise configuration runs the SMB server using native SMB but via the non-privileged port 1445, so that JFileServer Enterprise can be run using a normal user account. To run JFileServer Enterprise on port 445 would require running JFileServer Enteprise using the root user.

In order for SMB clients to be able to connect to the JFileServer SMB server when it is running on a non-privileged port we need to use the firewall to forward network packets from the default port of 445, that the client will connect to, to port 1445 that the JFileServer SMB server is listening on.

Setting Up Port Forwarding On Linux

On linux kernel firewall rules are used to forward network packets. The firewall rules are configured using the iptables command.

To enable forwarding of network traffic from port 445 to port 1445 :-

  • Enable network forwarding
echo 1 > /proc/sys/net/ipv4/ip_forward
  • Load the iptable_nat module
modprobe iptable_nat
  • Configure the firewall forwarding rule
iptables -F
iptables -t nat -F
iptables -P INPUT ACCEPT
iptables -P FORWARD ACCEPT
iptables -P OUTPUT ACCEPT
iptables -t nat -A PREROUTING -p tcp --dport 445 -j REDIRECT --to-ports 1445

Setting Up Port Forwarding On macOS

On more recent versions of macOS (10.10 onwards) the packet filter device is used to control forwarding of network packets. The packet filter is configured using the /etc/pf.conf file and associated files in the /etc/pf.anchors folder.

To enable forwarding of network traffic from port 445 to port 1445. :-

  • Edit the /etc/pf.conf file, add the lines in bold. You will need to run the editor using the sudo command.
#
# com.apple anchor point
#
scrub-anchor "com.apple/*"
nat-anchor "com.apple/*"
rdr-anchor "com.apple/*"
rdr-anchor "org.filesys"
dummynet-anchor "com.apple/*"
anchor "com.apple/*"

load anchor "com.apple" from "/etc/pf.anchors/com.apple"
load anchor "org.filesys" from "/etc/pf.anchors/org.filesys"
  • Create the org.filesys anchor file in the /etc/pf.anchors folder, add the following line :-
rdr pass on en0 inet proto tcp from any to any port 445 -> 127.0.0.1 port 1445
  • Enable the port 445 forwarding rules using :-
sudo pfctl -e -f /etc/pf.conf -v

Running JFileServer Enerprise

Using a command line terminal or shell set your current working directory as the JFileServer directory.

JFileServer Enterprise requires a licence file to enable the Enterprise features, there is a time limited trial licence included in the JFileServer Enterprise kit in the licence/ folder. If you have purchased your own licence you should copy the licence file into the licence/ folder, the default name for the licence file is jfileserver.lic. The location and name of the licence file can be changed in the XML server configuration file.

There is a default JFileServer Enterprise configuration file that configures the SMB server to use SMB2 and will share the testShare folder, which contains a single text file. For details on configuring JFileServer see here.

To start JFileServer Enteprise use the runsrv.sh script file :-

./runsrv.sh

The default JFileServer Enterprise configuration will output debug logging to the console, on startup of the server you should see the following :-

Enterprise JFileServer starting, enter 'x' to shutdown server, 'r' to restart server ...
*** JFileServer Enterprise edition licenced to FileSys.Org (Evaluation/eval@filesys.org/5)
***  For version 1.*
***  Licence expires in 60 days, at Mon Mar 11 12:05:34 GMT 2019
Starting server SMB ...
[SMB] SMB Server JFILESRV starting
[SMB] Version 1.0.0, Java VM 25.152-b16, OS Mac OS X, version 10.14.2
[SMB] Using authenticator org.filesys.server.auth.EnterpriseSMBAuthenticator, mode=USER
[SMB] Server timezone offset = 0hrs
[SMB] Dialects enabled = [SMB 2.002,SMB 2.210,SMB 2.ANY]
[SMB] Shares:
[SMB]  [JFILESHARE,DISK,,[./testShare]] [./testShare]
[SMB] Binding TCP-SMB session handler to address : ALL
[SMB] Request handler SMBRequestHandler_1 waiting for session ...
[SMB] Listening for connections on [SMB,TCP-SMB,ALL:1445]
[SMB] Waiting for new connection ...

To stop the running JFileServer enter x into the console and hit <Return>, the file server should shutdown within a few seconds, but may take up to a minute or so :-

x
Shutting server SMB ...
[SMB] SMB Server shutting down ...
[SMB] Packet pool at shutdown: [BufferLists: [Bufsize=256,Init=20,Max=100,Avail=20,Alloc=0,Stats=0/0/0] [Bufsize=4096,Init=20,Max=50,Avail=20,Alloc=0,Stats=0/0/0] [Bufsize=16384,Init=5,Max=50,Avail=5,Alloc=0,Stats=0/0/0]  [Bufsize=66000,Init=5,Max=50,Avail=5,Alloc=0,Stats=0/0/0] ]
Shutting server NetBIOS ...
[SMB] Closed session handler [SMB,TCP-SMB,ALL:1445]
[SMB] Closed request handler, SMBRequestHandler_1
[SMB] Closed SMB request handler, SMBRequestHandler_1
NotifyChangeHandler thread exit