Bitnami Alfresco

    Alfresco is an Enterprise Content Management (ECM) system featuring Document Management, Web Content Management, Collaboration Management, Records Management and Image Management. Alfresco Bitnami Stack ships the previous repository interface at "/alfresco" and the new one at "/share".

    Please, take a look to the Quick Start Guide to know the basic use of this Stack.

    How to start/stop the servers?

    Graphical tool

    The native installers include a graphical tool to manage the servers easily. You can find the "manager-windows.exe", "manager-osx" or "manager-linux" tool in your installation directory. Using this tool, you can Start, Stop or Restart the servers and check the log files. You can click on the icon to start it.

    manager-servers.png

     

    manager-osx.png

     

     

     

     

     

     

     

     

     


    win_platform.png

    On Windows: You can also start the Manager tool from shortcuts: Start -> Program Files -> Bitnami Stack -> Manager tool

    Command line tool

    If you prefer, you can use the "ctlscript.sh" utility from the command line. This script is in the installation directory.

    linux_platform.png

    On Virtual Machines and Cloud images:

    $ sudo /opt/bitnami/ctlscript.sh start

    A native installer on Linux:

    $ cd ~/application-version
    $ ./ctlscript.sh start
    

    mac_platform.png

     

    On OS X: You can start the Manager tool from the installation directory or you can use the "ctlscript.sh" utility from a Terminal.

    host:~ user$ cd /Applications/application-version
    host:~ user$ ./ctlscript.sh start

    How to create a full backup of Alfresco Stack?

    Backup

    Bitnami stacks are self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

    Cloud Server

    Follow these steps:

    • Place in the folder you want to save your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    • Restart all servers.
      $ sudo /opt/bitnami/ctlscript.sh start

    You should now download or transfer the application-backup.tar.gz file to a safe location.

    Virtual Machine

    Follow these steps:

    • Place in the folder you want to save your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    • Restart all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    You should now download or transfer the application-backup.tar.gz file to a safe location.

    Native Installer (Windows)

    Follow these steps:

    • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.
    • Create a compressed file with the stack contents. You can use a graphical tool like 7-Zip or WinZip.
    • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

    You should now download or transfer the application-backup.zip file to a safe location.

    Native Installer (Linux and Mac OS X)

    Follow these steps:

    • Place in the folder you want to save your backup
      cd /your/folder
    • Stop all servers.
      $ sudo installdir/ctlscript.sh stop
      
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf application-backup.tar.gz installdir
      
    • Restart all servers.
      $ sudo installdir/ctlscript.sh start
      

    You should now download or transfer the application-backup.tar.gz file to a safe location.

    Tabs end

    Restore

    Bitnami stacks are self-contained, so to restore a stack, you only need to uncompress the backup file in the same location. It is important to use the same path that was used when the stack was originally installed.

    Cloud Server

    Follow these steps:

    • Place in the folder where you have your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv /opt/bitnami /opt/bitnamiBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Virtual Machine

    Follow these steps:

    • Place in the folder where you have your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv /opt/bitnami /opt/bitnamiBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Native Installer (Windows)

    Follow these steps:

    • Uncompress the backup file to the original directory.
    • Install services by launching a new command prompt and executing the following commands. Administrator privileges are required.
      $ cd installdir
      $ serviceinstall.bat INSTALL
      

    You can now start or stop servers using the graphical manager tool.

    Native Installer (Linux and Mac OS X)

    Follow these steps:

    • Place in the folder where you have your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv installdir installdirBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
      
    • Start all servers.
      $ sudo installdir/ctlscript.sh start
      

    Tabs end

    IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as 'root', make sure that the restored files are owned by 'root'.


    If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

    How to upgrade Alfresco?

    It is strongly recommended to create a backup before starting the update process. If you have important data, create and try to restore a backup to ensure that everything works properly.

    There are two different ways to upgrade your application.

    • You can upgrade the application and all stack components, such as PHP, Ruby, MySQL and Apache.
    • You can upgrade the application only without modifying any other stack components.
      • Use the links provided in the application page on the wiki.

    How to change the default URL?

    This approach is based on the Bitnami Configuration Tool (bnconfig).

    Bitnami Cloud Hosting

    The best way to change your URL in BCH is to go to your application tab and modify it there. In the Bitnami Cloud Hosting console, select Servers, choose your server, Manage and go to the Applications tab. Press there the pencil next to the application which URL you want to modify and choose .

    Refer to this guide for more information.

    Cloud Images and Virtual Machines

    Moving the application to /

     If your application is running in "/alfresco" you can remove the prefix from the URL executing the following command:

    $ sudo /opt/bitnami/apps/alfresco/bnconfig --appurl /
    

    (use --help to check if that option is available for your application)

    Now you will be able to access to the application at http://YOUR_DOMAIN instead of http://YOUR_DOMAIN/alfresco.

    Updating the IP or hostname

    Some applications require to update the IP/domain if the machine IP/domain changes. The bnconfig tool also has an option which updates the IP automatically during boot, called machine_hostname (use --help to check if that option is available for your application). Note that this tool changes the URL to http://NEW_DOMAIN/alfresco

    sudo /opt/bitnami/apps/alfresco/bnconfig --machine_hostname NEW_DOMAIN
    

    If you already moved your application to the root URL you should include both options at the same time.

    sudo /opt/bitnami/apps/alfresco/bnconfig --appurl / --machine_hostname NEW_DOMAIN
    

    If you have configured your machine to use an static domain name or IP, you should rename or remove the "/opt/bitnami/apps/alfresco/bnconfig" file.

    sudo mv /opt/bitnami/apps/alfresco/bnconfig /opt/bitnami/apps/alfresco/bnconfig.disabled
    

    Native Installer

    Remember to use your actual installation directory instead of installdir.

    Moving the application to /

    If your application is running in "/alfresco" you can remove the prefix from the URL executing the following command:

    On Linux,

    installdir/apps/alfresco/bnconfig --appurl /
    

    On Mac OS X, 

    installdir/apps/alfresco/bnconfig.app/Contents/MacOS/installbuilder.sh --appurl /
    

    On Windows,

    installdir/apps/alfresco/bnconfig.exe --appurl /
    

    (use --help to check if that option is available for your application)

    Now you will be able to access to the application at http://YOUR_DOMAIN instead of http://YOUR_DOMAIN/alfresco.

    Updating the IP or hostname

    Some applications require to update the IP/domain if the machine IP/domain changes. The bnconfig tool also has an option which updates the IP , called machine_hostname (use --help to check if that option is available for your application). Note that this tool changes the URL to http://NEW_DOMAIN/alfresco.

    installdir/apps/alfresco/bnconfig --machine_hostname NEW_DOMAIN
    

    If you already moved your application to the root URL you should include both options at the same time.

    installdir/apps/alfresco/bnconfig --appurl / --machine_hostname NEW_DOMAIN
    

    Tabs end

    How to configure Java memory settings on Alfresco?

    These are the default memory settings for Java:

    JAVA_OPTS="-XX:MaxPermSize=512m -Xms256m -Xmx512m"
    

    You can increase these Java settings for you application if it is necessary. You can find them in the /installdir/apache-tomcat/bin/setenv.sh file for native installers for Linux and OS X. For Cloud Images you can find the Java memory settings in the /opt/bitnami/java/bitnami/setenv.sh.

    export JAVA_OPTS="-XX:MaxPermSize=256M -Xms256M -Xmx768M $JAVA_OPTS"

    IMPORTANT: This file is a symlink to a "micro-setenv.sh", "small-setenv.sh"...  depending on the instance type that you are currently using. The symlink will be automtically changed when you resize your server.

    For Windows you should modify the /installdir/apache-tomcat/bin/setenv.bat and reinstall the services.

    > cd installdir
    > serviceinstall.bat UNINSTALL
    > serviceinstall.bat INSTALL
    

    How to enable Google Docs integration with Alfresco?

    Since Bitnami Alfresco 4.2.c-1 version, you can easily enable Alfresco integration with Google Docs. Before you enable Google Docs integration, set up a Google Docs account that will be used for administrative purposes for the integration between Alfresco and Google Docs.

    It is only necessary to edit the "installdir/apache-tomcat/shared/classes/alfresco-global.properties" file and set the following options:

     

    # Enables Goggle Editable functionality set to true to enable
    googledocs.googleeditable.enabled=true
    
    # Google Docs system authentication credentials account Alfresco will use a tempt account 
    # for everyone
    googledocs.username=your_account@gmail.com
    googledocs.password=your_gmail_password
    
    # Google docs Application name
    googledocs.application.name=Alfresco ECM system
    
    # Google Docs URL
    googledocs.url=https://docs.google.com/feeds/default/private/full
    googledocs.downloadurl=https://docs.google.com/feeds/download
    
    # Google Docs Spreadsheet Service
    googledocs.spreadsheet.service.name=wise
    googledocs.spreadsheet.downloadurl=https://spreadsheet.google.com/feeds/download
    

    Then restart the Tomcat server:

    $ installdir/ctlscript.sh restart tomcat
    

    Once you have enabled it, create your own site in Alfresco application and open the "Document Library". In the "Create Content" option, you can create a Google Docs document and start to editing it.

    If you see an error similar to this:

    Error Message: 11260001 Failed to execute script 'classpath*:alfresco/site-webscripts/org/alfresco/components/googledocs/toolbar.get.js': 11260000 Error: Parameter "site" is missing.

    Maybe you are trying to create a google docs document in your repository directly. It is necessary to create an Alfresco site and create the Google Document in the "Document Library".

    How to install a plugin on Alfresco?

    Alfresco have package modules called AMPs which you can install on top of the basic installation.

    To install any AMP on top of the Bitnami Alfresco, you can follow the same steps that you can see to install Alfresco Records management Module.

    • Download alfresco-community-dod5015-3.4.d.zip and extract the files
       
    • Move the alfresco-community-dod5015-3.4.d.amp file to the amps directory. There are two directories depending on the AMP is for the "/alfresco" application or for the "/share" application. On Linux and Mac OS X you can execute:
      $ mv *.amp installdir/apps/alfresco/amps
      or
      $ mv *.amp installdir/apps/alfresco/amps_share

      You can use "sudo" if you are using the Virtual Machine or the Amazon Cloud Images.
       
    • Stop the Apache Tomcat server. You can use the Manager tool or the commands below.
      $ cd installdir
      $ ./ctlscript.sh stop tomcat
       
    • Run the apply_amps command, which is in the root Alfresco directory. On Windows execute the apply_amps.bat script. On Unix and Mac OS X you can execute the below.
      $ cd installdir/apps/alfresco
      $ ./apply_amps.sh

      You can use "sudo" if you are using the Virtual Machine or the Amazon Cloud Images. It is necessary to change the permissions of the new war files:

      $ sudo chown -R tomcat:tomcat /opt/bitnami/apache-tomcat/webapps

    • Start the Apache Tomcat server. You can use the Manager tool or the commands below.
      $ ./ctlscript start tomcat

    How to install SharePoint Protocol Support AMP?

    SharePoint Protocol Support allows you to edit documents in Alfresco using Microsoft Office. To install it, download the package from the Alfresco official site. When this guide was written, the Alfresco version was 4.2.f so we are going to use it in the examples.

    The steps described here use /opt/bitnami as installation directory. Use your own installation directory if you are using a native installed. The chown command is not needed in case you installed Alfresco as normal user.

    cd /home/bitnami
    wget http://dl.alfresco.com/release/community/4.2.f-build-00012/alfresco-community-spp-4.2.f.zip
    unzip alfresco-community-spp-4.2.f.zip
    sudo su
    cd /opt/bitnami
    ./ctlscript stop tomcat
    cp /home/bitnami/alfresco-community-spp-4.2.f.amp apps/alfresco/amps/
    cp /home/bitnami/alfresco-community-spp-4.2.f.amp apps/alfresco/amps_share/
    ./apps/alfresco/apply_amps.sh
    chown -R tomcat:tomcat apache-tomcat/webapps
    ./ctlscript.sh start tomcat
    exit
    

    With these commands, you have installed the SharePoint Protocol in you Alfresco Stack. The default port to use it is 7070. You can change it by editing the vti configuration files:

    /opt/bitnami/apache-tomcat/webapps/share/WEB-INF/classes/alfresco/module/org.alfresco.module.vti/context/vti.properties

    /opt/bitnami/apache-tomcat/webapps/alfresco/WEB-INF/classes/alfresco/module/org.alfresco.module.vti/context/vti.properties

    If you are using a Virtual Machine or a Cloud Image, you have to open the port.

    After that, you can access from any machine to the Alfresco SharePoint Module using a browser through

    http://YOUR_DOMAIN:7070/
    

    alfrescospmodulebrowser.png

    SharePoint Module main page

     

    Finally, you can open your Alfresco Files directly using Microsoft Word. Click Open and insert the URL in the File Name field.

     

    alfrescoword.png

    Opening Alfresco in Microsoft Word

    That's all, you have now your SharePoint Module up and running.

    How to configure the email settings of Alfresco?

    Outbound email configuration

    To send emails from Alfresco application via SMTP protocol, it is necessary to specify the SMTP settings in the installdir/apache-tomcat/shared/classes/alfresco-global.properties file. The following example shows how to configure Alfresco using a GMail account:

    ### SMTP Configuration ###
    
    mail.host=smtp.gmail.com                                                                       
    mail.port=465                                                                      
    mail.protocol=smtps                                                                                       
    mail.username=your_account@gmail.com                                                                     
    mail.password=your_password                                                                      
    mail.encoding=UTF-8                                                                                       
    mail.smtps.starttls.enable=true                                                          
    mail.smtps.auth=true
    

    Then, restart the Tomcat server:

    $ sudo installdir/ctlscript.sh restart tomcat
    Inbound email configuration

    To send emails to Alfresco using the SMTP protocol you'll have to specify the following parameters in  installdir/apache-tomcat/shared/classes/alfresco-global.properties file.

    win_platform.png On Windows 

    email.inbound.unknownUser=anonymous
    email.inbound.enabled=true
    email.server.enabled=true
    email.server.port=25
    email.server.domain=your_server_domain
    email.server.allowed.senders=.*
     

    linux_platform.png On Linux

    email.inbound.unknownUser=anonymous
    email.inbound.enabled=true
    email.server.enabled=true
    email.server.port=2025
    email.server.domain=your_server_domain
    email.server.allowed.senders=.*

    We configure the Tomcat server to use the "tomcat" user and not the root user for security reasons. The problem is that Tomcat does not have privileges to bind the 25 port, so you need to specify another port, 2025 for instance, and then create a port forwarding rule in your system to redirect all requests from 25 port to 2025 port. It is only necessary to run the following command:

    sudo iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 25 -j REDIRECT --to-port 2025
     
    You can check the iptables rules with this command:
    sudo iptables -t nat -L -n -v
     
    Check that you added port 25 in your firewall to have external access. Restart the alfresco application, this could take some time:
    sudo installdir/ctlscript.sh restart tomcat
     
     
    From another machine you can check that everything is ok using telnet:
    telnet your_host_name 25
     
    You can see something similar to this:
    Trying your_ip...
    Connected to your_host_name .
    Escape character is '^]'.
    220 your_server_domain ESMTP SubEthaSMTP 3.1.6
     

    How to enable CIFS and/or FTP for Alfresco?

    To enable CIFS in Alfresco it is necessary to open the 445 port. If you have installed the Native Stack you probably have access to that but if you are using the Virtual Appliance or the AMI it is necessary to open this port.

    This guide to know how to open a port in the Virtual Appliances firewall or this guide to open a port in Bitnami Cloud Hosting.

    The Virtual Machines and AMIs have an internal FTP server installed. You can also enable to access to it. In this case it is necessary to open the 21 port in the firewall and comment the following line in the /etc/vsftpd.conf file:

    #listen_address=127.0.0.1
    

    Then you can restart the vsftpd server:

    $ sudo service vsftpd restart
    

    How to configure a redirect for main page to /share?

    Alfresco runs in the "/share" URL by default. If you want to add a simple redirection from your main domain to the "/share" application, you can add the following at the beginning of the file in the "/opt/bitnami/apps/alfresco/conf/httpd-app.conf" file.

    Redirect / /share
    ....

    Then restart Apache server:

    sudo /opt/bitnami/ctlscript.sh restart apache
    
    Tag page (Edit tags)
    • No tags
    Pages that link here
    Page statistics
    83506 view(s), 31 edit(s) and 14032 character(s)

    Comments

    You must login to post a comment.