Difference between revisions of "Using the fileServersNG Docker Images"

From FileSys.Org Wiki
Line 58: Line 58:
  
 
=== Using Environment Variables ===
 
=== Using Environment Variables ===
 +
The default configuration can be overridden using environment variables. As Alfresco fileServersNG is running in a Docker container it can use the privileged ports for the various file servers. The SMB server will use TCP port 445, the FTP server will use port 21 by default.
 +
 +
The following environment variables are used :-
 +
 +
{| class="wikitable"
 +
|-
 +
|scope="col"|'''Variable Name'''
 +
|scope="col"|'''Description'''
 +
|scope="col"|'''Default Value'''
 +
|-
 +
|FSNG_SMB_ENABLE
 +
|Enable the SMB server
 +
|true
 +
|-
 +
|FSNG_FTP_ENABLE
 +
|Enable the FTP server
 +
|false
 +
|-
 +
|FSNG_NFS_ENABLE
 +
|Enable the NFS server
 +
|false
 +
|-
 +
|FSNG_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
 +
|-
 +
|FSNG_LICENCE_PATH
 +
|Relative path of the JFileServer licence folder on the classpath
 +
|/license
 +
|-
 +
|}

Revision as of 11:02, 14 January 2019

The following Docker images are available that contain Alfresco server installations with the fileServersNG file servers subsystem deployed :-

Image Description
filesysorg/alfresco-fileserversng-v5 Alfresco 5.2 server with the fileServersNG subsystem deployed, using an embedded PostGreSQL database server, includes Share

The Docker images expose a web server on port 8080 and the JFileServer SMB server on port 445. The Alfresco web interface is available at http://localhost:8080/alfresco and the Share web interface is available at http://localhost:8080/share/'.

Configuring The fileServersNG Docker Image

The fileServersNG Docker image can be configured using a combination of volume mapping and environment variables. Volume mapping is required to persist the Alfresco server state when the container is stopped or removed. Environment variables are used to configure the fileServerNG subsystem.

Using Volume Mapping

The fileServerNG Docker image needs a number of paths mapping to the host system in order to persist the Alfresco state when the container is stopped/removed. This can be done by either mapping Docker image paths to host paths or using Docker volumes that are created using the command :-

docker volume create name

The following volume mappings are available :-

Image Path Description
/content The main Alfresco content store with the raw data files
/alfresco/alf_data The Alfresco database data tables, key store and SOLR data
/alfresco/tomcat/logs The Tomcat server logs including catalina.out
/alfresco/tomcat/shared/classes/license Location of the JFileServer licence file, required to enable the JFileServer Enterprise features

In the following examples where a host path is shown a Docker volume name could be used instead.

To run the fileServersNG Docker image with the Alfresco state persisted to folders on the host system, with local folders of /AlfrescoDocker/content, /AlfrescoDocker/alf_data and /AlfrescoDocker/logs :-

docker run -d --rm --name fsng -p 8080:8080 -p 445:445 -v /AlfrescoDocker/content:/content -v /AlfrescoDocker/alf_data:/alfresco/alf_data -v /AlfrescoDocker/logs:/alfresco/tomcat/logs
 filesysorg/alfresco-fileserversng-v5:latest

You should be able to monitor the Alfresco server startup via the catalina.out log file in the local folder, for example :-

tail -f /AlfrescoDocker/logs/catalina.out

The fileServersNG Docker image includes the JFileServer Enterprise code, a trial key is included. If you have your own JFileServer Enterprise key you will need to map an additional local folder that contains the jfileserver.lic licence file :-

docker run -d --rm --name fsng -p 8080:8080 -p 445:445 -v /AlfrescoDocker/content:/content -v /AlfrescoDocker/alf_data:/alfresco/alf_data -v /AlfrescoDocker/logs:/alfresco/tomcat/logs
 -v /AlfrescoDocker/licence:/alfresco/tomcat/shared/classes/license filesysorg/alfresco-fileserversng-v5:latest

Using Environment Variables

The default configuration can be overridden using environment variables. As Alfresco fileServersNG is running in a Docker container it can use the privileged ports for the various file servers. The SMB server will use TCP port 445, the FTP server will use port 21 by default.

The following environment variables are used :-

Variable Name Description Default Value
FSNG_SMB_ENABLE Enable the SMB server true
FSNG_FTP_ENABLE Enable the FTP server false
FSNG_NFS_ENABLE Enable the NFS server false
FSNG_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
FSNG_LICENCE_PATH Relative path of the JFileServer licence folder on the classpath /license