diff --git a/docs/Administration.rst b/docs/Administration.rst index d04b7dce..a84c0ed3 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -61,6 +61,9 @@ Administering eXo Platform How to manage categories, portlets and gadgets, and introduction to management and monitoring gadgets in eXo Platform. + - :ref:`Managing News ` + How to manage News related pages and content. + - :ref:`Managing wallets ` How to manage users and spaces wallets. @@ -4574,6 +4577,72 @@ The Service Management page is displayed. To invoke a method of the selected service, click Run corresponding to it. After invoking it successfully, you will see the result returned if any. + + +.. _ManagingNews: + +============== +Managing News +============== + +How to display pinned News on a page +------------------------------------- + +The pinned articles are not highlighted by default in the platform (you can refer to +:ref:`this chapter ` to know more how pin function works). + +In order to display these pinned articles in a page, edit the page layout then add a "Content by query" application at the desired location. + +|image348| + +|image349| + +Once the application is added in the page, edit its settings and choose the folder path. + +|image350| + +Then you have to choose the appriopriate template from "Display Settings" tab of "Edit Mode" : + +- For the blog layout, select "NewsPin.gtmpl". +- For the latest News layout, select "LatestNews.gtmpl". + +|image351| + +Next, fill in the field "Header", this information will be displayed in the top left of the block. + +|image352| + +From advanced tab, fill in the following query in the field "By query" : + + *select * from exo:symlink where jcr:path like '/Application Data/News/Pinned/%' ORDER BY jcr:created DESC* + +Then select the page *News* > *Details* from the selector "Show in page" + +|image353| + +Then tick the checkbox "Restricted by user role" and click on "Save" button. + +Finally, from access permission tab, tick the checkbox "Everyone" then click on "Save and close" button. + +|image357| + +.. note:: An issue was detected in the 5.3 version for the display of pinned news for users who are not members of the post space. This issue is due to incompatibility between News and Web-pack Addons. +To work around the problem you can either uninstall Web-pack addon as explained :ref:`here ` or replace the exo:news view template as explained in the following section. + +Go to 'Administration > Content > Content Administration' then 'Templates > Documents'. + +|image354| + +From the Documents interface, click on 'edit' action for News template + +|image355| + +A popup "View & Edit Template" is displayed. Go to 'View' tab, click on the edit button of the existing 'View' +template then copy paste the template from the following +`link `__ in the content field and save the action. + +|image356| + .. _ManagingWallets: @@ -5560,5 +5629,13 @@ The following image shows the screen when an anonymous user accesses .. |image345| image:: images/managerewards/reward_details.png .. |image346| image:: images/managerewards/display_disabled_users.png .. |image347| image:: images/managerewards/search_bar.png - - +.. |image348| image:: images/sharenews/edit_layout.png +.. |image349| image:: images/sharenews/content_by_query.png +.. |image350| image:: images/sharenews/folder_path.png +.. |image351| image:: images/sharenews/template_selector.png +.. |image352| image:: images/sharenews/header_block.png +.. |image353| image:: images/sharenews/show_in_page.png +.. |image354| image:: images/sharenews/content_administration.png +.. |image355| image:: images/sharenews/news_template.png +.. |image356| image:: images/sharenews/view_tab.png +.. |image357| image:: images/sharenews/access_permission.png diff --git a/docs/Administration_eXo_JCR.rst b/docs/Administration_eXo_JCR.rst index a6f50d14..55430dee 100644 --- a/docs/Administration_eXo_JCR.rst +++ b/docs/Administration_eXo_JCR.rst @@ -24,8 +24,7 @@ Administration - :ref:`Performance tuning ` - Instructions on JBoss AS tuning, JCR cache tuning, Clustering, - JVM parameters, and Force query hints. + Instructions on JCR cache tuning, Clustering, JVM parameters, and Force query hints. .. _chapter-Administration-Connectors: @@ -45,9 +44,6 @@ Connectors Details of configuration parameters of FTP, such as command-port, data-min-port and data-max-port, system, and client-side-encoding. -- :ref:`JCA resource adapter ` - - Details of SessionFactory, configuration, and deployment. .. _JCR.WebDAV: @@ -657,118 +653,6 @@ FTP includes the following configuration parameters: Define the character that will be used to replace the forbidden characters. -.. _JCR.JCA: - -JCA resource adapter -~~~~~~~~~~~~~~~~~~~~~ - -.. note:: JCA is currently supported in eXo Platform JBoss bundle. - -JCR supports *J2EE Connector Architecture* 1.5, thus if you want to -delegate the JCR Session lifecycle to your application server, you can -use the JCA resource adapter for eXo JCR. This adapter only supports XA -Transaction, in other words you cannot use it for local transactions. -Since the JCR Sessions have not been designed to be shareable, the -session pooling is simply not covered by the adapter. - -**SessionFactory** - -The equivalent of the ``javax.resource.cci.ConnectionFactory`` in JCA -terminology is ``org.exoplatform.connectors.jcr.adapter.SessionFactory`` -in the context of eXo JCR. The resource that you will get thanks to a -JNDI lookup is of the ``SessionFactory`` type and provides the following -methods: - -.. code:: java - - /** - * Get a JCR session corresponding to the repository - * defined in the configuration and the default workspace. - * @return a JCR session corresponding to the criteria - * @throws RepositoryException if the session could not be created - */ - Session getSession() throws RepositoryException; - - /** - * Get a JCR session corresponding to the repository - * defined in the configuration and the default workspace, using - * the given user name and password. - * @param userName the user name to use for the authentication - * @param password the password to use for the authentication - * @return a JCR session corresponding to the criteria - * @throws RepositoryException if the session could not be created - */ - Session getSession(String userName, String password) throws RepositoryException; - - /** - * Get a JCR session corresponding to the repository - * defined in the configuration and the given workspace. - * @param workspace the name of the expected workspace - * @return a JCR session corresponding to the criteria - * @throws RepositoryException if the session could not be created - */ - Session getSession(String workspace) throws RepositoryException; - - /** - * Get a JCR session corresponding to the repository - * defined in the configuration and the given workspace, using - * the given user name and password. - * @param workspace the name of the expected workspace - * @param userName the user name to use for the authentication - * @param password the password to use for the authentication - * @return a JCR session corresponding to the criteria - * @throws RepositoryException if the session could not be created - */ - Session getSession(String workspace, String userName, String password) throws RepositoryException; - -**Configuration** - -+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *PortalContainer* | If no portal container can be found in the context of the request, the adapter will use the value of this parameter to get the name of the expected portal container to create the JCR sessions. This parameter is optional. By default, the default portal container will be used. | -+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Repository* | The repository name used to create JCR sessions. This parameter is optional. By default, the current repository will be used. | -+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - -**Deployment** - -Get/Download the JBoss bundle of eXo Platform 4 or higher. - -Go to the ``exo.jcr.connectors.jca`` folder, then run the -``mvn clean install -Pplatform`` command. - -Deploy -``exo.jcr.connectors.jca/target/exo.jcr.connectors.jca-1.15.x-GA.rar`` -in ``PLATFORM_JBOSS_HOME/standalone/deployments/``, then rename it to -``exo-jcr.rar``. - -Configure the resource adapter in -``PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` by -replacing: - -:: - - - -with - -:: - - - - - exo-jcr.rar - XATransaction - - - portal - repository - - - - - .. _chapter-Administration-Database: diff --git a/docs/Application.rst b/docs/Application.rst index dd4412ea..b4652ffa 100644 --- a/docs/Application.rst +++ b/docs/Application.rst @@ -188,26 +188,9 @@ Portlet deployment ~~~~~~~~~~~~~~~~~~~ The portlet *war* file should be installed into -``$PLATFORM_TOMCAT_HOME/webapps`` (in Tomcat) or -``$PLATFORM_JBOSS_HOME/standalone/deployments`` (in JBoss). - -**Particularly for JBoss**, you need to include a -``WEB-INF/jboss-deployment-structure.xml`` file to your portlet *war*, -to declare *platform.ear* as a dependency: - -.. code:: xml - - - - - - - - - -For more information, see `Master Your Portlet Packaging in JBoss article, `__. +``$PLATFORM_TOMCAT_HOME/webapps``. -Both Tomcat and JBoss support hot deployment. +eXo Platform server supports hot deployment. To test your portlet in action, you need to add it to a page. This task can be done in two ways: @@ -468,7 +451,7 @@ every page. **Redeploying a portlet** -Both Tomcat and JBoss support hot redeployment, so you can just replace +eXo Platform server supports hot redeployment, so you can just replace the old war with the new one and it should work. However, depending on the technology the portlet uses, the hot redeployment might not work properly. In this case, a server restart is required. @@ -1425,12 +1408,6 @@ The code sample can be found `here `__. -.. note:: Currently you could not use JSF together with CDI in Tomcat. This tutorial is for JBoss only. - - Also note that the deployment of this portlet does not follow :ref:`Portlet deployment ` - section completely, so do not miss the :ref:`deployment ` - part at the end of this tutorial. - **So why CDI?** If you want to get a quick understanding about CDI, and current @@ -1758,39 +1735,6 @@ For that, you will create two qualifiers, *Customer* and *Partner*. } } -.. _PLFDevGuide.DevelopingApplications.DevelopingPortlet.JSF2_CDI.Deployment-in-JBoss: - -**Deployment in eXo Platform JBoss** - -Your webapp needs to be scanned by Weld so you will not deploy it in -``standalone/deployments`` as other portlet applications. Instead, -deploy it into ``platform.ear`` and add a module in ``application.xml``. - -1. ``target/jsf2portlet-cdi-example.war`` into - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear``. - -2. Edit ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/META-INF/application.xml`` - to add a module like the following. The module must be added before - the **starter** module, so on top if you like that: - - .. code:: xml - - - - jsf2portlet-cdi-example.war - jsf2portlet-cdi-example - - - - Then follow the :ref:`Portlet deployment <#PLFDevGuide.DevelopingApplications.DevelopingPortlet.Deployment>` - section to register and add the portlet to a page for testing. - -.. note:: Starting from eXo Platform 5.0, we upgraded to JBoss EAP 7.0 which uses `Contexts and Dependency Injection (CDI) 1.2 `__. - CDI 1.2 comes with the new notion of implicit bean archive allowing - to scan war archives for annotations to process by Weld (the JBoss - implementation of CDI). This new feature has some conflicts with our - development and thus it has been disabled by default for eXo Platform EAR - including its addons. .. _PLFDevGuide.DevelopingApplications.DevelopingPortlet.PublicRenderParameter: @@ -2266,8 +2210,7 @@ development: - Juzu source code: https://github.com/juzu/juzu. -This tutorial focuses on Juzu portlet deployment in PRODUCT Tomcat and -JBoss. +This tutorial focuses on Juzu portlet deployment in eXo Platform. The dependencies are different for each server and each dependency injection implementation, so the project will use different Maven build @@ -2277,13 +2220,10 @@ profiles for packaging in each case: Tomcat using Guice. - Use ``mvn clean package -Pplf-jboss-guice`` to build a package for - JBoss using Guice. - Use ``mvn clean package -Pplf-tomcat-spring`` to build a package for Tomcat using Spring. -- Use ``mvn clean package -Pplf-jboss-spring`` to build a package for - JBoss using Spring. .. note:: Currently, only Guice and Spring are covered in this tutorial. The other implementation, Weld, will be documented later. @@ -2626,46 +2566,8 @@ Spring: 2.5.5 -Note that you can deploy this portlet using Guice in Tomcat and JBoss or -using Spring in Tomcat as usual. However, to deploy this portlet using -Spring in JBoss, the following dependencies are needed at runtime: - -- ``spring-beans-2.5.5.jar`` - -- ``spring-context-2.5.5.jar`` - -- ``spring-core-2.5.5.jar`` - -- ``spring-web-2.5.5.jar`` - -These dependencies have been already packaged in the generated -``hellojz.war`` file. Therefore you can choose to deploy this portlet -via the 2 following ways: - -- Copy these above dependencies from ``hellojz.war!/WEB-INF/lib/`` to - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/lib``, - then deploy this portlet as usual. - -- Deploy the ``hellojz.war`` file into - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/`` and - include it as the first module in the - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/META-INF/application.xml`` - file. The ``application.xml`` file will look like: - - .. code:: xml - - ... - plf-enterprise-jbosseap-ear - true - - - - hellojz.war - hello-portlet-sample - - - - ... +Note that you can deploy this portlet using Guice in Tomcat or +using Spring in Tomcat as usual. .. _PLFDevGuide.DevelopingApplications.DevelopingPortlet.Spring.Intro: @@ -2960,9 +2862,6 @@ requests to controllers. initialization of *DispatcherPortlet*. The goal is to define some beans at the application scope. -.. note:: Pay attention to the attribute *version="2.5"*. The version 2.5 or - greater is required. You should specify the version, otherwise it - might not work in JBoss package. 10. Edit ``applicationContext.xml``. @@ -3547,9 +3446,7 @@ Here are the steps to create your first gadget: 7. Install ``hello-gadget.war`` to: - - ``$PLATFORM_TOMCAT_HOME/webapps/`` for Tomcat. - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/`` for JBoss. + - ``$PLATFORM_TOMCAT_HOME/webapps/``. .. note:: See details about deployment in :ref:`portal extension section `, especially if you use the traditional extension with jar to be backward compatible. @@ -4533,10 +4430,7 @@ all source code of this tutorial 8. Build and deploy the ``.jar`` file (``target/wiki-activity-type-1.0.jar``) into eXo Platform package. - - ``$PLATFORM_TOMCAT_HOME/lib`` (in Tomcat) - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/lib`` (in - JBoss) + - ``$PLATFORM_TOMCAT_HOME/lib``. **Testing** @@ -5941,10 +5835,7 @@ component to the ``application/zip`` mimetype. 7. Put this ``.jar`` file into the eXo Platform package. - - ``$PLATFORM_TOMCAT_HOME/lib`` (in Tomcat). - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/lib`` (in - JBoss). + - ``$PLATFORM_TOMCAT_HOME/lib``. 8. Restart the server. The content of a ZIP file is now displayed as below: diff --git a/docs/Backup.rst b/docs/Backup.rst index 14c07928..cc503da4 100644 --- a/docs/Backup.rst +++ b/docs/Backup.rst @@ -78,9 +78,7 @@ Backup and Restore If you do not customize and configure eXo Platform, the whole data is located in one directory. So you just need to backup and restore the folder: -- ``$PLATFORM_TOMCAT_HOME/gatein/data`` (in Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/data/gatein`` (in JBoss). +- ``$PLATFORM_TOMCAT_HOME/gatein/data``. .. note:: The above locations are the default ones, you may have different path to the data folder which is shared and accessible by your sever node(s). @@ -93,7 +91,7 @@ restore file system data and DBMS tools to backup/restore SQL databases. The data folder contains these directories: - ``exoplatform-es``: it contains data indexed by Elasticsearch when it - is in :ref:`embedded mode <#PLFAdminGuide.Elasticsearch.ES_Embedded>`. + is in :ref:`embedded mode `. - ``files``: it contains :ref:`file storage ` data. @@ -117,13 +115,8 @@ The data folder contains these directories: File System Data ~~~~~~~~~~~~~~~~~ -You can check the data location in the customized configuration file: - -- In Tomcat, the file is ``$PLATFORM_TOMCAT_HOME/bin/setenv-customize`` - (``.sh`` for Linux and ``.bat`` for Windows). - -- In JBoss, it is ``$PLATFORM_JBOSS_HOME/bin/standalone-customize`` - (``.conf`` for Linux and ``.conf.bat`` for Windows). +You can check the data location in the customized configuration file: ``$PLATFORM_TOMCAT_HOME/bin/setenv-customize`` +(``.sh`` for Linux and ``.bat`` for Windows). Open the file and find *EXO\_DATA\_DIR*. This variable indicates the folder you need to backup or restore. As explained above, diff --git a/docs/Clustering.rst b/docs/Clustering.rst index f4fd4c89..6abf3e8e 100644 --- a/docs/Clustering.rst +++ b/docs/Clustering.rst @@ -131,17 +131,7 @@ Setting up eXo Platform cluster 6. Configure ``exo.cluster.node.name`` property. Use a different name for each node: - - In JBoss, edit this property in the ``standalone-exo-cluster.xml`` - file: - - .. code:: xml - - - - - - - - In Tomcat, add the property in ``setenv-customize.sh`` (.bat for + - Add the property in ``setenv-customize.sh`` (.bat for windows environments): - For windows: @@ -164,13 +154,8 @@ Setting up eXo Platform cluster 8. Configure CometD Oort URL. Replace *localhost* in the following examples with the IP or host name of the node. - - In JBoss, edit ``standalone-exo-cluster.xml``: - .. code:: xml - - - - - In Tomcat, edit ``exo.properties``: + - Edit ``exo.properties``: :: @@ -188,14 +173,8 @@ Setting up eXo Platform cluster from the default port (``5577``). The situation is likely to happen in a testing environment. - - In JBoss, edit ``standalone-exo-cluster.xml`` file: - - .. code:: xml - - - - - In Tomcat, edit ``exo.properties`` file: + - Edit ``exo.properties`` file: :: @@ -222,7 +201,7 @@ Setting up eXo Platform cluster node of this ``exo.properties`` is host1:port1, and that the cluster is composed of three nodes : host1, host2 and host3. -11. Only in Tomcat, configure the following: +11. Configure the following: - In ``setenv-customize.sh (.bat for Windows)``: @@ -243,26 +222,10 @@ Setting up eXo Platform cluster 12. Start the servers. **You must wait until node1 is fully started, then start node2.** - In JBoss, you need to indicate the configuration file with -c option: - ``./bin/standalone.sh -b 0.0.0.0 -c standalone-exo-cluster.xml`` - (.bat for Windows). - - Only in JBoss, some other options that you can use in the start command: - - - **-Dexo.cluster.node.name=a-node-name** overrides the node name - in the configuration file. - - - **-Djboss.socket.binding.port-offset=101** - - This is useful in case you set up nodes in the same machine for - testing. You will not need to configure the port for every node. - Just use a different port-offset in each start command. .. note:: If you run two nodes in the same machine for testing, change the default ports of node2 to avoid port conflict. + Ports are configured in ``conf/server.xml``. - In Tomcat, ports are configured in ``conf/server.xml``. - - In JBoss, use ``-Djboss.socket.binding.port-offset`` option mentioned above. To configure a front-end for your nodes, follow :ref:`Setting up Apache front-end `. @@ -312,13 +275,7 @@ understanding: for details. For LOCAL INDEXING, the index directory should be a local path for each -node. In JBoss it is set already by default: - -.. code:: xml - - - -But for Tomcat, you need to set it yourself, in ``exo.properties`` file: +node. You need to set it yourself, in ``exo.properties`` file: :: @@ -328,14 +285,8 @@ If you want to use a SHARED INDEX for every node: Enable the profile *cluster-index-shared*. -- In JBoss, edit - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo-cluster.xml``: - - .. code:: xml - - -- In Tomcat, edit ``setenv-customize.sh`` (.bat for Windows, see +- Edit ``setenv-customize.sh`` (.bat for Windows, see :ref:`Customizing environment variables `): :: @@ -345,14 +296,8 @@ Enable the profile *cluster-index-shared*. Set the index directory (``exo.jcr.index.data.dir``) to a network sharing path. -- In JBoss, edit - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo-cluster.xml``: - - .. code:: xml - - -- In Tomcat, if you do not configure it, ``exo.jcr.index.data.dir`` is +- If you do not configure it, ``exo.jcr.index.data.dir`` is already set to a sub-folder of the shared directory ``EXO_DATA_DIR``. It is done in ``setenv.*``: @@ -386,17 +331,8 @@ for the ``exo.properties`` file. To activate TCP default configuration files, enable the profile ``cluster-jgroups-tcp``: -- In JBoss, edit ``standalone-exo-cluster.xml``: - - .. code:: xml - - - ... - - ... - -- In Tomcat, edit ``setenv-customize.sh`` (.bat for Windows, see :ref:`Customizing environment variables `): +- Edit ``setenv-customize.sh`` (.bat for Windows, see :ref:`Customizing environment variables `): :: @@ -1276,9 +1212,7 @@ Only when the variables are not enough, or when migrating from previous version you want to re-use your JGroups configuration files, you will follow this section to activate your xml files. -1. Put your xml file somewhere, typically - ``standalone/configuration/gatein/jgroups/`` in JBoss and - ``gatein/conf/jgroups/`` in Tomcat. +1. Put your xml file somewhere, typically ``gatein/conf/jgroups/``. 2. Edit the following properties in ``exo.properties``: @@ -1288,8 +1222,7 @@ follow this section to activate your xml files. exo.jcr.cluster.jgroups.config-url=file:${exo.jcr.cluster.jgroups.config} exo.service.cluster.jgroups.config=${exo.conf.dir}/jgroups/jgroups-service.xml -In which ``exo.conf.dir`` is ``standalone/configuration/gatein`` in -JBoss and ``gatein/conf`` in Tomcat by default. +In which ``exo.conf.dir`` is ``gatein/conf`` by default. If you put your files somewhere else, pay attention that you must use an absolute path after "file:". diff --git a/docs/Configuration.rst b/docs/Configuration.rst index c3f087a0..92bc57bf 100644 --- a/docs/Configuration.rst +++ b/docs/Configuration.rst @@ -123,11 +123,6 @@ Configuration The configurations for users, groups and memberships initialization. - - :ref:`Gadget configuration ` - Information about the OAuth key that will be used in case the - OAuth gadgets do not indicate a key, and how to disable the - Shindig default online features. - - :ref:`Groovy templates statistics ` Parameter for enabling/disabling Groovy Templates statistics. @@ -200,12 +195,7 @@ simply do as follows: 1. Create your own ``.properties`` file that must be named ``exo.properties``. This file contains all configurations to be - customized. - - - ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` (Tomcat). - - - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - (JBoss). + customized: ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` A ``.properties`` file has no header, so you do not need to preserve the header. You can refer to ``exo-sample.properties`` that is provided by @@ -267,14 +257,10 @@ eXo Platform configuration In eXo Platform, almost all configurations are performed in a folder that is controlled by a system property named **exo.conf.dir**. This property is -set by ``setenv.*`` scripts (Tomcat) or ``standalone-exo-*.xml`` files -(JBoss). +set by ``setenv.*`` scripts. -The default value of **exo.conf.dir** is: +The default value of **exo.conf.dir** is: ``$PLATFORM_TOMCAT_HOME/gatein/conf``. -- ``$PLATFORM_TOMCAT_HOME/gatein/conf`` (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein`` (JBoss). That folder contains the following main files that you need to take care: ``exo.properties`` (if you need to override the eXo Platform @@ -1726,8 +1712,7 @@ Typically, the JCR File System data consists of four folders: - Swap data (temporary memory space). By default, these four folders are located under a common directory that -is ``$PLATFORM_TOMCAT_HOME/gatein/data`` (Tomcat), -``$PLATFORM_JBOSS_HOME/standalone/data/gatein`` (JBoss). +is ``$PLATFORM_TOMCAT_HOME/gatein/data``. In production, it is recommended to configure it to use a directory separated from the package. Especially in cluster mode, it should be a @@ -1746,24 +1731,6 @@ You need to create the script file by copying/renaming the sample ``bin/setenv-customize.sample.(sh|bat)``. See :ref:`Customizing environment variables ` for more information. -**Configuration in Platform JBoss** - -In JBoss, the directory is configured by the system property -``exo.data.dir``. Edit ``standalone/configuration/standalone-exo.xml`` -like below: - -.. code:: xml - - - ... - - ... - - -Note that if you are configuring the cluster mode, the configuration -might be different. The file should be ``standalone-exo-cluster.xml`` -and the property should be ``exo.shared.dir``. See :ref:`Setting up eXo Platform cluster `. - .. _AssetsVersionConf: ============================= @@ -2475,10 +2442,7 @@ not stopped successfully when you shut down eXo Platform, and it causes problem in your next start. So `download `__ the -following files and install them to the lib folder -(``$PLATFORM_TOMCAT_HOME/lib`` in Tomcat, -``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/lib`` in -JBoss: +following files and install them to the lib folder :``$PLATFORM_TOMCAT_HOME/lib`` - ``sigar.jar`` @@ -2715,16 +2679,6 @@ Both sizes could be defined through these properties: .. note:: The size is in MB for all the above properties. -.. warning:: If you are using eXo Platform in JBoss application server, note that in - addition to the parameters described above aiming to customize files - size, you should configure the value of the parameter - ``max-post-size`` in ``standalone/configuration/standalone-exo.xml`` - which is set by default to 200 MB in eXo Platform package. - - .. code:: xml - - - .. tip:: For any others file upload location, the maximum file size is defined by the property ``exo.uploadLimit``. .. code::xml @@ -2954,20 +2908,15 @@ By default, the logs are configured to: - log errors and warnings on the console. -- log ``$PLATFORM_TOMCAT_HOME/logs/platform.log`` (Tomcat), or - ``$PLATFORM_JBOSS_HOME/standalone/log/server.log`` (JBoss). +- log ``$PLATFORM_TOMCAT_HOME/logs/platform.log``. The logs are configured via the file: -- ``$PLATFORM_TOMCAT_HOME/conf/logging.properties`` (Tomcat). Please +- ``$PLATFORM_TOMCAT_HOME/conf/logging.properties``. Please refer to `Tomcat's Logging Documentation `__ for more information on how to adjust this file to your needs. -- ``$PLATFORM_JBOSS_HOME/standalone/configuration/logging.properties`` - (JBoss). - - .. _Configuration.JPA: ============================= @@ -3428,19 +3377,11 @@ The specific configuration of Portal caches can be found in the files: **i.** For **MOPSessionManager**, **NavigationService**, **DescriptionService**, **PageService**: -- ``$PLATFORM_TOMCAT_HOME/webapps/portal.war!/WEB-INF/conf/portal/portal-configuration.xml`` - (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/exo.portal.web.portal.war!/WEB-INF/conf/portal/portal-configuration.xml`` - (JBoss). +- ``$PLATFORM_TOMCAT_HOME/webapps/portal.war!/WEB-INF/conf/portal/portal-configuration.xml``. **ii.** For **TemplateService** and **ResourceBundle**: -- ``$PLATFORM_TOMCAT_HOME/webapps/platform-extension.war!/WEB-INF/conf/platform/cache-configuration.xml`` - (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/platform-extension-webapp.war!/WEB-INF/conf/platform/cache-configuration.xml`` - (JBoss). +- ``$PLATFORM_TOMCAT_HOME/webapps/platform-extension.war!/WEB-INF/conf/platform/cache-configuration.xml``. .. _Portal.MOPCache: @@ -3624,11 +3565,7 @@ file. The specific configuration of **SettingCache** can be found in the file: -- ``$PLATFORM_TOMCAT_HOME/lib/commons-component-common-X.Y.Z.jar!/conf/portal/configuration.xml`` - (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/lib/commons-component-common.jar!/conf/portal/configuration.xml`` - (JBoss). +- ``$PLATFORM_TOMCAT_HOME/lib/commons-component-common-X.Y.Z.jar!/conf/portal/configuration.xml``. .. _SettingCache: @@ -3753,18 +3690,11 @@ These properties are exposed via ``exo.properties`` for administrators. The full configuration can be found in XML configuration files. For SEO Cache, the file is: -- ``$PLATFORM_TOMCAT_HOME/webapps/ecm-wcm-extension.war!/WEB-INF/conf/wcm-extension/wcm/seo-configuration.xml`` - (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/ecms-packaging-wcm-webapp.war!/WEB-INF/conf/wcm-extension/wcm/seo-configuration.xml`` (JBoss). +- ``$PLATFORM_TOMCAT_HOME/webapps/ecm-wcm-extension.war!/WEB-INF/conf/wcm-extension/wcm/seo-configuration.xml``. For the other caches, the file is: -- ``$PLATFORM_TOMCAT_HOME/webapps/ecm-wcm-core.war!/WEB-INF/conf/wcm-core/core-services-configuration.xml`` - (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/ecms-core-webapp.war!/WEB-INF/conf/wcm-core/core-services-configuration.xml`` (JBoss). - +- ``$PLATFORM_TOMCAT_HOME/webapps/ecm-wcm-core.war!/WEB-INF/conf/wcm-core/core-services-configuration.xml``. .. _ECMS.WCMDriveCache: Drive Cache @@ -4035,11 +3965,8 @@ In particular: The specific configuration of each Social cache can be found in: -- ``$PLATFORM_TOMCAT_HOME/webapps/social-extension.war!/WEB-INF/conf/social-extension/social/cache-configuration.xml`` - (Tomcat). +- ``$PLATFORM_TOMCAT_HOME/webapps/social-extension.war!/WEB-INF/conf/social-extension/social/cache-configuration.xml``. -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/social-extension-war.war!/WEB-INF/conf/social-extension/social/cache-configuration.xml`` - (JBoss). .. _Social.identityCache: @@ -4323,11 +4250,8 @@ file. The specific configuration of each Forum cache can be found in: -- ``$PLATFORM_TOMCAT_HOME/webapps/forum-extension.war!/WEB-INF/ks-extension/ks/forum/cache-configuration.xml`` - (Tomcat). +- ``$PLATFORM_TOMCAT_HOME/webapps/forum-extension.war!/WEB-INF/ks-extension/ks/forum/cache-configuration.xml``. -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/forum-extension-webapp.war!/WEB-INF/ks-extension/ks/forum/cache-configuration.xml`` - (JBoss). .. _Forum.userProfileCache: @@ -4543,11 +4467,8 @@ In particular: The specific configuration of each Wiki cache can be found in: -- ``$PLATFORM_TOMCAT_HOME/lib/wiki-service-xxx.jar!/conf/portal/cache-configuration.xml`` - (Tomcat). +- ``$PLATFORM_TOMCAT_HOME/lib/wiki-service-xxx.jar!/conf/portal/cache-configuration.xml``. -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/lib/wiki-service.jar!/conf/portal/cache-configuration.xml`` - (JBoss). .. _Wiki.RenderingCache: @@ -4682,11 +4603,7 @@ You can change values of these Calendar caches in The specific configuration of each Calendar cache can be found in: -- ``$PLATFORM_TOMCAT_HOME/webapps/calendar-extension.war!/WEB-INF/cs-extension/cs/cs-configuration.xml`` - (Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/calendar-extension-webapp.war!/WEB-INF/cs-extension/cs/cs-configuration.xml`` - (JBoss). +- ``$PLATFORM_TOMCAT_HOME/webapps/calendar-extension.war!/WEB-INF/cs-extension/cs/cs-configuration.xml``. .. _Calendar.groupCalendarCache: @@ -4952,11 +4869,7 @@ However, the word "membership" is sometimes used with the meaning of Next you will learn the configurations of predefined users, groups and memberships which are written in: -- ``$PLATFORM_TOMCAT_HOME/webapps/platform-extension.war!/WEB-INF/conf/organization/organization-configuration.xml`` - (Tomcat) - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/platform-extension-webapp.war!/WEB-INF/conf/organization/organization-configuration.xml`` - (JBoss) +- ``$PLATFORM_TOMCAT_HOME/webapps/platform-extension.war!/WEB-INF/conf/organization/organization-configuration.xml``. This section does not directly aim at changing those predefined organizational data, but if it is the further step you want to go, you @@ -5068,84 +4981,6 @@ to *root* in :ref:`exo.properties ` file: -.. _Configuration.GadgetConfiguration: - -==================== -Gadget configuration -==================== - -Gadget configuration consists of OAuth key, Shindig properties, and -security token key. By default those configuration files are located at: - -- ``gatein/conf/gadgets`` for Tomcat. - -- ``standalone/configuration/gatein/gadgets`` for JBoss. - -To use your customized configuration files, it is recommended that you -replace default files in that location with yours. - -It is possible to change the location by pointing ``exo.conf.dir`` to -another folder. However, ``exo.conf.dir`` holds many configuration files -besides gadgets, so take care that you have those files in the new -folder. Also note that the folder of gadgets files will be -``${exo.conf.dir}/gadgets``. - -To change ``exo.conf.dir``: - -- In Tomcat: customize the variable - ``EXO_CONF_DIR=/path/to/your/folder`` (see :ref:`Customizing variables ` - for how-to). - -- In JBoss: edit the property ``exo.conf.dir`` in - ``standalone/configuration/standalone-exo.xml`` - (``standalone-exo-cluster.xml`` in cluster mode). - - .. code:: xml - - - - - -The security token key (``key.txt``) is automatically generated by the -server so you just need to acknowledge its location. Next is more -information about OAuth key and Shindig properties. - -**OAuth key configuration** - -In eXo Platform, the OAuth gadgets use an OAuth key to authorize with -external service providers. There is always a default key defined in the -``oauthkey.pem`` file. This key will be used in case the OAuth gadgets -do not indicate a key. It is strongly recommended that you create your -own ``oauthkey.pem`` file by using the **openssl** tool and some -commands as follows: - -:: - - openssl req -newkey rsa:1024 -days 365 -nodes -x509 -keyout testkey.pem -out testkey.pem -subj '/CN=mytestkey' - openssl pkcs8 -in testkey.pem -out oauthkey.pem -topk8 -nocrypt -outform PEM - -Then, replace the default **oauthkey.pem** with yours. - -**Disabling Shindig online features** - -Some Shindig features require online access which may lead to -significant delay time at startup time. Administrators can disable those -features in the ``shindig.properties`` file. Once the online features, -for example analytics, are disabled, they will not be available in -gadgets. - -Default (enabled): - -:: - - shindig.features.default=res://features/default-features.txt,res://features/online-features.txt - -To disable: - -:: - - shindig.features.default=res://features/default-features.txt - .. _statisticsParameter: ============================================== @@ -5317,9 +5152,14 @@ then the query is sent as if it is two words. .. _Configuration.ElasticSearch: -========================================= -Elasticsearch Embedded mode Configuration -========================================= +============================= +Elasticsearch Configuration +============================= + +.. _ESEmbeddedMode: + +Properties of the Elasticsearch embedded node +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When deployed as embedded, the `Elasticsearch configuration files `__ @@ -5329,11 +5169,6 @@ properties can be set directly in override the default properties defined in ``elasticsearch.yml`` and ``logging.yml``. -.. _ESEmbeddedMode: - -Properties of the Elasticsearch embedded node -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - All the properties below are standard properties of Elasticsearch. When a property ``es.xxx`` is defined in :ref:`exo.properties `, @@ -5380,6 +5215,23 @@ configurable in :ref:`exo.properties ` exo.es.search.server.url=http://127.0.0.1:9200 exo.es.search.server.username=root exo.es.search.server.password=xxxxx + +It is also possible to configure the number of connection in the http connections pool used for search and indexing calls to Elasticsearch +by defining these parameters: + + +:: + + exo.es.search.http.connections.max=2 + exo.es.index.http.connections.max=2 + +``exo.es.search.http.connections.max`` is the maximum number of connections in the HTTP connections pool for +Elasticsearch search calls. Default value set to 2. +``exo.es.index.http.connections.max`` is the maximum number of connections in the HTTP connections pool for +Elasticsearch indexing calls. Default value set to 2. + + + The parameter @@ -5799,9 +5651,7 @@ have not created this file, see :ref:`Configuration Overview -**A very specific TransactionService for JBoss AS** - -If you intend to use JBoss AS with Infinispan, you can use a very -specific TransactionService for JBoss AS. See the configuration example -as below: - -.. code:: xml - - - org.exoplatform.services.transaction.TransactionService - org.exoplatform.services.transaction.impl.jboss.JBossTransactionService - - - - - **TransactionsEssentials in standalone mode.** To use ``TransactionsEssentials``, simply add the following component diff --git a/docs/Configuration_eXo_Platform.rst b/docs/Configuration_eXo_Platform.rst index 63aa5d60..2f29b567 100644 --- a/docs/Configuration_eXo_Platform.rst +++ b/docs/Configuration_eXo_Platform.rst @@ -517,36 +517,36 @@ This section describes Content services which provide low-level functionality for UI components. These services are classified into the following groups: -- :ref:Actions ` +- :ref:`Actions ` This section represents the components related to managing Content actions and scripts in eXo Platform. -- :ref:Content arrangement ` +- :ref:`Content arrangement ` This section describes services related arranging content in eXo Platform, consisting of Lock Service, Taxonomy Service, Link Manager, Manage View Service, Manage Drives Service, New Folksonomy Service, and Relationship Service. -- :ref:Images Processing ` +- :ref:`Images Processing ` This section describes the components related to processing Content images in eXo Platform, consisting of Jod Converter Service, PDF Viewer Service, and Thumbnail Service. -- :ref:Publication ` +- :ref:`Publication ` This section describes two components which process document publication in eXo Platform. -- :ref:Searching ` +- :ref:`Searching ` This section represents components related to the Content searching feature in eXo Platform, consisting of Site Search Service, SEO Service, and Query Service. -- :ref:Templates Processing ` +- :ref:`Templates Processing ` This section describes services related to processing Content templates, including Application Template Manager Service, Fragment @@ -1433,6 +1433,7 @@ The configuration of this component can be found some params for runtime + @@ -1510,27 +1511,29 @@ The configuration of this component can be found - **properties-param**: ``RuntimeContextParams`` - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | Property-name | Type | Value | Description | - +=============================+==========+==========================================================================================================================+=============================================================================================================================+ - | ``parameterizedPageURI`` | string | ``${wcm.config.parameterizedPageURI:/detail}`` | Contains the path to a page which displays the full content of a document provided by a URL on the browser's address bar. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``printPageURI`` | string | ``${wcm.config.printPageURI:/printviewer}`` | The URL of the document's print preview page. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``printViewerPage`` | string | ``${wcm.config.printViewerPage:printviewer}`` | The name of the print preview page. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``editorPageURI`` | string | ``${wcm.config.editorPageURI:editor}`` | The name of the page which users can in-line edit its content displayed in the front-end page. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``siteExplorerURI`` | String | ``${wcm.config.siteExplorerURI:siteExplorer}`` | The URL of a page containing the Sites Explorer portlet. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``CLVPortlet`` | String | ``/presentation/ContentListViewerPortlet`` | The portlet which contains a list of content. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``SCVPortlet`` | String | ``/presentation/SingleContentViewer`` | The portlet which contains single content. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``formViewTemplatePath`` | String | ``${wcm.config.formViewTemplatePath:}`` | The path to the template used to display the contents in this portlet. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | ``paginatorTemplatePath`` | String | ``${wcm.config.paginatorTemplatePath:/exo:ecm/views/templates/content-list-viewer/paginators/DefaultPaginator.gtmpl}`` | The path to the paginator used to display the contents in this portlet. | - +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | Property-name | Type | Value | Description | + +=============================+==========+==========================================================================================================================+======================================================================================================================================+ + | ``parameterizedPageURI`` | string | ``${wcm.config.parameterizedPageURI:/detail}`` | Contains the path to a page which displays the full content of a document provided by a URL on the browser's address bar. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``parameterizedURIParam`` | string | ``${wcm.config.parameterizedURIParam:content-id}`` | Contains the parameter that takes the URL of a document on the browser's address bar to be displayed in the ``parameterizedPageURI``.| + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``printPageURI`` | string | ``${wcm.config.printPageURI:/printviewer}`` | The URL of the document's print preview page. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``printViewerPage`` | string | ``${wcm.config.printViewerPage:printviewer}`` | The name of the print preview page. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``editorPageURI`` | string | ``${wcm.config.editorPageURI:editor}`` | The name of the page which users can in-line edit its content displayed in the front-end page. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``siteExplorerURI`` | String | ``${wcm.config.siteExplorerURI:siteExplorer}`` | The URL of a page containing the Sites Explorer portlet. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``CLVPortlet`` | String | ``/presentation/ContentListViewerPortlet`` | The portlet which contains a list of content. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``SCVPortlet`` | String | ``/presentation/SingleContentViewer`` | The portlet which contains single content. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``formViewTemplatePath`` | String | ``${wcm.config.formViewTemplatePath:}`` | The path to the template used to display the contents in this portlet. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``paginatorTemplatePath`` | String | ``${wcm.config.paginatorTemplatePath:/exo:ecm/views/templates/content-list-viewer/paginators/DefaultPaginator.gtmpl}`` | The path to the paginator used to display the contents in this portlet. | + +-----------------------------+----------+--------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - **properties-param**: ``share.portal.config`` @@ -4552,7 +4555,6 @@ configuration of this component is found in messageConfig Message Configuration - ${gatein.ecms.watchdocument.sender:support@exoplatform.com} ${gatein.ecms.watchdocument.subject:Your watching document is changed} ${gatein.ecms.watchdocument.mimetype:text/html} @@ -4574,8 +4576,6 @@ configuration of this component is found in +----------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+ | **Field** | **Type** | **Value** | **Description** | +================+==============+====================================================================================================================================================================================================================+===============================================+ -| **sender** | ``string`` | ``${gatein.ecms.watchdocument.sender:support@exoplatform.com}`` | The sender who sends the notification mail. | -+----------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+ | **subject** | ``string`` | ``${gatein.ecms.watchdocument.subject:Your watching document is changed}.`` | The subject of the notification mail. | +----------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------+ | **mimeType** | ``string`` | ``${gatein.ecms.watchdocument.mimetype:text/html}.`` | The format of the notification mail. | diff --git a/docs/Content.rst b/docs/Content.rst index b2f758a8..f3bf5a30 100644 --- a/docs/Content.rst +++ b/docs/Content.rst @@ -816,13 +816,8 @@ code and file extension. 6. Build the Maven project using the command: ``mvn clean install``. 7. Put the ``.jar`` file (``target/custom-validator-1.0-SNAPSHOT.jar``) - into the ``lib`` folder of eXo Platform. - - - ``$PLATFORM_TOMCAT_HOME/lib`` (in Tomcat). - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/lib`` (in - JBoss). - + into the ``lib`` folder of eXo Platform: ``$PLATFORM_TOMCAT_HOME/lib``. + 8. Start the eXo Platform server. **Testing** diff --git a/docs/Deployment.rst b/docs/Deployment.rst index bf0ef248..3d62b120 100644 --- a/docs/Deployment.rst +++ b/docs/Deployment.rst @@ -14,8 +14,7 @@ Deployment reverse-proxy front-end. - :ref:`Configuring HTTP session timeout ` - Instructions on how to configure the session timeout of the - Tomcat and Jboss servers. + Instructions on how to configure the session timeout of the platform. .. _Deployment.RemoveSampleApp: @@ -34,8 +33,6 @@ First case - Your package is fresh so data is empty .. _First.Tomcat: -In Tomcat: ----------- Remove the following files: @@ -44,38 +41,6 @@ Remove the following files: - ``$PLATFORM_TOMCAT_HOME/webapps/acme-intranet-portlet.war`` - ``$PLATFORM_TOMCAT_HOME/lib/platform-sample-acme-intranet-config-*.jar`` - -.. _First.Jboss: - -In JBoss: ----------- - -1. Remove the following files: - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/platform-sample-acme-intranet-webapp.war`` - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/platform-sample-acme-intranet-portlet.war`` - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/lib/platform-sample-acme-intranet-config.jar`` - -2. Open the - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/META-INF/application.xml`` - file to comment out the following lines: - - .. code:: xml - - - - platform-sample-acme-intranet-portlet.war - acme-intranet-portlet - - - - - platform-sample-acme-intranet-webapp.war - acme-intranet - - .. _RemoveSampleApp.Second: @@ -89,15 +54,10 @@ To clean the data entirely, do the following steps: 1. Stop the server if it is running. -2. Remove the files (and change the configuration file for JBoss) as - described above. +2. Remove the files as described above. 3. Remove associated data. If you did not change the default data - configuration, just need to remove: - -- ``$PLATFORM_TOMCAT_HOME/gatein/data/`` (in Tomcat). - -- ``$PLATFORM_JBOSS_HOME/standalone/data/gatein/*`` (in JBoss). + configuration, just need to remove ``$PLATFORM_TOMCAT_HOME/gatein/data/``. 4. Restart your server. diff --git a/docs/Dev_eXo_Addons.rst b/docs/Dev_eXo_Addons.rst index 70c16d0e..799b47c0 100644 --- a/docs/Dev_eXo_Addons.rst +++ b/docs/Dev_eXo_Addons.rst @@ -332,29 +332,6 @@ Manager: 2. Restart the server. -.. _Jboss-deployment: - -**For JBoss:** - -1. Add new ``WEB-INF/jboss-deployment-structure.xml`` file to - ``custom-extension.war`` with the following content: - - .. code:: xml - - - - - - - - - -2. Add ``custom-extension.war`` to - ``$PLATFORM_JBOSS_HOME/standalone/deployments/`` platform.ear - directory. - -3. Restart the server. - .. _AddonsManagerCompliance: Add-ons Manager compliance @@ -366,37 +343,6 @@ different. The section :ref:`Packaging ` shows you how. The Add-ons Manager deploys the extension in the same way for Tomcat. -For JBoss, it uses another method to deploy the .war. Here are the -details: - -- The file ``jboss-deployment-structure.xml`` is not required. - -- The .war is deployed into - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear``. - -- The Add-ons Manager will edit the - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/META-INF/application.xml`` - to add a module as follows: - - .. code:: xml - - - ... - - - - custom-extension.war - custom-extension - - - ... - - - exo.portal.starter.war.war - starter - - - .. _PLFDevGuide.eXoAdd-ons.PortalExtension.Examples: @@ -550,13 +496,9 @@ need to compress JARs, WARs and other files into a zip archive: When installing an add-on, the Add-ons Manager copies files from the add-on archive into PRODUCT, as follows: -- JARs: ``$PLATFORM_TOMCAT_HOME/lib/`` (Tomcat), or - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/lib/`` - (JBoss). +- JARs: ``$PLATFORM_TOMCAT_HOME/lib/``. -- WARs: ``$PLATFORM_TOMCAT_HOME/webapps/`` (Tomcat), or - ``$PLATFORM_JBOSS/HOME/standalone/deployments/platform.ear/`` - (JBoss). +- WARs: ``$PLATFORM_TOMCAT_HOME/webapps/``. - Other files and folders located at the root of the zip archive will be copied to the home directory of the PRODUCT server. @@ -643,7 +585,7 @@ There are 2 ways to deploy an add-on: - Use the Add-ons Manager - the standard way to install, uninstall, and update add-ons in eXo Platform. In this way, you will avoid the manual registration that might cause errors. The Add-on Manager allows you - to simplify your add-ons management in both Tomcat and JBoss EAP by + to simplify your add-ons management in eXo Platform server by copying all JARs and WARs in one step and uninstalling them without searching in the ``lib`` directory (more than 400 jars) and in the ``webapps`` directory (more than 50 wars). @@ -1327,6 +1269,66 @@ To add an event listener using one of listed events above, you can add the follo org.example.CustomEventListener + + +.. _PLFDevGuide.eXoAdd-ons.eXoOnlyOfficeConnector: + +============================== +OnlyOffice connector for eXo +============================== + +With :ref:`OnlyOffice connector `, it is possible to :ref:`add new document ` types to the +form ``New document`` by using the :ref:`extension mechanism `. +For that purpose, you just need to define this external component plugin in your extension: + + + .. code:: xml + + + org.exoplatform.onlyoffice.documents.NewDocumentService + + documentTypePlugin + addTypePlugin + org.exoplatform.onlyoffice.documents.NewDocumentTypePlugin + Add new document types to create + + + document-types-configuration + + + + + + + classpath:files/template.docx + + + MicrosoftOfficeDocument + + + application/vnd.openxmlformats-officedocument.wordprocessingml.document + + + + + + + + + + + +Each new document template to add should be defined by this object ``org.exoplatform.onlyoffice.documents.NewDocumentType`` +with these parameters: + +- ``path``: Defines the path to the created document's template. It should be defined as it is made in eXo + Platform components. More details through this :ref:`tutorial `. +- ``label``: The template's label i.e. it is the translation key for the label to be displayed in the + ``New Document`` form. + To define it, you should configure the key ``UINewDocumentForm.label.option.{label}``. You can + find more details about translations management in eXo through this :ref:`link `. +- ``mimeType``: The document's mimetype. + .. |image0| image:: images/portalextensionstructure.png .. |image1| image:: images/addon/portal_extension.png diff --git a/docs/Developing_Rest_Service.rst b/docs/Developing_Rest_Service.rst index bcadbbd1..c5704f66 100644 --- a/docs/Developing_Rest_Service.rst +++ b/docs/Developing_Rest_Service.rst @@ -236,12 +236,7 @@ services are called ResourceContainers. 5. Build the Maven project using the command: ``mvn clean install``. -6. Put the ``.jar`` file into the eXo Platform package. - - - ``$PLATFORM_TOMCAT_HOME/lib`` (in Tomcat). - - - ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/lib`` - (in JBoss). +6. Put the ``.jar`` file into the eXo Platform package: ``$PLATFORM_TOMCAT_HOME/lib`` 7. Restart the server, then open http://mycompany.com:8080/portal/rest/demo/listusers/0 in your browser. @@ -328,8 +323,7 @@ The war custom-extension now looks like: 3. Deploy your custom-extension into eXo Platform by putting ``custom-extension.war`` in the ``webapps`` folder and - ``custom-extension-config.jar`` in the ``lib`` folder. See :ref:`How to ` - for both Tomcat and JBoss. + ``custom-extension-config.jar`` in the ``lib`` folder. See :ref:`How to `. 4. Start eXo Platform, then go to http://mycompany.com:8080/portal/rest/groovyrest/helloworld/eXo. The diff --git a/docs/GetStarted.rst b/docs/GetStarted.rst index a19cbcd4..e833a0f5 100644 --- a/docs/GetStarted.rst +++ b/docs/GetStarted.rst @@ -733,8 +733,6 @@ using `JDWP `__ that enables debugging by Eclipse. -**In Tomcat** - In eXo Platform Tomcat, the Debug mode is turned on by appending ``--debug`` to the startup command: @@ -752,13 +750,6 @@ If you want to change the port (``address=8000``), you have to :ref:`customize environment variables ` and edit the following variable: ``EXO_DEBUG_PORT="8000"``. -**In JBoss** - -In eXo Platform JBoss, you should provide a port in the startup command: - -:: - - ./bin/standalone.sh --debug 8787 .. _PLFDevGuide.GettingStarted.DevMode: @@ -768,9 +759,7 @@ Dev mode The Dev mode is useful for debugging container configuration, CSS and JavaScript. -**In Tomcat** - -In eXo Platform Tomcat, the Dev mode is turned on by appending ``--dev`` +In eXo Platform, the Dev mode is turned on by appending ``--dev`` to the startup command: :: @@ -783,11 +772,6 @@ This parameter will add the following system properties: - **-Dexo.product.developing=true** -**In JBoss** - -In eXo Platform JBoss, the ``--dev`` parameter is not supported. You need to -:ref:`customize environment variables ` -to have the following variable: ``EXO_DEV=true``. **Effects of Dev mode** diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index aa962c1b..c6a95053 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -1153,13 +1153,18 @@ the link. .. _News: -Posting a news in the activity stream +Posting a News in the activity stream ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ It is possible to write an article directly from a space composer. This feature is intended to improve and simplify the way information is shared. Users can contribute content intuitively without any former training to the content management system. News offers an inclusive and collaborative way to manage communication. Publishing a news lets you easily write, broadcast and share communication content into other spaces. You can also make it visible to all platform users by pinning articles on the home page. -To post a news article, click "write an article" located at the bottom of the space's composer. +.. warning:: News feature is beta on eXo Platform 5.3. It's planned to be released as generally available in eXo Platform 6.0 Version. It is not pre-packaged in eXo Platform 5.3, however it is still possible to install the addon in order to preview the feature.. + +Creating and posting a News +--------------------------- + +To create a news article, click "Write an article" located at the bottom of the space's composer. |image156| @@ -1167,24 +1172,76 @@ The creation form is opened in a new tab. |image159| -Write or paste your article content in. Choose a title, a summary and an illustrative image as desired, then press the "Post" button in the top-right corner of the screen. +Write or paste your article content in. Choose a title, a summary and an illustrative image as desired. + +**Insert a video** + +You can insert a video in the article's content by clicking in the video icon from the ckeditor toolbar. + +|image192| + +You have to paste the video's url in the field of the displayed popup. The supported video players are Youtube, Vimeo and Dailymotion. + +|image193| + +If the inserted URL format is incorrect, a red icon is displayed (with a tooltip displaying the message "Invalid URL") and the "OK" button is still disabled. + +|image195| + +If the inserted URL format is correct, a green icon is displayed and the "OK" button is enabled. + +|image194| + +When you click on the "OK" button a preview of the video is displayed in the content field and you can continue writing the article. + +|image196| + +**Insert an attachment** + +You can insert attachments in the article's body by clicking on the paper clip icon in the creation form. + +|image199| + +A drawer panel opens where you can either upload by selecting your files or by using a drag and drop in the dedicated area. You can attach up to 10 files and each file must not exceed 25 MB. + +|image200| + +Once you add files, you can see the upload progress as well as the number of selected files. You can cancel the upload of a file in progress or delete it if it is already uploaded using the close icon. + +|image201| + +You can close the drawer using the 'X' icon, the close button or simply by clicking outside the drawer panel. If the upload is still in progress as you close the panel, it will continue in the background. An animation around the attachments counter badge indicates progress. Note that the post button will be disabled until all files are uploaded. + +|image202| + + +When you finish writing your article, press the "Post" button in the top-right corner of the screen. |image160| -Once you post an article, you are automatically redirected to it in read mode. +Once you post an article, you are automatically redirected to it in read mode. |image161| +The attachments list will be available in the articles details after posting it. + +|image203| + +You can preview the file by clicking on it. + +|image204| + The article will be posted into the space's activity stream |image158| -.. note:: The |image157| button is grey and unclickable until the mandatory fields *title* and *content* are filled. +.. note:: The post button is grey and unclickable until the mandatory fields *title* and *content* are filled. You can access the content of the article either by clicking on its title or by clicking on "read more". -The details of the article are available on the current page and display all the information, including the publication date and the author. +The details of the article are available on the current page and display all the information, including the publication date, the author, the space's name and all the activity reactions (likes, comments and sent kudos). +You can also edit or share the article from this interface using the appropriate icons. You can exit the interface using the return button on the top left of the page. |image162| @@ -1197,7 +1254,7 @@ The `Update` action allows you to make changes in the article without reposting |image163| -When an article has been edited, the details view display the updated date and author besides initial information. +When an article has been edited, the details view display the update date and user if different from the author besides the initial information. |image164| @@ -1206,8 +1263,9 @@ When an article has been edited, the details view display the updated date and a Sharing a News --------------- -Once an article is posted, you will be allowed to share it in other spaces. The sharing action is possible from the article details page (and from the article's preview in the activity stream). -When you click on the share icon, a popup appears containing a reminder of the title of the article and allowing you to select the destination space(s). You can also add a optional description which will be displayed in the sharing activity. +Once an article is posted, you will be allowed to share it in other spaces. The sharing action is possible from the article details page and from News application. +When you click on the share icon, a drawer appears containing a reminder of the article's title, its creation user and its original space. +You have to select the destination space(s) and you can optionally add a description which will be displayed in the sharing activity. |image165| @@ -1222,6 +1280,11 @@ You can check that the action has been done successfully by connecting to the de |image167| +When you display the activity details, you will see the information about the sharing user, destination space and the description (if any) at the bottom of the page: + +|image219| + +.. _Pinning-a-News: Pinning a News in the home page ------------------------------- @@ -1231,10 +1294,6 @@ As a platform-wide publisher (publisher:/platform/web-contributors role required 1- Pinning a News from creation form : -From simple and full creation forms, a "Pin article" checkbox is available. - -|image168| - After filling in the article details, tick "Pin article" checkbox then click on "post" button. A confirmation message appears. |image169| @@ -1263,8 +1322,20 @@ The action is successfully done after confirming it as for the two options above You may display the home page to verify that the news is available in the appropriate block. +You can display the pinned articles with one of the following layouts : + +- Blog layout: + |image172| +- Latest News layout: + +|image198| + +When you click on the "See all" button, you are redirected automatically to news application filtered by pinned articles. + +|image205| + Unpinning a News from the home page ---------------------------------- @@ -1278,7 +1349,7 @@ As for pin, the unpin function is available from three locations : 1- Unpinning a news from edit form : To unpin an article from the edit form, display the article's details then click on the ``Edit`` icon. -Once the edit form is displayed, just untick the checkbox "Pin article" and validate. +Once the edit form is displayed, just click on the unpin article icon and validate. |image186| @@ -1319,10 +1390,8 @@ The information about the saving status is displayed in the creation form : |image175| -|image176| - You can access to your drafts from the creation form. -A draft button is displayed indicating the number of drafts available for the space in which you are writing the article. +A draft button is displayed indicating the number of drafts available for the current space. |image177| @@ -1343,16 +1412,22 @@ News application ----------------- The News application displays all the articles posted in the spaces that you have access to, as well as the articles pinned on the home page. -This application is accessible through the ``News`` link in the left navigation. +This application is accessible through the app center if configured. |image187| -The page displays the list of "All News". +By default, the page displays the 10 latest articles of the "All News" list. You can load more articles using the "Load More" button. + +|image217| + +For each article you can see the title, the illustration, the first words of the summary or the article body, the author, the publication date, the number of views and the original space where the article was posted as well as the spaces where it was shared. +You can share the displayed articles as explained in the `Sharing a News`_ chapter. You can also edit, archive or pin the articles when you have the permission to do it. |image188| -For each article you can see the title, the illustration, the first words of the summary or the article body, the author, the publication date, the number of views and the information about the source (space). -You can also share the displayed articles as explained in the `Sharing a News`_ chapter. +Search in News application +^^^^^^^^^^^^^^^^^^^^^^^^^^ + You can look for articles easily using the available search bar in the topbar of the application. It is possible to search by the article title, its author or content. |image189| @@ -1361,6 +1436,79 @@ You can look for articles easily using the available search bar in the topbar of |image191| + +News application filters +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Different filters are available from News application so you can easily find articles posted in specific spaces, pinned articles, your posted articles, your scheduled articles, your drafts or your archived articles. + + +**Filter articles per spaces : ** You can search articles by spaces using the filter button from the top bar. + +|image206| + +In the displayed drawer, you can select the spaces of the articles you want to filter. A search input is available to easily find the spaces you want to select. Only the spaces you are member of are available. A click on the Apply button allows to apply the filter. + +|image207| + +|image208| + + +**Filter by pinned articles : ** To display the pinned news list, select this option from the dropdown menu of the application topbar. + +|image197| + +After applying this filter, the list will only contain the articles that have been pinned on the home page. You can reset the filters using the appropriate button inside the drawer. + + +**Filter by your posted articles : ** To display the articles written by you, select the option "My posted News" from the dropdown menu of the application's top bar. + +|image209| + +After applying this filter, the list will only display the articles posted by you. You can either archive, edit or share them directly from the news application. + +|image210| + + +**Filter by archived articles : ** To display your archived articles, select the option "Archived News" from the dropdown menu of the application topbar. +After applying this filter, the list will only display your archived articles or all archived articles if you have the publisher role + +|image218| + + +Archiving News +--------------- + +As an article's author or as a platform-wide publisher (publisher:/platform/web-contributors role required), you can archive articles from News application interface. +An "archive/unarchive" icon is available on the right side of the article's preview next to "share", "edit" and "pin" icons. + +|image211| + +When you click on the archive icon, a confirmation message appears : + +|image212| + +Once you confirm the action, the article is automatically moved into the archive and is no longer available to other users. The archive can be accessed from the "Archived News" entry in the dropdown. Only the authors and publishers can see articles in the archive. +Archived articles have a different display in the activity stream : + +|image213| + +Other users won't able to click on this preview as long as the article remains archived. Also, for them, accessing an archived article by URL won't let them read it. In such case, the following message appears : + +|image214| + +However, you, as the author (or publisher), maintain access to the article's details and you can unarchive it from there. + +|image215| + +The same icon allows to unarchive articles from the News application. + +|image216| + +When you confirm the unarchiving of an item, it becomes accessible again to other users. + +.. note:: When you archive a pinned article it gets automatically unpinned. However, if you unarchive the same article afterwards, it won't be re-pinned automatically. + .. _Formatting-toolbar: @@ -2191,16 +2339,14 @@ to display the original timestamp of the comment. .. |image162| image:: images/sharenews/news_details2.png .. |image163| image:: images/sharenews/edit_news.png .. |image164| image:: images/sharenews/modified_news.png -.. |image165| image:: images/sharenews/popup_share.png +.. |image165| image:: images/sharenews/drawer_share.png .. |image166| image:: images/sharenews/shared_message2.png .. |image167| image:: images/sharenews/shared_news2.png -.. |image168| image:: images/sharenews/pin_checkbox.png .. |image169| image:: images/sharenews/confirm_pin.png .. |image170| image:: images/sharenews/pin_activity.png .. |image171| image:: images/sharenews/success_pin.png .. |image172| image:: images/sharenews/bloc_news.png .. |image175| image:: images/sharenews/saving_draft.png -.. |image176| image:: images/sharenews/saved_fullform.png .. |image177| image:: images/sharenews/draft_button.png .. |image178| image:: images/sharenews/drafts_drawer.png .. |image179| image:: images/sharenews/confirm_delete.png @@ -2209,13 +2355,38 @@ to display the original timestamp of the comment. .. |image182| image:: images/sharenews/unpin_activity.png .. |image183| image:: images/sharenews/unpin_popup.png .. |image184| image:: images/sharenews/unpin_success.png -.. |image185| image:: images/sharenews/unpin_icon.png +.. |image185| image:: images/sharenews/unpin_details.png .. |image186| image:: images/sharenews/unpin_edit.png -.. |image187| image:: images/sharenews/news_leftnav.png +.. |image187| image:: images/sharenews/appcenter_news.png .. |image188| image:: images/sharenews/news_app.png .. |image189| image:: images/sharenews/search_title.png .. |image190| image:: images/sharenews/search_user.png .. |image191| image:: images/sharenews/search_content.png - - - +.. |image192| image:: images/sharenews/video_icon.png +.. |image193| image:: images/sharenews/video_popup.png +.. |image194| image:: images/sharenews/correct_video_url.png +.. |image195| image:: images/sharenews/uncorrect_video_url.png +.. |image196| image:: images/sharenews/video_creation_form.png +.. |image197| image:: images/sharenews/app_pinned.png +.. |image198| image:: images/sharenews/latest_news.png +.. |image199| image:: images/sharenews/attachment_icon.png +.. |image200| image:: images/sharenews/attach_files_drawer.png +.. |image201| image:: images/sharenews/attach_files_progess.png +.. |image202| image:: images/sharenews/upload_files_form.png +.. |image203| image:: images/sharenews/attachments-details.png +.. |image204| image:: images/sharenews/file_preview.png +.. |image205| image:: images/sharenews/pinned_view.png +.. |image206| image:: images/sharenews/filter_button.png +.. |image207| image:: images/sharenews/filter_drawer.png +.. |image208| image:: images/sharenews/filtered_view.png +.. |image209| image:: images/sharenews/myposted_view.png +.. |image210| image:: images/sharenews/myposted_view1.png +.. |image211| image:: images/sharenews/archive_icon.png +.. |image212| image:: images/sharenews/archiving_confirmation.png +.. |image213| image:: images/sharenews/archived_as.png +.. |image214| image:: images/sharenews/error_archived.png +.. |image215| image:: images/sharenews/archived_details.png +.. |image216| image:: images/sharenews/unarchive_application.png +.. |image217| image:: images/sharenews/loadmore_application.png +.. |image218| image:: images/sharenews/archived_view.png +.. |image219| image:: images/sharenews/shared_details.png diff --git a/docs/Installation.rst b/docs/Installation.rst index d6bcfc00..5f3e83c9 100644 --- a/docs/Installation.rst +++ b/docs/Installation.rst @@ -487,7 +487,7 @@ Installing eXo Platform Enterprise Edition ========================================== In this section, we will provide how to install the enterpise edition of -eXo Platform in the two application servers: Tomcat and Jboss. +eXo Platform in Tomcat application server. - :ref:`Installing the Tomcat bundle ` Steps to install eXo Platform enterprise edition in Tomcat. @@ -495,8 +495,6 @@ eXo Platform in the two application servers: Tomcat and Jboss. - :ref:`Installing eXo Platform as a Windows service ` Steps to install eXo Platform as a Windows service. -- :ref:`Installing on JBoss EAP ` - Steps to install eXo Platform enterprise edition in Jboss. .. _EnterpriseEdition.TomcatInstall: @@ -582,11 +580,10 @@ adds two JVM options: - **-Dexo.product.developing=true** - **Note** - The Debug and Dev modes are turned off by default and are not - recommended in production environment because of performance impact. - See more details in :ref:`Developer guide <#PLFDevGuide.GettingStarted.DebugAndDevMode>`. +.. note:: The Debug and Dev modes are turned off by default and are not + recommended in production environment because of performance impact. + See more details in :ref:`Developer guide <#PLFDevGuide.GettingStarted.DebugAndDevMode>`. .. _EnterpriseEdition.TomcatInstallWinService: @@ -678,98 +675,7 @@ The second way: Using the NSSM tool nssm stop More details about NSSM commands in this `link `__. - -.. _EnterpriseEdition.JbossInstall: - -Installing on JBoss EAP -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Starting from the versions 5.1, eXo Platform integrates with JBoss EAP 7.1. - -Prerequisites ---------------- - -- Have JBoss EAP 7.1 extracted in ``$PLATFORM_JBOSS_HOME``. You can - download and install JBoss EAP 7.1 by following instructions on this - `link `__. - -- Have the eXo Platform package for JBoss EAP downloaded into your local. - -Installing eXo Platform on JBoss EAP --------------------------------------- - -1. Extract your downloaded eXo Platform package. - -2. Copy all extracted folders and files into ``$PLATFORM_JBOSS_HOME``. - -.. note:: This step will overwrite some files of JBoss EAP with new files of eXo Platform. - -3. Optionally, if you want to customize the JVM Options, create a copy of - ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.sample.conf`` on Linux - or ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.sample.conf.bat`` on - Windows. Rename the copy to ``standalone-customize.conf`` (or - ``standalone-customize.conf.bat`` on Windows), then edit it with your - JVM Options. - -4. Start up the server. - -- On Linux and OS X: - - :: - - $PLATFORM_JBOSS_HOME/bin/standalone.sh - -- On Windows: - - :: - - %PLATFORM_JBOSS_HOME%\bin\standalone.bat - -The server starts up successfully when you see the following message in -your log/console - - :: - - INFO [org.jboss.as] (Controller Boot Thread) WFLYSRV0025: JBoss EAP 7.1.0.GA (WildFly Core 3.0.10.Final-redhat-1) started in 115316ms - Started 4570 of 4826 services (602 services are lazy, passive or on-demand) - - -5. Shut down the server. - -- On Linux and OS X - - :: - - $PLATFORM_JBOSS_HOME/bin/jboss-cli.sh --connect command=:shutdown - - -- On Windows - - :: - - %PLATFORM_JBOSS_HOME%\bin\jboss-cli.bat --connect command=:shutdown - - -The server stops successfully when you see the following message in your -log/console:: - - INFO [org.jboss.as] (MSC service thread 1-4) WFLYSRV0050: JBoss EAP 7.1.0.GA (WildFly Core 3.0.10.Final-redhat-1) stopped in 13470ms - - -.. note:: Since JBoss EAP 6.3, there is a new blocking timeout property for - JBoss startup. - - This property is not a timeout per deployment but a timeout on - container stability and if ``jboss.as.management.blocking.timeout`` - is reached during startup then all applications will be undeployed - and the container shutdown. - - The default value is set to 300s which is too low for eXo Platform in - which we overrode the value. - - :: - - JAVA_OPTS="$JAVA_OPTS -Djboss.as.management.blocking.timeout=604800" - + .. _TasksInstallation: @@ -1089,17 +995,6 @@ Their Windows versions are: Except their syntax, ``.sh`` and ``.bat`` versions are the same. -In JBoss, the scripts are: - -- ``$PLATFORM_JBOSS_HOME/bin/standalone.conf`` - the default script. - -- ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.conf`` - the - customized script. - -- ``$PLATFORM_JBOSS_HOME/bin/standalone.conf.bat`` - Windows version. - -- ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.conf.bat`` - Windows - version. **Usage of the 2 scripts** @@ -1122,12 +1017,6 @@ In JBoss, the scripts are: - For Tomcat in Windows: rename ``setenv-customize.sample.bat`` to ``setenv-customize.bat``. - - For JBoss in Linux: rename ``standalone-customize.sample.conf`` to - ``standalone-customize.conf``. - - - For JBoss in Windows: rename ``standalone-customize.sample.conf.bat`` - to ``standalone-customize.conf.bat``. - 2. Find the variable that you want to customize, uncomment it (by removing '#' in the ``.sh`` file or "REM" in the ``.bat`` file) and edit its value. @@ -1291,24 +1180,6 @@ eXo Platform tries to ease it by exposing 3 variables that you can customize: | | development tasks. | +-----------------------------------------------+-----------------------------+ -**JBoss configuration** - -+-----------------------------------------------+-----------------------------+ -| Configuration | Description | -+===============================================+=============================+ -| ``MAX_FD="maximum"`` | Specifies the maximum file | -| | descriptor limit. | -+-----------------------------------------------+-----------------------------+ -| ``PROFILER=""`` | Specifies a profiler | -| | configuration file. | -+-----------------------------------------------+-----------------------------+ -| ``JAVA_OPTS="$JAVA_OPTS -Djboss.modules.lockl | Uncomment this to not use | -| ess=false"`` | JBoss Modules lockless | -| | mode. | -+-----------------------------------------------+-----------------------------+ -| ``JAVA_OPTS="$JAVA_OPTS -Djboss.modules.metri | Uncomment this to gather | -| cs=true"`` | JBoss Modules metrics. | -+-----------------------------------------------+-----------------------------+ .. _AdvancedCustomization: @@ -1385,10 +1256,6 @@ to the ``CATALINA_OPTS`` variable, for example: | | and ssh port 2000. | +-----------------------------------------------+----------------------------+ -For JBoss, similar variables can be customized by appending -``JAVA_OPTS``, for example: - -- ``JAVA_OPTS="$JAVA_OPTS -Dcrash.telnet.port=12345 -Dcrash.ssh.port=54321"`` .. _eXoProfiles: @@ -1426,15 +1293,6 @@ variable is required: See :ref:`Customizing environment variables ` to know how to customize the variables. -To activate the ``minimal`` profile in **JBoss**, edit the property -``exo.profiles`` in ``standalone/configuration/standalone-exo.xml`` -(``standalone-exo-cluster.xml`` in cluster mode): - -.. code:: xml - - - - .. _Troubleshooting: @@ -1585,14 +1443,6 @@ You can use another port than 8080 as follows: compression="off" compressionMinSize="2048" noCompressionUserAgents=".*MSIE 6.*" compressableMimeType="text/html,text/xml,text/plain,text/css,text/javascript" /> -- In JBoss, edit the - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` - file and change 8080 into another port, at the following line: - - .. code:: xml - - - .. note:: In addition to the port 8080, eXo Platform may use some others, such as 8009, 8443. You always can manage those ports in the same way as above. diff --git a/docs/Introduction_eXo_Platform.rst b/docs/Introduction_eXo_Platform.rst index 7b4921b2..efb7f8be 100644 --- a/docs/Introduction_eXo_Platform.rst +++ b/docs/Introduction_eXo_Platform.rst @@ -13,10 +13,6 @@ Introduction to eXo Platform Applications details (packaging, portlet class name, available preferences and sample configurations). - - :ref:`Gadgets ` - - Details of all gadgets used in eXo Platform, such as links to - used REST services, preferences, and more. These applications are packaged as Web application archives (WARs). @@ -1367,195 +1363,6 @@ and for the **Quick Search** portlet: -.. _PLFRefGuide.Application.Gadgets: - -======= -Gadgets -======= - - -This section provides the knowledge, such as links to used REST -services, preferences, and more about gadgets used in eXo Platform. - -The gadgets are classified basing on each application, including: - -- :ref:`Social ` - -- :ref:`Calendar ` - -- :ref:`Forum ` - - -.. _PLFRefGuide.Application.Gadgets.Social: - -Social -~~~~~~~ - -All Social gadgets are packaged in the **opensocial.war** file. - -+---------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Gadgets name | Used RestService | Description | Description of user preferences | -+=====================+==========================+===============================================================================================================================================+================================================================================================================================================================+ -| Activity Stream | ActivitiesRestServices | Manages activities of users: updating status, liking/unliking activities, commenting activities, deleting activities and deleting comments. | N/A | -+---------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Social RSS Reader | N/A | Fetches, parses and displays RSS from a specific URL. | There are 2 preference fields: URL input box (default value is http://blog.exoplatform.org/feed/) and Number of RSS per page selector (default value is 10). | -+---------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| My Connections | N/A | Gets and displays information of the current viewer and his connections. | The number of connections displayed per page. It is set to '5' by default. | -+---------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| My Spaces | SpacesRestService | Displays all spaces that a user has the "member" role. | N/A | -+---------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Viewer Friends | N/A | Fetches and displays connections of the viewer. | N/A | -+---------------------+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _PLFRefGuide.Application.Gadgets.Calendar: - -Calendar -~~~~~~~~~ - -The Calendar application consists of two gadgets: - -- :ref:`Eventslist ` - -- :ref:`Tasklist ` - - -.. _PLFRefGuide.Application.Gadgets.Calendar.Evenslist: - -Eventslist ------------- - - -Eventslist lists the maximum number of upcoming events, that is -configurable by users. For example, they can set the preference list to -5 or 10 events. - -**Preferences** - -See preferences of this gadget in the following sample code: - -.. code:: xml - - - - - - -**Details:** - -+--------------------+------------------------------------------+ -| Preferences | Description | -+====================+==========================================+ -| **url** | Link to the Calendar portlet. | -+--------------------+------------------------------------------+ -| **Subscribeurl** | Link to the upcoming events. | -+--------------------+------------------------------------------+ -| **limit** | The maximum number of upcoming events. | -+--------------------+------------------------------------------+ -| **timeformat** | The time format for upcoming events. | -+--------------------+------------------------------------------+ - -For more details on the preferences of gadgets, see -`here. `__ - -**Links to used REST services** - -It uses the **upcomingEvent** service in the following package: `` - org.exoplatform.webservice.cs.calendar.CalendarWebservice.java``. - -.. _PLFRefGuide.Application.Gadgets.Calendar.Taskslist: - -Tasklist ----------- - -Taskslist lists the maximum number of upcoming tasks that is -configurable by users. For example, they can set the preference list to -5 or 10 tasks. - -**Preferences** - -See the preferences of this gadget in the following sample code: - -.. code:: xml - - - -Accordingly, **setting** collects all the configuration of upcoming -tasks and add some more functions to help developers change the -configuration of the default skin. - -**Links to used REST services** - -It uses upcomingEvent service in the following package: `` - org.exoplatform.webservice.cs.calendar.CalendarWebservice.java``. - -.. _PLFRefGuide.Application.Gadgets.Forum: - -Forum -~~~~~~ - -The Forum application consists of two gadgets: - -- :ref:`Last Post ` - -- :ref:`Poll and Polllist ` - -.. _PLFRefGuide.Application.Gadgets.Forum.LastPost: - -Last Post ----------- - -eXo Platform provides the **Last Post** gadget which enables users to -see a list of the latest posts in Forum. The number of the latest posts -depends on the configuration setup of the gadget. - -+----------------+---------------------+----------------------------------------------------------+ -| Gadget name | War name | Description | -+================+=====================+==========================================================+ -| **lastpost** | forum-gadgets.war | The list of the latest posts in the Forum application. | -+----------------+---------------------+----------------------------------------------------------+ - -**Preferences** - -+-------------------+----------------------------------------------------------+ -| Preference name | Description | -+===================+==========================================================+ -| **maxcount** | The number of posts which are displayed in the gadget. | -+-------------------+----------------------------------------------------------+ - -**Links to used REST services** - -- /portal/rest/ks/forum/getmessage/{maxcount} - -.. _PLFRefGuide.Application.Gadgets.Forum.PollAndPolllist: - -Poll and Polllist ------------------- - -eXo Platform provides a gadget which enables users to see a poll. The -Poll gadget is developed on the combination of Gadget by GateIn and -Polls Service. The Poll gadget allows users to apply functions of Polls, -such as viewing and voting Polls. - -+-----------------+------------+----------------------+ -| Gadget name | War name | Description | -+=================+============+======================+ -| **pollslist** | poll.war | The list of Polls. | -+-----------------+------------+----------------------+ - -**Preferences** - -+-------------------+-----------------------------------------------------------+ -| Preference name | Description | -+===================+===========================================================+ -| **pollId** | The Id of Polls which is displayed in the Polls gadget. | -+-------------------+-----------------------------------------------------------+ - -**Links to used REST services** - -- portal/rest/private/ks/poll/viewpoll/pollId - -- portal/rest/private/ks/poll/votepoll/pollId/indexVote - .. |image0| image:: images/quick_search_portlet.png diff --git a/docs/LDAP.rst b/docs/LDAP.rst index 78cbee1b..65a12ad0 100644 --- a/docs/LDAP.rst +++ b/docs/LDAP.rst @@ -212,8 +212,6 @@ that you can adapt by following the following sections. 9. :ref:`Package and deploy ` your ldap-extension into Platform. -.. note:: For JBoss, don’t forget to declare :ref:`deployment dependency `. - 10. Make sure the directory server is running, then start eXo Platform. .. _LDAP.QuickStart.PackagingDeploying: @@ -221,11 +219,7 @@ that you can adapt by following the following sections. Packaging and deploying ------------------------- -The extension folder must be packaged into ``ldap-extension.war`` then copied to: - -- ``$PLATFORM_TOMCAT_HOME/webapps`` for Tomcat. - -- ``$PLATFORM_JBOSS_HOME/standalone/deployments`` for JBoss. +The extension folder must be packaged into ``ldap-extension.war`` then copied to ``$PLATFORM_TOMCAT_HOME/webapps``. To compress the folder into a .war (and decompress the .war for editing), you can use any archiver tool that supports .war extension. You can use the JDK built-in tool **jar**, as follows: @@ -244,8 +238,7 @@ You can use the JDK built-in tool **jar**, as follows: .. tip:: You should have ldap-extension packaged in .war when deploying it to production. However when testing, if you feel uncomfortable having to edit a .war, you can skip compressing it. In `Tomcat `__, just deploy the original - folder *ldap-extension*. In `JBoss `__, - rename it to ``ldap-extension.war``. + folder *ldap-extension*. .. _LDAP.QuickStart.Testing: diff --git a/docs/Manage-Documents.rst b/docs/Manage-Documents.rst index 3cb78bb7..a375c034 100644 --- a/docs/Manage-Documents.rst +++ b/docs/Manage-Documents.rst @@ -371,7 +371,7 @@ Basic compatibility eXo Platform core has a basic compatibility for Microsoft environments. So, if you are using Windows (7, 8 or 10) with Microsoft Office 2016 installed, you can work with Word, Excel and Powerpoint files in many -browsers: IE11, Firefox, Google Chrome and Edge. +browsers: Firefox, Google Chrome, Safari and Edge. .. note::To make Open in Office work well on IE11, you need to enable ActiveX by selecting Internet OptionsSecurity tabCustom levelInitialize and @@ -393,26 +393,18 @@ supported in eXo Platform: +--------------------+----------------------------+----------------------------+ | OS | Browsers | Office suites | +====================+============================+============================+ -| Windows 7, Windows | IE11, Firefox, Chrome, | Microsoft Office 2016 | -| 8, Windows 10 | Edge | (Recommended), Microsoft | -| | | Office 2010 and 2013 | -| | | (Supported) | +| Windows 7, | Firefox, Chrome, Edge | Microsoft Office 2016 | +| Windows 10 | | | +--------------------+----------------------------+----------------------------+ -| MAC OS 10.9+ | Firefox, Safari | Microsoft Office for Mac | -| | | 2016 (Recommended), | -| | | Microsoft Office for Mac | -| | | 2011 (Compatible) | +| MAC OS 10.12+ | Firefox, Safari, Chrome | Microsoft Office for Mac | +| | | 2016 | +--------------------+----------------------------+----------------------------+ -| Ubuntu 17.04 | Firefox | LibreOffice 5.4 | -| | | (Supported), OpenOffice | -| | | 4.1 (Compatible) | +| Ubuntu 18.04 | Firefox, Chrome | LibreOffice 6.0 | +--------------------+----------------------------+----------------------------+ .. note:: - It is recommended to use the latest versions of Firefox and Chrome. - - Google chrome browser is incompatible for Ubuntu OS. - - For Chrome in Windows and MAC OS, you need to enable NPAPI, as said `here `__. .. _ClientRequirements: @@ -424,11 +416,6 @@ In client side, you need to pay attention to the following environment requirements before using this feature. -.. note:: For all OSs/browsers, it is recommended you install and make sure - Java Applet enabled. This is required for opening Non-MS Office - files. You can visit http://javatester.org/ to make sure Java Plugin - already installed on your browser. - .. _Windows: Windows @@ -514,6 +501,12 @@ these steps: $ trust_server_cert /etc/davfs2/certs/myserver.pem + +.. note:: For Linux Operating systems, to work with Open in Office functionnality, + it is recommended to run the platform server on :ref:`SSL mode ` with a **trusted certificate**. + If it is not the case, you can workarround by adding the certificate under **/etc/davfs2/certs**. More details + in this `link `__ . + .. _MAC: @@ -527,7 +520,7 @@ MAC - In case you cannot open Microsoft Office files, you should close or force closing Microsoft Office Application, then re-open it. -- In MAC OS 10.9, to edit a text file, it is recommended you use +- In MAC OS 10.12, to edit a text file, it is recommended you use TextWrangler (not default TextEditor) to edit it. .. _WorkingWithBasicActions: diff --git a/docs/Manage-Space.rst b/docs/Manage-Space.rst index e41090fc..e8554fc9 100644 --- a/docs/Manage-Space.rst +++ b/docs/Manage-Space.rst @@ -77,7 +77,8 @@ spaces under MY SPACES on the left pane of the page. .. note:: You can also see all your spaces by directly clicking the |image4| link or clicking Join a space to open the Spaces page, then selecting the My Spaces tab. -|image5| + |image5| + The Space navigation includes the following tabs: @@ -98,7 +99,7 @@ The Space navigation includes the following tabs: To access a specific space, just click the space name. .. tip:: You can quickly find out your desired space from the list of your spaces by typing its name/description into the Search Spaces box on the left pane or using the **Search** feature in the Space application. - See the :ref:`Searching for spaces ` section for more details. **Accessing via URL** @@ -142,12 +143,12 @@ Space banner ~~~~~~~~~~~~~~ To change the banner just mouse over in the top right corner of the -space banner, an icon |image10| and a tooltip will appear. +space banner, an icon |image10| will appear. When you click on the icon |image68|, an ``Update`` button |image69| appears allowing you to pick up an image from your computer. -The tooltip indicates you the banner size which should be 130 pixels height minimum. +.. tip:: The banner size should be 130 pixels height minimum. |image11| @@ -266,6 +267,8 @@ A description of each template is displayed below the selectors. - Close: The user cannot request for joining, but only the space manager can invite him. + +.. _Users_invitation: .. note:: Template, Visibility and registration fields have a description of the choice selected to help you choosing the best template for your needs when creating a new space. @@ -350,20 +353,50 @@ Communication is the perfect choice to exchange knowledges and skills. More details about how to redefine space banner and profile :ref:`here `. +.. _SpaceHome: + +**Space home** + +The default space home page contains the following content: + +- Activity stream: displays the space's activities +- Description: displays the space's description and the list of the space's managers + + |image76| + +- :ref:`Calendar `: displays the events of the space's calendar by day (today's events by default) + + |image79| + +.. tip:: You can view other events of the previous and the following days simply by clicking on arrows |image80|. + +- :ref:`Who is on line? `: displays the online members of the space. + It appears while at least one member is online. + + |image78| + +.. note:: :ref:`Calendar ` and :ref:`Who is on line? ` portlets are the same + as for :ref:`intranet homepage ` but specific for the space's calendar and members. + +.. note:: When you are a platform administrator and member of a space, you are able to add more portlets + just by clicking on Edit --> Page --> Edit layout and then drag and drop the portelt you want to add. + + |image81| + + .. _Space-banner-avatar: **Space banner and avatar** - By default, the space banner is set to be the one predefined in the template and the space. +By default, the space banner is set to be the one predefined in the template and the space. |image28| - You can redefine the space banner and the space avatar by mousing - over and then clicking on |image29| allowing you to pick an image from - your computer. +You can redefine the space banner and the space avatar by mousingover and then clicking on +|image29| allowing you to pick an image from your computer. - More details about how to redefine space banner and profile :ref:`here `. +More details about how to redefine space banner and profile :ref:`here `. *Space applications* @@ -408,7 +441,7 @@ Communication is the perfect choice to exchange knowledges and skills. **Others** - When a new space is created: +When a new space is created: - A forum with the same name as this space is also created in the **Forums** application of the portal. In case this forum is @@ -942,10 +975,17 @@ deleted. .. |image66| image:: images/social/space_popover.png .. |image67| image:: images/social/space_popover_member.png .. |image68| image:: images/social/update_image_icon.png -.. |image69| image:: images/social/update_space_banner +.. |image69| image:: images/social/update_space_banner.png .. |image70| image:: images/social/update_image_icon.png .. |image71| image:: images/social/update_image_icon.png .. |image72| image:: images/social/update_reset_space_icon.png .. |image73| image:: images/social/rename_space_app.png .. |image74| image:: images/social/Delete_space_confirmation.png .. |image75| image:: images/social/special_characters_space_name.png +.. |image76| image:: images/social/Description_portlet.png +.. |image77| image:: images/social/CalendarPortlet.png +.. |image78| image:: images/social/WhoIsOnLinePortlet.png +.. |image79| image:: images/social/CalendarPortletPopulated.png +.. |image80| image:: images/social/arrowsCalendar.png +.. |image81| image:: images/social/editPage.png + diff --git a/docs/Management.rst b/docs/Management.rst index 992eb55a..b0dcda78 100644 --- a/docs/Management.rst +++ b/docs/Management.rst @@ -105,14 +105,6 @@ section. After the start, put your JMX configurations in the form described in `Advanced Customization ` section. -Although the two sections are written for Tomcat bundle, it is very -similar for JBoss, except the customized configuration file. In JBoss, -the file is ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.conf`` for -Linux, ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.conf.bat`` for -Windows. You can create it by using the sample file -``$PLATFORM_JBOSS_HOME/bin/standalone-customize.sample.conf`` for Linux -or ``$PLATFORM_JBOSS_HOME/bin/standalone-customize.sample.conf.bat`` for -Windows. **Securing JMX connection** diff --git a/docs/OnlyOffice.rst b/docs/OnlyOffice.rst index 0f480f06..ca71d712 100644 --- a/docs/OnlyOffice.rst +++ b/docs/OnlyOffice.rst @@ -4,16 +4,25 @@ OnlyOffice Connector for eXo ############################# -**What is OnlyOffice** +.. _OODefinition: + +==================== +What is OnlyOffice +==================== + `OnlyOffice Online Editors `__ is a great open source solution -that lets you to create, edit and collaborate online on your office -documents. OnlyOffice editors are 100% compatible with the following Microsoft Office document formats : docx, pptx and xlsx. +that lets you create, edit and collaborate online on your Office documents. +OnlyOffice editors are 100% compatible with Microsoft Office document formats : docx, pptx and xlsx. + |image0| -.. note:: eXo partnered with OnlyOffice to offer the enterprise-ready version of OnlyOffice editors to its customers along with the **commercial editions of eXo Platform**. Thus, eXo customers are required to purchase a dedicated subscription to run the OnlyOffice connector add-on on their eXo Platform instance. However, a 30-day trial is prepackaged with the connector in order to test-drive the editors before purchase. +.. note:: eXo partnered with OnlyOffice to offer the enterprise-ready version of OnlyOffice editors to its customers along + with the **commercial editions of eXo Platform**. Thus, eXo customers are required to purchase a dedicated + subscription from eXo to run the OnlyOffice connector add-on on their eXo Platform instance. + However, a 30-day trial is prepackaged with the connector in order to test-drive the integration before purchase. To install the add-on, use the following command: @@ -21,6 +30,161 @@ To install the add-on, use the following command: ./addon install exo-onlyoffice + +.. _HowToUse: + +================================ +How to use OnlyOffice for eXo? +================================ + +.. _EditOnline_BTN: + +Edit Online button +~~~~~~~~~~~~~~~~~~~~ +Having satisfied the above conditons and installed the add-on, you can easily edit your Microsoft Office documents online. +Just hit the ``Edit Online`` button |image1|. + +The ``Edit Online`` button is available in these locations: + +- In the activity stream among the possible actions available on the document + + |image2| + +- In the document preview interface + + |image3| + +- In the ``Documents`` application, in the action bar + + |image4| + +Clicking on this button loads the document in the corresponding OnlyOffice editor in new tab for maximum comfort. + + +.. _EditorInterface: + +Editor Interface +~~~~~~~~~~~~~~~~~~ + +Clicking on |image5| button opens the document you want to edit in an another tab. +The interface contains the content of the document loaded in the OnlyOffice editor with a floating button. + +|image10| + +Clicking on that button opens a drawer "Save version" with these fields: + +- The file's breadcrumb +- An edit icon allowing to edit the file's name +- The summary text field +- A ``Save`` button allowing to create a new version of the document +- The list of the 3 latest versions +- A ``See more`` button facilitating the display of the full version history of the document +- A close button at the top right of the drawer + +|image6| + +.. note:: The close button at the top right of the drawer allows only to close the drawer, it does not close the document and it + does not create a new version. + To create a version of the document in :ref:`Documents application `, you need either to click on + ``save`` button of the drawer or close the editor browser tab. + + +File's breadcrumb +------------------ + +The file's breadcrumb contains: + +- The space's avatar if the file is in a space or the user's avatar if the file is in Personal documents +- The file's path +- The file's name which is editable + +.. note:: You can edit the file's name by clicking on the edit button |image14| or double-clicking on the filename. + +Summary field +-------------- + +The summary text field allows you to add a description of the changes you made on the document. + +.. note:: The summary field is not mandatory, if you input it it will be also added as summary for the document's versions + list in :ref:`Documents application `. + +.. tip:: The summary text field is limited to 510 characters. If you input more than 510 characters and click on ``Save`` button, + an error message will appear: + + |image15| + + The content of the filled summary is not lost to allow you to reduce its number of characters and submit it again. + + +Versions list +-------------- + +A list of the latest three versions appears in the drawer. Each version contains these information: + +- The editor's avatar +- The changes timestamp, when hovering it a tooltip appears with the real edit date +- The edit summary if it has been filled, if not its content will be empty in the version. + +When the summary text is too long, it will be truncated in the corresponding item in the "Version list" and a tooltip with the +full summary text will appear when hovering over the summary content. + +|image16| + +.. note:: If the document is newly added, the component "versions list" does not appear until a new version of the document is saved. + +Clicking on the ``See more`` button redirects you to the :ref:`Documents application `. +You can then open Versions list by clicking on ``Versions`` button |image11| on the toolbar. + + +|image9| + +Yellow bar +~~~~~~~~~~~~ + +When a document visible in your stream, either in ``Documents`` application or in the activity stream, has been edited by +an another user, a yellow bar appears in the top of the document informing you that the document has been edited. +The yellow bar contains also a ``Reload`` link allowing you to load the changes done by another user. + +|image7| + +|image8| + +.. _New_Document: + +================== +Add New document +================== + +In the Documents toolbar, a ``New Document`` button is available allowing you to create a new document. +It is possible to create a new blank Microsoft Office document. + +Clicking on ``New Document`` button |image12| opens a popup allowing you to set the document's name and select +the document's type: docx, pptx or xlsx: + +|image13| + +Clicking on ``Create Document`` button open the newly created blank document in an another tab. +If you click on ``Cancel`` button, the ``New Document`` popup disappears and the document's creation process is canceled. + +.. note:: All the document's information are loaded in the drawer when creating a new document: + it's name, the space's avatar or the document's owner avatar and the path. The list of versions + is empty as there is no older versions for a new document. .. |image0| image:: images/OnlyOffice/onlyofficeInterface.png +.. |image1| image:: images/OnlyOffice/editOnline_btn.png +.. |image2| image:: images/OnlyOffice/editOnline_btn_act.png +.. |image3| image:: images/OnlyOffice/editOnline_btn_preview.png +.. |image4| image:: images/OnlyOffice/editOnline_btn_documents.png +.. |image5| image:: images/OnlyOffice/editOnline_btn.png +.. |image6| image:: images/OnlyOffice/drawer.png +.. |image7| image:: images/OnlyOffice/YellowBar_AS.png +.. |image8| image:: images/OnlyOffice/YellowBAr_Documents.png +.. |image9| image:: images/OnlyOffice/Versions_button.png +.. |image10| image:: images/OnlyOffice/interface.png +.. |image11| image:: images/OnlyOffice/version_btn_documents.png +.. |image12| image:: images/OnlyOffice/New_Document_btn.png +.. |image13| image:: images/OnlyOffice/New_Document_popup.png +.. |image14| image:: images/OnlyOffice/edit_button.png +.. |image15| image:: images/OnlyOffice/error_message.png +.. |image16| image:: images/OnlyOffice/summary_tooltip.png diff --git a/docs/PersonalApplications.rst b/docs/PersonalApplications.rst index 7ed26e7d..42ba0a39 100644 --- a/docs/PersonalApplications.rst +++ b/docs/PersonalApplications.rst @@ -23,10 +23,6 @@ How to view profiles of your contacts, to send/revoke a connection request, to a Introduction to your private Wiki. -:ref:`Managing your dashboard ` - -Details of managing your dashboard, a list of gadgets used in eXo Platform via dashboard, how to change gadget preferences and to add external gadgets from dashboard. - :ref:`Managing your notifications ` Details of which notification types you will receive. @@ -530,231 +526,8 @@ your own Wiki page. See the :ref:`Working With Wikis ` chapter for the ful |image31| - .. note:: Your wiki page is private by default. This means only you and your administrator can access this via the link (``.../wiki/user/[username]``). - However, if you have :ref:`made public ` for your own wiki, anyone can access, read and edit it via the link. - - - - -.. _Managing-Dashboard: - -======================= -Managing your dashboard -======================= - -This section represents the way to :ref:`use the dashboard -workspace ` and to :ref:`add more external gadgets from Dashboard `. -Also, you will know how to manage your dashboard effectively via the -following topics: - - * :ref:`Built-in gadgets ` - - * :ref:`Changing gadget preferences ` - -This portlet is to host mini-applications known as gadgets. The -dashboard uses a variety of graphical effects for displaying, opening -and using gadgets. - - .. note:: You can open many gadgets with different settings at once. - -.. _use-dashboard-workspace: - -**Using the dashboard workspace** - - -1- Click your display name on the top -navigation bar, then click **My Dashboard** from the drop-down menu to -access the **My Dashboard** portlet. -|image32| - -2- Click **Add Gadgets** to open the Dashboard -Workspace window which lists all available gadgets. -|image33| - -3- Select a gadget in the **Dashboard Workspace** window and drag and drop it into the **My Dashboard** page. - - -.. _add-more-external-gadgets: - -**Adding more external gadgets from Dashboard** - - -1- Obtain the URL (.xml or .rss) of the gadget you want to add from the gadgets source. For -example, *http://bejeweledg.googlecode.com/svn/trunk/bejeweled.xml. - -.. note:: Remote gadgets can be only created using an .xml link or RSS URL. - However, if you use a link that generates an RSS feed (for example, - http://feeds.feedburner.com/gatein), a new RSS reader gadget will be - created automatically even if the URL does not end with *.rss*. - -2- Open the :ref:`Dashboard Workspace ` window. - -3- Paste the URL in Step 1 into the textbox. -|image34| - -4- Click |image35| to add the new gadget to the page. - - -.. _Dashboard-gadgets: - - -Built-in gadgets -~~~~~~~~~~~~~~~~~ - -This section will introduce you to all built-in gadgets used in eXo Platform via the dashboard. - -.. _Login-history: - -Login History ----------------- - -The Login History gadget records users' login history and provides -statistics. - -|image36| - -There are three tabs in this gadget: - -- Login History: Lists all of the last sessions opened on the intranet. - -- Statistics: Shows the total number of logins in the graphic format. - -- History: Shows all logins of all users by period (Today, Earlier this - week, Earlier this month, or Earlier). - -In the Login History tab, you can look up the login history of a -specific user by entering his username in the Search box and press the -Enter key. - -.. _Templat-statistics: - -Template Statistics --------------------- - -The Template Statistics gadget lists all information related to the -execution time of all templates in the portal, therefore administrators -and developers will know how fast templates are and which ones should be -optimized. - -|image37| - -The gadget consists of two tabs: - -- 10 Slowest: lists 10 slowest templates in the portal. - -- All: shows the total number of templates and a list of the templates - in the portal. - -Each template provides you with the following information: - -- The full path of the template when you hover your cursor over its - name. - -- The average execution time (in ms) highlighted next to the template - name. - - - The time will be highlighted with the yellow color if it is more - than 1000 ms and less than 5000 ms. - - - The time will be highlighted with the red color if it is more than - 5000 ms. - -- exec: The number of executions of the template. - -- min: The minimum execution time of the template. - -- max: The maximum execution time of the template. - -.. _Featured-poll: - -Featured Poll --------------- - -|image38| - -The Featured Poll gadget displays the latest created poll in the Forum -that you have permission to vote. You can directly vote and see results -on the gadget. This gadget also allows you to discuss about the poll -topic in the Forum. - -- **Vote for a specific poll:** Normally, the latest poll will be - displayed on this gadget. However, you can indicate another poll to - vote by clicking |image39|, then select one from the drop-down list. - - Tick your selection, then click Vote. - -- **Discuss in Forum:** - - To discuss about the poll topic in the forum, just click the Discuss - in Forum and you will be redirected to the forum, - -.. _Bookmarks: - -Bookmarks ----------- ----------- - -The Bookmarks gadget is a simple link management one which displays your -bookmarked links in the portal and allows you to quickly access them by -clicking them. You can add, edit or remove any bookmarks. - -- To add a new bookmark, click |image40| on the title bar of the gadget. - - |image41| - - Add the Title and URL into the input text fields, then click Add to - accept creating the bookmark. - -- To edit a bookmark, hover your cursor over your desired bookmark, - then click |image42| corresponding to it. - - |image43| - - Edit the title and URL and click **OK** to accept your changes. - -- To delete a bookmark, hover your cursor over your desired bookmark, - then click - corresponding to it. - -.. _Favorite-docs: - -Favorite Documents -------------------- - -|image44| - -The Favorite Documents gadget lists all of your documents which are -:ref:`added to favorites `, so you can quickly access -them. - -You can go the Favorites folder in the Personal Documents drive by clicking |image45|. - - - .. note:: The Login History and Template Statistics gadgets are for the - administrators to manage and improve the portal better. - - -.. _Changing-gadget-preferences: - -Changing gadget preferences -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Edit icon on gadgets only displays if the gadgets have some gadget -preferences. This icon enables users to display the Edit form and change -preferences of a gadget. - -|image46| - -The following is an example of changing preferences of the Latest Forum -Posts gadget. - -1. Click |image47| to open the Edit form of the Latest Forum Posts gadget. - -|image48| - -2. Fill in all the fields of the form. - -3. Click Save to accept your changes. +.. note:: Your wiki page is private by default. This means only you and your administrator can access this via the link (``.../wiki/user/[username]``). + However, if you have :ref:`made public ` for your own wiki, anyone can access, read and edit it via the link. .. _Managing-Notification: @@ -936,6 +709,7 @@ In this section, the following notification streams will be presented: * :ref:`Post on your activity stream ` * :ref:`Post in your space ` * :ref:`Task Management activities ` +* :ref:`News notifications ` .. _NewUsers: @@ -1263,6 +1037,57 @@ your tasks as completed. Click on the notification stream, you will be taken to the detailed task pane in the Task Management application. +.. _NewsNotifications : + + +**News posted in a space** + +You will receive this notification when a user posts an article in a space you are member of. + + |image97| + +**News shared in a space** + +You will receive this notification when a user shares an article in a space you are member of. + + |image98| + +**My News shared** + +You will receive this notification when a user shares one of your articles in another space. + + |image99| + +**My posted News liked** + +You will receive this notification when a user likes one of your articles. + + |image100| + + +**My shared News liked** + +You will receive this notification when a user likes an article you shared. + + |image101| + + +**My posted News commented** + +You will receive this notification when a user comments on one of your articles. + + |image102| + + +**My shared News commented** + +You will receive this notification when a user comments on an article you shared. + + |image103| + + +**Kudos received for my News** + .. _Email-notification-Open-action: @@ -1430,3 +1255,10 @@ such as: .. |3| image:: images/common/3.png .. |4| image:: images/common/4.png .. |5| image:: images/common/5.png +.. |image97| image:: images/sharenews/post_notif.png +.. |image98| image:: images/sharenews/share_notif.png +.. |image99| image:: images/sharenews/share_mynews_notif.png +.. |image100| image:: images/sharenews/posted_like_notif.png +.. |image101| image:: images/sharenews/shared_like_notif.png +.. |image102| image:: images/sharenews/posted_comment_notif.png +.. |image103| image:: images/sharenews/shared_comment_notif.png diff --git a/docs/SSO.rst b/docs/SSO.rst index 0ae47e45..15907d42 100644 --- a/docs/SSO.rst +++ b/docs/SSO.rst @@ -25,8 +25,6 @@ application. - :ref:`SAML2 ` - - :ref:`Single Sign-On in Cluster mode ` - .. _eXoAddonsGuide.SSO.CAS: ==================================== @@ -53,8 +51,7 @@ The integration between eXo Platform and CAS consists of 3 steps: - **i.** CAS is deployed on Tomcat 7 server at **localhost:8888**. -- **ii.** eXo Platform (Tomcat or JBoss EAP) is deployed at - **localhost:8080**. +- **ii.** eXo Platform is deployed at **localhost:8080**. .. _eXoAddonsGuide.SSO.CAS.CAS_server_setup: @@ -216,16 +213,10 @@ to configure the eXo Platform server. eXo Platform server configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The eXo Platform server configuration is quite different between the Tomcat -and JBoss packages. Here are instructions for both -:ref:`Tomcat ` -and :ref:`JBoss ` -bundles. +In this section, we will detail how to configure eXo Platform server. .. _eXoAddonsGuide.SSO.CAS.eXoPlatform_server_configuration.Tomcat: -In Tomcat ----------- Add the following to the ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` file (see @@ -247,8 +238,7 @@ for this file): In previous versions of eXo Platform, there were much more changes needed in various configuration files. But now, all JARS are available in -``$PLATFORM_TOMCAT_HOME/lib`` or -``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/lib``, so you +``$PLATFORM_TOMCAT_HOME/lib``, so you do not need to manually add any JAR files. If you are interested in technical details about the single properties and configuration, you can see the below. @@ -266,10 +256,8 @@ see the below. - ``gatein.sso.login.module.enabled`` & ``gatein.sso.login.module.class`` - There is a special login module configured for gatein-domain in - ``$PLATFORM_TOMCAT_HOME/conf/jaas.conf`` (Tomcat) or - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` - (JBoss) called **SSODelegateLoginModule**. If SSO is disabled, this - **SSODelegateLoginModule** is simply ignored during authentication + ``$PLATFORM_TOMCAT_HOME/conf/jaas.conf`` called **SSODelegateLoginModule**. + If SSO is disabled, this **SSODelegateLoginModule** is simply ignored during authentication process. But if SSO is enabled by this property, it delegates the work to another login module configured via the next option ``gatein.sso.login.module.class``. **SSODelegateLoginModule** will @@ -329,52 +317,6 @@ pages will redirect to the CAS centralized authentication form. And on CAS you will be able to authenticate with portal credentials (like john/gtn) thanks to Authentication plugin. -.. _eXoAddonsGuide.SSO.CAS.eXoPlatform_server_configuration.JBoss: - -In JBoss ---------- - -1. Edit the file ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - (see :ref:`Configuration overview ` for this file): - - :: - - # SSO - gatein.sso.enabled=true - gatein.sso.callback.enabled=${gatein.sso.enabled} - gatein.sso.login.module.enabled=${gatein.sso.enabled} - gatein.sso.login.module.class=org.gatein.sso.agent.login.SSOLoginModule - gatein.sso.server.url=http://localhost:8888/cas - gatein.sso.portal.url=http://localhost:8080 - gatein.sso.filter.logout.class=org.gatein.sso.agent.filter.CASLogoutFilter - gatein.sso.filter.logout.url=${gatein.sso.server.url}/logout - gatein.sso.filter.login.sso.url=${gatein.sso.server.url}/login?service=${gatein.sso.portal.url}/@@portal.container.name@@/initiatessologin - - In which: - - - **gatein.sso.server.url** (= http://localhost:8888/cas in this - example) is the URL of your CAS web context. - - - **gatein.sso.portal.url** (= http://localhost:8080 in this example) - is the URL of your eXo Platform server. - -2. Uncomment the below login module in ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml``, - then change ``${gatein.sso.login.module.enabled}`` and - ``${gatein.sso.login.module.class}`` into - ``#{gatein.sso.login.module.enabled}`` and - ``#{gatein.sso.login.module.class}`` respectively. - - .. code:: xml - - - - - - - - - -Now, you can move to the next section for :ref:`testing `. .. _eXoAddonsGuide.SSO.CAS.Testing: @@ -499,8 +441,7 @@ The integration between eXo Platform and OpenAM consists of 2 steps: - **i.** OpenAM is deployed on Tomcat at **localhost:8888**. -- **ii.** eXo Platform (Tomcat or JBoss) is deployed at - **localhost:8080**. +- **ii.** eXo Platform is deployed at **localhost:8080**. .. _eXoAddonsGuide.SSO.OpenAM.OpenAM_server_setup: @@ -768,15 +709,11 @@ to configure the eXo Platform server. eXo Platform server configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Here are instructions for both -:ref:`Tomcat ` -and :ref:`JBoss ` -packages. +Here are instructions for +:ref:`eXo Platform server ` .. _eXoAddonsGuide.SSO.OpenAM.eXoPlatform_server_configuration.Tomcat: -In Tomcat ----------- Add the following to the ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` file to have the @@ -808,62 +745,6 @@ In which: - **gatein.sso.openam.realm** (= **exo** in this example) is the realm created in previous steps. -.. _eXoAddonsGuide.SSO.OpenAM.eXoPlatform_server_configuration.JBoss: - -In JBoss ---------- - - -1. Edit the - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - file to have the following lines (see :ref:`Configuration - overview <#PLFAdminGuide.Configuration.ConfigurationOverview>` for - this file): - - :: - - # SSO - gatein.sso.enabled=true - gatein.sso.callback.enabled=${gatein.sso.enabled} - gatein.sso.login.module.enabled=${gatein.sso.enabled} - gatein.sso.login.module.class=org.gatein.sso.agent.login.SSOLoginModule - gatein.sso.server.url=http://localhost:8888/openam - gatein.sso.openam.realm=exo - gatein.sso.portal.url=http://localhost:8080 - gatein.sso.filter.logout.class=org.gatein.sso.agent.filter.OpenSSOLogoutFilter - gatein.sso.filter.logout.url=${gatein.sso.server.url}/UI/Logout - gatein.sso.filter.login.sso.url=${gatein.sso.server.url}/UI/Login?realm=${gatein.sso.openam.realm}&goto=${gatein.sso.portal.url}/@@portal.container.name@@/initiatessologin - -In which: - -- ``gatein.sso.server.url`` (= http://localhost:8888/openam in this - example) is the URL of your OpenAM web context. - -- ``gatein.sso.portal.url`` (= http://localhost:8080 in this example) - is the URL of your eXo Platform server. - -- ``gatein.sso.openam.realm`` (= **gatein** in this example) is the - realm created in previous steps. - -2. Uncomment the below login module in - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml``, - then change ``${gatein.sso.login.module.enabled}`` and - ``${gatein.sso.login.module.class}`` into - ``#{gatein.sso.login.module.enabled}`` and - ``#{gatein.sso.login.module.class}`` respectively. - - .. code:: xml - - - - - - - - - -After configuring the eXo Platform server, move to the :ref:`next section ` -for testing. .. _eXoAddonsGuide.SSO.OpenAM.Testing: @@ -896,7 +777,7 @@ for for more details. Cross-domain authentication configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In the above example (in both JBoss and Tomcat), the eXo Platform and SSO +In the above example, the eXo Platform and SSO servers are deployed at **localhost:8080** and **localhost:8888**. The above configuration works if both servers are deployed on the same machine or the same domain, like eXo Platform on **portal.mydomain.com** and @@ -908,10 +789,8 @@ eXo Platform on **portal.yourdomain.com:8080** and OpenAM on both sides, as follows: 1. On portal side, change the configuration that you have done to - ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` (Tomcat), or - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - (JBoss) to have the following lines (see :ref:`Configuration overview ` - for this file): + ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` to have the following lines + (see :ref:`Configuration overview ` for this file): :: @@ -1412,87 +1291,6 @@ Go to ``$PLATFORM_HOME``, and install SPNEGO add-on with the command: 5. Start eXo Platform. -**Intergating SPNEGO with eXo Platform JBoss** - -1. Add the login module "spnego-server" as the child of the - ```` section of the - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` - file. - - .. code:: xml - - - - - - - - - - - - - - - - -.. note:: On Windows environment, you should change the path of keytab. For - example, if this file is put into the D drive, it should be: - keyTab="D:/server.keytab". - -2. Uncomment the below login module in ``standalone-exo.xml``, then change - ``${gatein.sso.login.module.enabled}`` and - ``${gatein.sso.login.module.class}`` into - ``#{gatein.sso.login.module.enabled}`` and - ``#{gatein.sso.login.module.class}`` respectively. - - .. code:: xml - - - - - - - - - -3. Configure SSO for eXo Platform by appending these configurations into - the ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - file (see :ref:`Configuration overview ` - for this file). - - .. code:: xml - - # SSO - gatein.sso.enabled=true - gatein.sso.filter.spnego.enabled=true - gatein.sso.callback.enabled=false - gatein.sso.skip.jsp.redirection=false - gatein.sso.login.module.enabled=true - gatein.sso.login.module.class=org.gatein.security.sso.spnego.SPNEGOSSOLoginModule - gatein.sso.filter.login.sso.url=/@@portal.container.name@@/spnegosso - gatein.sso.filter.initiatelogin.enabled=false - gatein.sso.valve.enabled=false - gatein.sso.filter.logout.enabled=false - -4. Start eXo Platform by using the command: - - - On linux: - - :: - - ./standalone.sh -Djava.security.krb5.realm=EXAMPLE.COM -Djava.security.krb5.kdc=$AD_MACHINE_NAME.example.com -b server.example.com - - - On Windows: - - :: - - standalone.bat -Djava.security.krb5.realm=EXAMPLE.COM -Djava.security.krb5.kdc=$AD_MACHINE_NAME.example.com -b server.example.com - -.. note:: ``$AD_MACHINE_NAME`` is name of the machine that has Active Directory installed. - -Next, move to the final step to :ref:`configure the client ` -(browser you are using). .. _eXoAddonsGuide.SSO.SPNEGO.Client_Configuration: @@ -1649,29 +1447,6 @@ form. In this case, you will need to add the }; ... -- ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` - (in JBoss). The ``standalone-exo.xml`` now looks like. - - .. code:: xml - - ... - - - - - - - - - - - - - - - - - ... .. _eXoAddonsGuide.SSO.SAML2: @@ -1756,7 +1531,7 @@ Edit the following properties (add them if they don't exist): gatein.sso.login.module.enabled=true gatein.sso.login.module.class=org.gatein.sso.agent.login.SAML2IntegrationLoginModule gatein.sso.valve.enabled=true - gatein.sso.valve.class=org.picketlink.identity.federation.bindings.tomcat.sp.ServiceProviderAuthenticator + gatein.sso.valve.class=org.gatein.sso.saml.plugin.valve.ServiceProviderAuthenticator gatein.sso.filter.login.sso.url=/portal/dologin gatein.sso.filter.initiatelogin.enabled=false gatein.sso.filter.logout.enabled=true @@ -1962,8 +1737,7 @@ follows: Remember them to use in next steps. 2. Install your file to - ``PLATFORM_*/standalone/configuration/gatein/saml2/`` (for Jboss) or - ``PLATFORM_*/gatein/conf/saml2/`` (for Tomcat) if you are configuring + ``PLATFORM_*/gatein/conf/saml2/`` if you are configuring eXo Platform SP/IDP. Install it to ``WEB-INF/classes/`` inside ``PLATFORM_*/standalone/deployments/idp-sig.war`` if you are configuring ``idp-sig.war``. @@ -1971,13 +1745,9 @@ follows: 3. Modify picketlink configuration file to provide your **keystore password** and a **key password**. The picketlink configuration file is: - - ``PLATFORM_SP/standalone/configuration/gatein/saml2/picketlink-sp.xml`` - (for Jboss) and ``PLATFORM_SP/gatein/conf/saml2/picketlink-sp.xml`` - (for Tomcat) if you are configuring eXo Platform SP. + - ``PLATFORM_SP/gatein/conf/saml2/picketlink-sp.xml`` if you are configuring eXo Platform SP. - - ``PLATFORM_IDP/standalone/configuration/gatein/saml2/picketlink-idp.xml`` - (for Jboss) and ``PLATFORM_IDP/gatein/conf/saml2/picketlink-sp.xml`` - (for Tomcat) if you are configuring eXo Platform IDP. + - ``PLATFORM_IDP/gatein/conf/saml2/picketlink-sp.xml``if you are configuring eXo Platform IDP. - ``WEB-INF/picketlink.xml`` inside ``PLATFORM_*/standalone/deployments/idp-sig.war`` if you are @@ -1998,161 +1768,6 @@ The following configuration is for SP, similar for IDP and .. note:: On Windows, you should use the absolute link to the keystore file, instead of using ``${gatein.sso.picketlink.keystore}``. -.. _eXoAddonsGuide.SSO.SSO_in_cluster: - -============================== -Single Sign-On in Cluster mode -============================== - -.. note:: Currently this content is for eXo Platform JBoss only. - -In the cluster mode, the eXo Platform SSO valve can be used to -authenticate a user on one eXo Platform node and have that -authentication automatically carried across to other nodes in the -cluster. - -Clustered SSO with Load Balancer -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you are running the cluster mode with Apache Load Balancer, you are -using the same URL to access the servers (which is actually URL of the -Load Balancer). You need to enable SSO by modifying the -``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo-cluster.xml`` -file, as follows: - -- Find **subsystem** that has **xmlns="urn:jboss:domain:web:1.4"**. It - looks like: - - .. code:: xml - - - - - - - - - - -- Add **** right after ****. This will be: - - .. code:: xml - - - - - - - - - - - -Clustered SSO in a Shared DNS Domain -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you are accessing the servers through different URLs in the same DNS -domain, Single Sign-On can be configured by adding the domain parameter -to the SSO configuration entry. - -Let's see what is the difference. In case Load Balancer is used -(described above): - -.. code:: xml - - - -In this case: - -.. code:: xml - - - -The parameter must be added to the entry on all servers in the cluster -and the name of the shared DNS domain must be specified as its value. -This configuration ensures that the **JSESSIONIDSSO** cookie will be -scoped to the specified domain, which is otherwise scoped only to the -host where the initial authentication was performed. - -The following example demonstrates how to simulate and test this case on -a Linux machine. There are 2 nodes in the cluster. - -Configuring and testing SSO in a shared DNS Domain ----------------------------------------------------- - -1. Add the following lines to the ``/etc/hosts`` file: - - :: - - 127.0.1.1 machine1.yourdomain.com - 127.0.1.2 machine2.yourdomain.com - -2. On both servers, modify the - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo-cluster.xml`` - file to have: - - .. code:: xml - - - - - - - - - - - -3. Start the first server using the following command: - - :: - - ./standalone.sh -b machine1.yourdomain.com -c standalone-exo-cluster.xml -Djboss.node.name=node1 - -4. Start the second server using: - - :: - - ./standalone.sh -b machine2.yourdomain.com -c standalone-exo-cluster.xml -Djboss.node.name=node2 - -5. Access the first server at http://machine1.yourdomain.com:8080/portal - and sign in. - -6. Access the second server at http://machine2.yourdomain.com:8080/portal - and test that you are automatically signed in. - -7. Sign out from one server and test that you are automatically signed - out from the other one. - -Re-authentication -~~~~~~~~~~~~~~~~~~~ - -The eXo Platform SSO valve can also be used to authenticate with any -other web application. If that application uses the same roles as the -main eXo Platform instance, no further configuration is required. -Because the eXo Platform SSO valve includes the same JAAS principal in -all HTTP requests, even in requests to other web applications, matching -roles ensure successful authentication with those applications. - -To enable the single sing-on authentication with an application that -uses different roles, you need to set the ``reauthenticate`` parameter -of the ``sso`` eXo Platform Web subsystem configuration entry to -``true``: - -.. code:: xml - - - -The ``true`` value ensures that reauthentication with user credentials -will be performed against the web application's security domain in each -HTTP request. This will enforce creation of a new principal with updated -roles for the web application. As user credentials are used for -authentication in this case, it is required that the same user -credentials exist in both the web application and the JBoss Portal -Platform instance. - .. |image0| image:: images/SSO/CAS/cas.png diff --git a/docs/Security.rst b/docs/Security.rst index dccc6864..c79c9c60 100644 --- a/docs/Security.rst +++ b/docs/Security.rst @@ -64,8 +64,7 @@ entry declares a Realm name and at least one login module. Each login module consists of a Java class and some parameters which are specified by the class. -Below is the default Realm in the Tomcat bundle. In JBoss, it looks -different but basically, the explanation is right for both. +Below is the default Realm in the Tomcat bundle. :: @@ -118,41 +117,6 @@ Declaring JAAS Realm in eXo Platform exo.security.domain=gatein-domain -**In the JBoss package** - -- The default Realm is declared in the - ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml`` - file, at the following lines: - - .. code:: xml - - - - - - - - - - - -- A "security domain" property in - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - (about this file, see :ref:`Configuration overview `) - needs to be set equal to the Realm name: - - :: - - exo.security.domain=gatein-domain - .. _Security.ChangeJAASReal.ListOfApplicationsUsingRealm: List of applications using Realm @@ -205,25 +169,6 @@ re-configure: .. note:: The ``.war`` files are located under the ``$PLATFORM_TOMCAT_HOME/webapps`` folder. -**In the JBoss package:** - -- ``exo.portal.web.portal.war``: ``/WEB-INF/jboss-web.xml``, - ``/WEB-INF/web.xml``, ``/META-INF/context.xml``. - -- ``exo.portal.web.rest.war``: ``/WEB-INF/jboss-web.xml``, - ``/WEB-INF/web.xml``. - -- ``calendar-extension-webapp.war``: ``/WEB-INF/jboss-web.xml``. - -- ``forum-extension-webapp.war``: ``/WEB-INF/jboss-web.xml``. - -- ``wiki-extension-webapp.war``: ``/WEB-INF/jboss-web.xml``. - -- ``ecms-core-webapp.war``: ``/WEB-INF/jboss-web.xml``. - -- ``ecms-packaging-wcm-webapp.war``: ``/WEB-INF/jboss-web.xml``. - -.. note:: The ``.war`` files are located under the ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear`` folder. .. _Security.GadgetProxyConfig: @@ -248,10 +193,7 @@ gadget server is installed. To specify domains that you want to allow or deny, modify the file: - ``$PLATFORM_TOMCAT_HOME/webapps/portal.war/WEB-INF/conf/common/common-configuration.xml`` - (in Tomcat). -- ``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/exo.portal.web.portal.war/WEB-INF/conf/common/common-configuration.xml`` - (in JBoss). The default configuration is: @@ -485,13 +427,11 @@ post -- **In JBoss** - -1. Set the following property in - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - file: - - :: - - exo.base.url=https://proxy1.com - -2. In ``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml``, - add the property proxy-address-forwarding="true" in the configuration of - http-listener: - - .. code:: xml - - - -After restarting the proxy and eXo Platform, you can test -*https://proxy1.com*. If you are testing with dummy server names, make -sure you created the hosts "proxy1.com" and "exo1.com" in the file -``/etc/hosts``. .. _PLFAdminGuide.Security.HTTPSConf.eXo: @@ -590,25 +506,6 @@ After starting eXo Platform, you can connect to names, make sure you created the host "exo1.com" in the file ``/etc/hosts``. -Configuring eXo Platform's JBoss ----------------------------------- - -To configure JBoss to run under HTTPS, you just need to set the -following property in -``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` -file: - -:: - - exo.base.url=https://exo1.com:8443 - -After starting JBoss, you can connect to eXo Platform at -*https://exo1.com:8443/portal*. If you are testing with dummy server -names, make sure you created the host "exo1.com" in the file -``/etc/hosts``. - - - .. _Security.KeyRemembermeToken: ====================================== @@ -675,8 +572,7 @@ example). The valid value of algorithms and other parameters can be found `here `__. -Then, place the generated file under ``gatein/conf/codec`` (in Tomcat) -or ``standalone/configuration/gatein/codec`` (in JBoss). +Then, place the generated file under ``gatein/conf/codec``. 2. Update the ``jca-symmetric-codec.properties`` file with the parameters used in your keytool command: @@ -701,10 +597,8 @@ Updating password encryption key The password encryption uses a keystore file. By default, the file is: -- ``$PLATFORM_TOMCAT_HOME/gatein/conf/codec/codeckey.txt`` (in Tomcat). +- ``$PLATFORM_TOMCAT_HOME/gatein/conf/codec/codeckey.txt`` -- ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/codec/codeckey.txt`` - (in JBoss). To update the password encryption key, just remove the file, then restart the server. The keystore file will be re-created at the startup diff --git a/docs/Upgrade.rst b/docs/Upgrade.rst index 985cf024..c02cb41b 100644 --- a/docs/Upgrade.rst +++ b/docs/Upgrade.rst @@ -51,21 +51,6 @@ In this section, we will present all the breaking changes you should know before starting the upgrade to 5.3 version. -**JBoss EAP upgrade** - -JBoss EAP 7.1 version is used in eXo Platform 5.1. - -This version comes with a bunch of improvements, including the use of -the new security framework WildFly Elytron and the support of HTTP/2. -More information on this new version are available at -`https://www.redhat.com/en/blog/red-hat-releases-jboss-eap-71 `__. - - -You can find -`here `__, -a full documentation about the upgrade to JBoss EAP 7.1. - - **Templates changes** Some Groovy templates have been changed in eXo Platform 5.3, check @@ -73,6 +58,12 @@ out the :ref:`complete list `. If your custom extension overrides some Groovy templates, you must check if it has been changed, and update it if it is the case. +.. _ShindigRemoval: + +**Shindig removal** + +In eXo Platform 5.3 version, we no longer support gadgets as we dropped `Apache Shindig ` which has been retired. +eXo opted for `Apache Shindig ` removal for many reasons cited on the :ref:`technical novelties section ` .. _Upgrade.BreakingChanges.Templates @@ -218,10 +209,11 @@ Before the upgrade, you need to: - Detect and handle issues to make sure they will not happen during the real upgrade. - Estimate how long the upgrade will take in your production environment. - Find out if you need to adjust anything to make your upgrade faster and more efficient. - - -.. tip:: JBoss EAP was upgraded to 7.1 version to benefit from its last updates and improvements. - You can check changelogs `for JBOSS `__. + +.. note:: As mentioned in Breaking changes :ref:`section `, Shindig, the component which supports gadgets is removed + from eXo Platfrom 5.3 and which leads to the removal of gadgets. In fact, dashboard application and all gadgets are automatically + removed. Only four of them namely Login History, Bookmarks, RSS Reader and Featured Poll still remaining and could be placed in pages + if necessary. .. _Upgrade.Process: @@ -249,16 +241,13 @@ procedure. **Upgrade to a new eXo Platform version** -**For Tomcat and JBoss packages** 1. Stop the old version of eXo Platform, in this case the 5.1 version. 2. Apply your customizations into eXo Platform 5.3. - If you have changed the configuration properties via - ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` (Tomcat) or - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` - (JBoss), you can update them to the same file in the new eXo + ``$PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties`` you can update them to the same file in the new eXo Platform version. - If you use a populated organizational data source (such as LDAP), @@ -299,9 +288,7 @@ Here are good ways you can follow during and after upgrading: - Monitor the server console/log file to be aware of the upgrade status or any issues during the upgrade. By default, eXo Platform records all - information in ``$PLATFORM_TOMCAT_HOME/logs/platform.log`` (in - Tomcat), ``$PLATFORM_JBOSS_HOME/standalone/log/server.log`` (in - JBoss). + information in ``$PLATFORM_TOMCAT_HOME/logs/platform.log``. A successful upgrade typically logs the followings: diff --git a/docs/UserWallet.rst b/docs/UserWallet.rst index a4c7bb6f..5a8580ae 100644 --- a/docs/UserWallet.rst +++ b/docs/UserWallet.rst @@ -55,12 +55,8 @@ A warning message appears behind the label "My wallet" Once your wallet is approved by an administrator, you’ll receive a notification informing you that your wallet is activated. -|image| - All actions become available and you can send and receive funds as well as view transaction history or statistics and reward details. -|image| - Wallet security ~~~~~~~~~~~~~~~~ @@ -165,7 +161,6 @@ In case of a failed transaction, a warning is displayed in the transaction list .. |image0| image:: images/reward/profile_mywallet1.png .. |image1| image:: images/reward/profile_mywallet2.png -.. |image2| image:: images/reward/ .. |image3| image:: images/reward/create_wallet.png .. |image4| image:: images/reward/created_wallet.png .. |image5| image:: images/reward/warning_funds.png diff --git a/docs/database_configuration.rst b/docs/database_configuration.rst index 26435aed..ab72df64 100644 --- a/docs/database_configuration.rst +++ b/docs/database_configuration.rst @@ -102,8 +102,7 @@ Configuring eXo Platform could be used for testing purpose but it is not possible to use it in production environments. -eXo Platform relies on the application server (Tomcat/JBoss) to access -databases. It uses three JNDI datasources: +eXo Platform relies on the Tomcat application server to access databases. It uses three JNDI datasources: - IDM uses *exo-idm\_portal*. @@ -117,12 +116,10 @@ credentials. .. _ConfigureDBTomcat: -For Tomcat -~~~~~~~~~~~ 1. Configure the datasources. - - i. Edit ``conf/server.xml`` to remove the default HSQL configuration: + i. Edit ``conf/server.xml`` to remove the default HSQL configuration: .. code:: xml @@ -136,7 +133,7 @@ For Tomcat - - ii. Add a new one. For MySQL as an example, you will just need to + ii. Add a new one. For MySQL as an example, you will just need to copy the sample in ``conf/server-mysql.xml``: .. code:: xml @@ -154,13 +151,13 @@ For Tomcat ... username="plf" password="plf" driverClassName="com.mysql.jdbc.Driver" url="jdbc:mysql://localhost:3306/plf?autoReconnect=true&characterEncoding=utf8" /> - - iii. Edit username, password, url (host, port and database name). - Besides MySQL, if you are using Enterprise Edition, you will find the - samples for other RDBMSs in ``conf/server-*.xml``. + iii. Edit username, password, url (host, port and database name). + Besides MySQL, if you are using Enterprise Edition, you will find the + samples for other RDBMSs in ``conf/server-*.xml``. - - iv. Append this character encoding to the url in case your - database character set is ``utf8``. For example, in MySQL (this - is different between RDBMSs): + iv. Append this character encoding to the url in case your + database character set is ``utf8``. For example, in MySQL (this + is different between RDBMSs): .. code:: xml @@ -205,187 +202,6 @@ If you have not created ``exo.properties`` yet, see :ref:`Configuration overview http://dev.mysql.com/downloads/connector/j/, and for Oracle: http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html. -.. _ConfigureDBJboss: - -For JBoss -~~~~~~~~~~~ - -1. Configure the datasources. - - - i. Edit ``standalone/configuration/standalone-exo.xml`` to remove the - default HSQL configuration: - - .. code:: xml - - - - - hsqldb-driver.jar - org.hsqldb.jdbcDriver - jdbc:hsqldb:file:${exo.data.dir}/hsql/exo-plf;shutdown=true;hsqldb.write_delay=false;hsqldb.tx=mvcc; - ... - - - - hsqldb-driver.jar - org.hsqldb.jdbcDriver - jdbc:hsqldb:file:${exo.data.dir}/hsql/exo-plf;shutdown=true;hsqldb.write_delay=false;hsqldb.tx=mvcc; - ... - - - - hsqldb-driver.jar - org.hsqldb.jdbcDriver - jdbc:hsqldb:file:${exo.data.dir}/hsql/exo-plf;shutdown=true;hsqldb.write_delay=false;hsqldb.tx=mvcc; - ... - - - ii. For MySQL as an example, need to uncomment some lines in the - file, edit driver, username, password, url: - - .. code:: xml - - - mysql-connector-java-5.1.44.jar_com.mysql.jdbc.Driver_5_1 - com.mysql.jdbc.Driver - jdbc:mysql://localhost:3306/plf?autoReconnect=true - ... - - root - exoplf - - - ... - - - - -.. note:: The recommended version of MySQL JDBC driver for eXo Platfom - 5.0 is **5.1.44**. This driver version has two JDBC driver - implementations **com.mysql.jdbc.Driver** and - **com.mysql.fabric.jdbc.FabricMySQLDriver**, so Jboss deploys - them as ``mysql-connector-java-5.1.44.jar_com.mysql.jdbc.Driver_5_1`` - and ``mysql-connector-java-5.1.44.jar_com.mysql.fabric.jdbc.FabricMySQLDriver_5_1``. - Therefore the ``driver`` parameter must be set to - **mysql-connector-java-5.1.44.jar\_com.mysql.jdbc.Driver\_5\_1**, - as in the above example. - - - - - iii. Append this character encoding to the url in case your database - character set is ``utf8``. For example, in MySQL (this is different - between RDBMSs): - - .. code:: xml - - jdbc:mysql://localhost:3306/plf?autoReconnect=true&characterEncoding=utf8 - -2. Set the SQL Dialect if necessary. - - This step is not mandatory because the dialect is auto-detected in most - cases. You only need to take care of it for some particular RDBMSs: - - - i. For JCR, only when you are using MySQL and database character set - ``utf8``, you need to edit - ``standalone/configuration/gatein/exo.properties`` file to have: - - :: - - exo.jcr.datasource.dialect=MySQL-UTF8 - - - ii. For IDM, eXo Platform detects automatically the dialect for - RDBMSs listed - `here `__. - Only when your RDBMS is **not** in the list, for example *Postgres - Plus Advanced Server 9.2*, you will need to edit - ``standalone/configuration/gatein/exo.properties`` file to have: - - :: - - hibernate.dialect=org.hibernate.dialect.PostgresPlusDialect - -If you have not created ``exo.properties`` yet, see :ref:`Configuration overview `. - -3. Download the JDBC driver for Java and install it to ``$PLATFORM_JBOSS_HOME/standalone/deployments``. - -.. tip:: Normally you can find out an appropriate driver for your JDK from - your database vendor website. For example, for MySQL: - http://dev.mysql.com/downloads/connector/j/, and for Oracle: - http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html. - -.. note:: Particularly to MySQL, this fast install method might not work for - some couples of MySQL server and driver versions. If it happens to - you, solve it by installing the driver as a *module*. See details - below. - -**Installing JDBC driver as a JBoss module** - -This alternative method is applied to solve a deployment problem with -some couples of MySQL server and driver versions. There is no statement -that indicates exactly the versions, but the problem likely happens with -some most recent versions, such as MySQL server 5.6.19 and -mysql-connector-java-5.1.35-bin.jar. - -- When it happens, you will get a JBAS014775 message like the - following, and Platform JBoss does not start successfully :: - - JBAS014775: New missing/unsatisfied dependencies: - service jboss.jdbc-driver.mysql-connector-java-5_1_35-bin_jar (missing) dependents: - [service jboss.data-source.java:/comp/env/exo-idm_portal, - service jboss.driver-demander.java:/comp/env/exo-jcr_portal, - service jboss.driver-demander.java:/comp/env/exo-idm_portal, JBAS014799: ... and 3 more ] - -Then you should remove the jar from -``$PLATFORM_JBOSS_HOME/standalone/deployments/`` and install it to JBoss -modules as follows: - -1. Create a new folder: ``$PLATFORM_JBOSS_HOME/modules/com/mysql/main/``. - -2. Place the driver (.jar) in the created folder. - -3. Create a ``module.xml`` file in the created folder, with the following - content: - - .. code:: xml - - - - - - - - - - - -4. Modify the datasources configuration in ``standalone-exo.xml`` to - declare a driver in *drivers* tag and reference to it in *datasource* - tag: - - .. code:: xml - - - - - - - com.mysql - jdbc:mysql://localhost:3306/plf?autoReconnect=true - - - ... - - - - - - com.mysql.jdbc.jdbc2.optional.MysqlXADataSource - com.mysql.jdbc.Driver - - - - - - .. _Database.DockerDatabase: =========================================== @@ -483,11 +299,9 @@ you need to edit the following properties: # name of the datasource that will be used by eXo JCR exo.jcr.datasource.name=java:/comp/env/exo-jcr -in ``gatein/conf/exo.properties`` (Tomcat), or -``standalone/configuration/gatein/exo.properties`` (JBoss). +in ``gatein/conf/exo.properties`` -If you have not created ``exo.properties`` yet, see `Configuration -overview <#PLFAdminGuide.Configuration.ConfigurationOverview>`__. +If you have not created ``exo.properties`` yet, see `Configuration overview `. **Particularly in Tomcat**, you also need to edit ``conf/Catalina/localhost/context.xml.default`` file: @@ -654,9 +468,7 @@ Configuring eXo Chat database recommended version for eXo Platform 5.0 is **3.4**. 2. Configure the database parameters in ``chat.properties`` or - ``exo.properties``. The files are located in - ``$PLATFORM_TOMCAT_HOME/gatein/conf`` for Tomcat and - ``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein`` for Jboss. + ``exo.properties``. The files are located in ``$PLATFORM_TOMCAT_HOME/gatein/conf`` More details in :ref:`chat configuration ` section. @@ -813,36 +625,4 @@ For more details, refer to the following: - https://confluence.atlassian.com/display/JIRA/Surviving+Connection+Closures -**Q:** **How to enable managed connection?** - -**A:** This question is specific to the JCR datasource in Platform JBoss -package. - -When you want to use managed connections, set "true" for the -``gatein.jcr.datasource.managed`` property in the -``$PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties`` -file. See :ref:`Configuration overview ` -if you have not created this file yet. - -.. code:: java - - gatein.jcr.datasource.managed=true - -To be clear, this property needs to be "true" in two cases: - -- You use a **datasource** with JTA enabled: - - .. code:: xml - - - -- You use an **xa-datasource**: - - .. code:: xml - - - -Using managed connections has pros and cons, so only do it if you know -what you are doing. By default eXo Platform JBoss uses **datasource -jta="false"**. diff --git a/docs/eXo_Core.rst b/docs/eXo_Core.rst index 37b874a8..1ad37754 100644 --- a/docs/eXo_Core.rst +++ b/docs/eXo_Core.rst @@ -533,7 +533,7 @@ sources: per-Application Server extensions of this login module in the **org.exoplatform.services.security.jaas** package, which can be used in appropriate AS. In particular, eXo has dedicated Login modules for - Tomcat, JBoss, JOnAS and WebSphere. + Tomcat, JOnAS and WebSphere. - Besides that, in case when the third-party authentication mechanism is required, @@ -563,7 +563,7 @@ To make it work in the particular J2EE server, it is necessary to add specific Principals/Credentials to the Subject to be propagated into the specific J2EE container implementation. The DefaultLoginModule is extended by overloading its commit() method with a dedicated logic, -presently available for Tomcat, JBoss and JOnAS application servers. +presently available for Tomcat and JOnAS application servers. Furthermore, you can use the optional RolesExtractor which is responsible for mapping primary Subject's principals (userId and a set @@ -3419,55 +3419,6 @@ Specify a new login module for JAAS: org.exoplatform.services.security.j2ee.DigestAuthenticationTomcatLoginModule required; }; -**JBoss server configuration** - -Edit the configuration file located at -``$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear/exo.portal.web.rest.war!/WEB-INF/web.xml`` -by replacing - -.. code:: xml - - - BASIC - gatein-domain - - -with - -.. code:: xml - - - DIGEST - gatein-domain - - -Edit the login configuration file located at -``$PLATFORM_JBOSS_HOME/standalone/configuration/standalone-exo.xml``: - -.. code:: xml - - - - - - - - - - - - - - - - -You probably should define **users.properties** and **roles.properties** -according to your own needs. - -See -`here `__ -for more information about the JBoss server Digest authentication -configuration. **Organization Service implementation requirements** diff --git a/docs/eXo_Kernel.rst b/docs/eXo_Kernel.rst index 1f8680c7..59e7bc37 100644 --- a/docs/eXo_Kernel.rst +++ b/docs/eXo_Kernel.rst @@ -1376,11 +1376,6 @@ overloaded in the following lookup sequence: - For Tomcat, the value of the variable *${catalina.home}*. - - For JBoss AS, the value of the variable - *${jboss.server.config.url}* or *${jboss.server.config.dir}* if - the ``exo-conf`` directory can be found there; otherwise it will - be the value of the *${jboss.home.dir}* variable. - - *$PORTAL\_NAME* is the name of portal web application. - External configuration location can be overridden with System @@ -1424,7 +1419,7 @@ overloaded in the following lookup sequence: - The ``.ear`` and ``.war`` files from which Kernel gets the configuration files for the RootContainer, are found thanks to a lookup inside the standard deployment folders, but so far those - folders are only properly defined in case of JBoss AS, Tomcat and + folders are only properly defined in case of Tomcat and Jetty. For other application servers, you will need to use the System property described in the previous note. @@ -2454,16 +2449,13 @@ Profiles activation An active profile list is obtained during the boot of the root container and is composed of the system property *exo.profiles* - a comma-separated list - and a server specific profile value (Tomcat for -Tomcat, JBoss for JBoss, and more). +Tomcat). :: # runs GateIn on Tomcat with the profiles tomcat and foo sh gatein.sh -Dexo.profiles=foo - # runs GateIn on JBoss with the profiles jboss, foo and bar - sh run.sh -Dexo.profiles=foo,bar - Profiles configuration ------------------------ @@ -4442,7 +4434,7 @@ context factory by a context factory that is ExoContainer aware and that is able to delegate to the original initial context factory if it detects that it is not in the eXo scope. By default, the feature is disabled since it is only required on AS that does not share the objects -by default like Tomcat and it is not the case of JBoss AS. +by default like Tomcat. The BindReferencePlugin component plugin configuration example (for JDBC datasource): @@ -4531,7 +4523,7 @@ Configuration examples ~~~~~~~~~~~~~~~~~~~~~~~~ `Log4J `__ is a very popular and -flexible logging system. It is a good option for JBoss. +flexible logging system. .. code:: xml diff --git a/docs/images/Badges.png b/docs/images/Badges.png new file mode 100644 index 00000000..28d5031e Binary files /dev/null and b/docs/images/Badges.png differ diff --git a/docs/images/HomeButtonchat.png b/docs/images/HomeButtonchat.png new file mode 100644 index 00000000..72129780 Binary files /dev/null and b/docs/images/HomeButtonchat.png differ diff --git a/docs/images/Kudos.png b/docs/images/Kudos.png new file mode 100644 index 00000000..21fde3c4 Binary files /dev/null and b/docs/images/Kudos.png differ diff --git a/docs/images/OnlyOffice.png b/docs/images/OnlyOffice.png new file mode 100644 index 00000000..e8b15fff Binary files /dev/null and b/docs/images/OnlyOffice.png differ diff --git a/docs/images/OnlyOffice/New_Document_btn.png b/docs/images/OnlyOffice/New_Document_btn.png new file mode 100644 index 00000000..1f798f18 Binary files /dev/null and b/docs/images/OnlyOffice/New_Document_btn.png differ diff --git a/docs/images/OnlyOffice/New_Document_name.png b/docs/images/OnlyOffice/New_Document_name.png new file mode 100644 index 00000000..3a02d106 Binary files /dev/null and b/docs/images/OnlyOffice/New_Document_name.png differ diff --git a/docs/images/OnlyOffice/New_Document_popup.png b/docs/images/OnlyOffice/New_Document_popup.png new file mode 100644 index 00000000..6c9ffc40 Binary files /dev/null and b/docs/images/OnlyOffice/New_Document_popup.png differ diff --git a/docs/images/OnlyOffice/Versions_button.png b/docs/images/OnlyOffice/Versions_button.png new file mode 100644 index 00000000..3fa53538 Binary files /dev/null and b/docs/images/OnlyOffice/Versions_button.png differ diff --git a/docs/images/OnlyOffice/YellowBAr_Documents.png b/docs/images/OnlyOffice/YellowBAr_Documents.png new file mode 100644 index 00000000..ba7c873f Binary files /dev/null and b/docs/images/OnlyOffice/YellowBAr_Documents.png differ diff --git a/docs/images/OnlyOffice/YellowBar_AS.png b/docs/images/OnlyOffice/YellowBar_AS.png new file mode 100644 index 00000000..7af389b0 Binary files /dev/null and b/docs/images/OnlyOffice/YellowBar_AS.png differ diff --git a/docs/images/OnlyOffice/drawer.png b/docs/images/OnlyOffice/drawer.png new file mode 100644 index 00000000..949bf4d9 Binary files /dev/null and b/docs/images/OnlyOffice/drawer.png differ diff --git a/docs/images/OnlyOffice/editOnline_btn.png b/docs/images/OnlyOffice/editOnline_btn.png new file mode 100644 index 00000000..950eea4c Binary files /dev/null and b/docs/images/OnlyOffice/editOnline_btn.png differ diff --git a/docs/images/OnlyOffice/editOnline_btn_act.png b/docs/images/OnlyOffice/editOnline_btn_act.png new file mode 100644 index 00000000..37d4cc03 Binary files /dev/null and b/docs/images/OnlyOffice/editOnline_btn_act.png differ diff --git a/docs/images/OnlyOffice/editOnline_btn_documents.png b/docs/images/OnlyOffice/editOnline_btn_documents.png new file mode 100644 index 00000000..639a17f8 Binary files /dev/null and b/docs/images/OnlyOffice/editOnline_btn_documents.png differ diff --git a/docs/images/OnlyOffice/editOnline_btn_preview.png b/docs/images/OnlyOffice/editOnline_btn_preview.png new file mode 100644 index 00000000..88b640ee Binary files /dev/null and b/docs/images/OnlyOffice/editOnline_btn_preview.png differ diff --git a/docs/images/OnlyOffice/edit_button.png b/docs/images/OnlyOffice/edit_button.png new file mode 100644 index 00000000..21f369e5 Binary files /dev/null and b/docs/images/OnlyOffice/edit_button.png differ diff --git a/docs/images/OnlyOffice/error_message.png b/docs/images/OnlyOffice/error_message.png new file mode 100644 index 00000000..5b99ceee Binary files /dev/null and b/docs/images/OnlyOffice/error_message.png differ diff --git a/docs/images/OnlyOffice/interface.png b/docs/images/OnlyOffice/interface.png new file mode 100644 index 00000000..576e9e25 Binary files /dev/null and b/docs/images/OnlyOffice/interface.png differ diff --git a/docs/images/OnlyOffice/onlyofficeInterface.png b/docs/images/OnlyOffice/onlyofficeInterface.png index aecb9a5a..93277b00 100644 Binary files a/docs/images/OnlyOffice/onlyofficeInterface.png and b/docs/images/OnlyOffice/onlyofficeInterface.png differ diff --git a/docs/images/OnlyOffice/summary_tooltip.png b/docs/images/OnlyOffice/summary_tooltip.png new file mode 100644 index 00000000..0f7f9f8a Binary files /dev/null and b/docs/images/OnlyOffice/summary_tooltip.png differ diff --git a/docs/images/OnlyOffice/top_bar.png b/docs/images/OnlyOffice/top_bar.png new file mode 100644 index 00000000..0eea5310 Binary files /dev/null and b/docs/images/OnlyOffice/top_bar.png differ diff --git a/docs/images/OnlyOffice/version_btn_documents.png b/docs/images/OnlyOffice/version_btn_documents.png new file mode 100644 index 00000000..dd69f3ce Binary files /dev/null and b/docs/images/OnlyOffice/version_btn_documents.png differ diff --git a/docs/images/PerkStore.png b/docs/images/PerkStore.png new file mode 100644 index 00000000..88e7146c Binary files /dev/null and b/docs/images/PerkStore.png differ diff --git a/docs/images/SpaceWidgets.png b/docs/images/SpaceWidgets.png new file mode 100644 index 00000000..293ed921 Binary files /dev/null and b/docs/images/SpaceWidgets.png differ diff --git a/docs/images/Wallet.png b/docs/images/Wallet.png new file mode 100644 index 00000000..33ef15e2 Binary files /dev/null and b/docs/images/Wallet.png differ diff --git a/docs/images/chat_accents.png b/docs/images/chat_accents.png new file mode 100644 index 00000000..143c0041 Binary files /dev/null and b/docs/images/chat_accents.png differ diff --git a/docs/images/gamificaton_board.png b/docs/images/gamificaton_board.png new file mode 100644 index 00000000..6b25ff2e Binary files /dev/null and b/docs/images/gamificaton_board.png differ diff --git a/docs/images/reward/Landing page.PNG b/docs/images/reward/Landing page.PNG new file mode 100644 index 00000000..ec994f1c Binary files /dev/null and b/docs/images/reward/Landing page.PNG differ diff --git a/docs/images/reward/change_password.png b/docs/images/reward/change_password.png new file mode 100644 index 00000000..b04878f5 Binary files /dev/null and b/docs/images/reward/change_password.png differ diff --git a/docs/images/reward/failed_details.png b/docs/images/reward/failed_details.png new file mode 100644 index 00000000..f3a3300b Binary files /dev/null and b/docs/images/reward/failed_details.png differ diff --git a/docs/images/reward/remember_password.png b/docs/images/reward/remember_password.png new file mode 100644 index 00000000..36fba9ae Binary files /dev/null and b/docs/images/reward/remember_password.png differ diff --git a/docs/images/reward/transaction_failed.png b/docs/images/reward/transaction_failed.png new file mode 100644 index 00000000..3391813c Binary files /dev/null and b/docs/images/reward/transaction_failed.png differ diff --git a/docs/images/reward/type_password.png b/docs/images/reward/type_password.png new file mode 100644 index 00000000..0474305f Binary files /dev/null and b/docs/images/reward/type_password.png differ diff --git a/docs/images/sharenews/access_permission.png b/docs/images/sharenews/access_permission.png new file mode 100644 index 00000000..9d7298a2 Binary files /dev/null and b/docs/images/sharenews/access_permission.png differ diff --git a/docs/images/sharenews/app_pinned.png b/docs/images/sharenews/app_pinned.png new file mode 100644 index 00000000..e111ec2f Binary files /dev/null and b/docs/images/sharenews/app_pinned.png differ diff --git a/docs/images/sharenews/appcenter_news.png b/docs/images/sharenews/appcenter_news.png new file mode 100644 index 00000000..5b764ec0 Binary files /dev/null and b/docs/images/sharenews/appcenter_news.png differ diff --git a/docs/images/sharenews/archive_icon.png b/docs/images/sharenews/archive_icon.png new file mode 100644 index 00000000..51d1e01a Binary files /dev/null and b/docs/images/sharenews/archive_icon.png differ diff --git a/docs/images/sharenews/archived_as.png b/docs/images/sharenews/archived_as.png new file mode 100644 index 00000000..0c5eb50e Binary files /dev/null and b/docs/images/sharenews/archived_as.png differ diff --git a/docs/images/sharenews/archived_details.png b/docs/images/sharenews/archived_details.png new file mode 100644 index 00000000..ed76db10 Binary files /dev/null and b/docs/images/sharenews/archived_details.png differ diff --git a/docs/images/sharenews/archived_view.png b/docs/images/sharenews/archived_view.png new file mode 100644 index 00000000..bf821638 Binary files /dev/null and b/docs/images/sharenews/archived_view.png differ diff --git a/docs/images/sharenews/archiving_confirmation.png b/docs/images/sharenews/archiving_confirmation.png new file mode 100644 index 00000000..c1195c84 Binary files /dev/null and b/docs/images/sharenews/archiving_confirmation.png differ diff --git a/docs/images/sharenews/attach_files_drawer.png b/docs/images/sharenews/attach_files_drawer.png new file mode 100644 index 00000000..81acded0 Binary files /dev/null and b/docs/images/sharenews/attach_files_drawer.png differ diff --git a/docs/images/sharenews/attach_files_progess.png b/docs/images/sharenews/attach_files_progess.png new file mode 100644 index 00000000..49d02754 Binary files /dev/null and b/docs/images/sharenews/attach_files_progess.png differ diff --git a/docs/images/sharenews/attachment_icon.png b/docs/images/sharenews/attachment_icon.png new file mode 100644 index 00000000..96b405f0 Binary files /dev/null and b/docs/images/sharenews/attachment_icon.png differ diff --git a/docs/images/sharenews/attachments-details.png b/docs/images/sharenews/attachments-details.png new file mode 100644 index 00000000..50163c92 Binary files /dev/null and b/docs/images/sharenews/attachments-details.png differ diff --git a/docs/images/sharenews/content_administration.png b/docs/images/sharenews/content_administration.png new file mode 100644 index 00000000..82450dff Binary files /dev/null and b/docs/images/sharenews/content_administration.png differ diff --git a/docs/images/sharenews/content_by_query.png b/docs/images/sharenews/content_by_query.png new file mode 100644 index 00000000..12e09054 Binary files /dev/null and b/docs/images/sharenews/content_by_query.png differ diff --git a/docs/images/sharenews/correct_video_url.png b/docs/images/sharenews/correct_video_url.png new file mode 100644 index 00000000..7af203aa Binary files /dev/null and b/docs/images/sharenews/correct_video_url.png differ diff --git a/docs/images/sharenews/creation_form.png b/docs/images/sharenews/creation_form.png index 61f3f8f5..d34f04cd 100644 Binary files a/docs/images/sharenews/creation_form.png and b/docs/images/sharenews/creation_form.png differ diff --git a/docs/images/sharenews/draft_button.png b/docs/images/sharenews/draft_button.png index 1150af5a..1851848a 100644 Binary files a/docs/images/sharenews/draft_button.png and b/docs/images/sharenews/draft_button.png differ diff --git a/docs/images/sharenews/drafts_drawer.png b/docs/images/sharenews/drafts_drawer.png index 203f5399..115c6441 100644 Binary files a/docs/images/sharenews/drafts_drawer.png and b/docs/images/sharenews/drafts_drawer.png differ diff --git a/docs/images/sharenews/drawer_share.png b/docs/images/sharenews/drawer_share.png new file mode 100644 index 00000000..e17f4965 Binary files /dev/null and b/docs/images/sharenews/drawer_share.png differ diff --git a/docs/images/sharenews/edit_layout.png b/docs/images/sharenews/edit_layout.png new file mode 100644 index 00000000..d80d773d Binary files /dev/null and b/docs/images/sharenews/edit_layout.png differ diff --git a/docs/images/sharenews/edit_news.png b/docs/images/sharenews/edit_news.png index 36e4c048..64664aff 100644 Binary files a/docs/images/sharenews/edit_news.png and b/docs/images/sharenews/edit_news.png differ diff --git a/docs/images/sharenews/error_archived.png b/docs/images/sharenews/error_archived.png new file mode 100644 index 00000000..ee5ca377 Binary files /dev/null and b/docs/images/sharenews/error_archived.png differ diff --git a/docs/images/sharenews/file_preview.png b/docs/images/sharenews/file_preview.png new file mode 100644 index 00000000..e0d6ad0f Binary files /dev/null and b/docs/images/sharenews/file_preview.png differ diff --git a/docs/images/sharenews/filter_button.png b/docs/images/sharenews/filter_button.png new file mode 100644 index 00000000..fbbd035f Binary files /dev/null and b/docs/images/sharenews/filter_button.png differ diff --git a/docs/images/sharenews/filter_drawer.png b/docs/images/sharenews/filter_drawer.png new file mode 100644 index 00000000..aad9c229 Binary files /dev/null and b/docs/images/sharenews/filter_drawer.png differ diff --git a/docs/images/sharenews/filtered_view.png b/docs/images/sharenews/filtered_view.png new file mode 100644 index 00000000..53bc848c Binary files /dev/null and b/docs/images/sharenews/filtered_view.png differ diff --git a/docs/images/sharenews/folder_path.png b/docs/images/sharenews/folder_path.png new file mode 100644 index 00000000..7d09a55e Binary files /dev/null and b/docs/images/sharenews/folder_path.png differ diff --git a/docs/images/sharenews/hared_comment_notif.png b/docs/images/sharenews/hared_comment_notif.png new file mode 100644 index 00000000..4b99d3e1 Binary files /dev/null and b/docs/images/sharenews/hared_comment_notif.png differ diff --git a/docs/images/sharenews/header_block.png b/docs/images/sharenews/header_block.png new file mode 100644 index 00000000..6ce5666e Binary files /dev/null and b/docs/images/sharenews/header_block.png differ diff --git a/docs/images/sharenews/latest_news.png b/docs/images/sharenews/latest_news.png new file mode 100644 index 00000000..a5195161 Binary files /dev/null and b/docs/images/sharenews/latest_news.png differ diff --git a/docs/images/sharenews/loadmore_application.png b/docs/images/sharenews/loadmore_application.png new file mode 100644 index 00000000..15ecf999 Binary files /dev/null and b/docs/images/sharenews/loadmore_application.png differ diff --git a/docs/images/sharenews/modified_news.png b/docs/images/sharenews/modified_news.png index d5dc80a8..9deae3c6 100644 Binary files a/docs/images/sharenews/modified_news.png and b/docs/images/sharenews/modified_news.png differ diff --git a/docs/images/sharenews/myposted_view.png b/docs/images/sharenews/myposted_view.png new file mode 100644 index 00000000..1c94bdf0 Binary files /dev/null and b/docs/images/sharenews/myposted_view.png differ diff --git a/docs/images/sharenews/myposted_view1.png b/docs/images/sharenews/myposted_view1.png new file mode 100644 index 00000000..27ea5d01 Binary files /dev/null and b/docs/images/sharenews/myposted_view1.png differ diff --git a/docs/images/sharenews/news_app.png b/docs/images/sharenews/news_app.png index 66453d77..7181f82f 100644 Binary files a/docs/images/sharenews/news_app.png and b/docs/images/sharenews/news_app.png differ diff --git a/docs/images/sharenews/news_details.png b/docs/images/sharenews/news_details.png index c7459174..fd535f58 100644 Binary files a/docs/images/sharenews/news_details.png and b/docs/images/sharenews/news_details.png differ diff --git a/docs/images/sharenews/news_leftnav.png b/docs/images/sharenews/news_leftnav.png deleted file mode 100644 index 60d02492..00000000 Binary files a/docs/images/sharenews/news_leftnav.png and /dev/null differ diff --git a/docs/images/sharenews/news_template.png b/docs/images/sharenews/news_template.png new file mode 100644 index 00000000..4eac751e Binary files /dev/null and b/docs/images/sharenews/news_template.png differ diff --git a/docs/images/sharenews/pin_activity.png b/docs/images/sharenews/pin_activity.png index 773755c3..ac1bf0eb 100644 Binary files a/docs/images/sharenews/pin_activity.png and b/docs/images/sharenews/pin_activity.png differ diff --git a/docs/images/sharenews/pin_checkbox.png b/docs/images/sharenews/pin_checkbox.png deleted file mode 100644 index b8608972..00000000 Binary files a/docs/images/sharenews/pin_checkbox.png and /dev/null differ diff --git a/docs/images/sharenews/pin_details.png b/docs/images/sharenews/pin_details.png index e5b4ed5a..8789c00d 100644 Binary files a/docs/images/sharenews/pin_details.png and b/docs/images/sharenews/pin_details.png differ diff --git a/docs/images/sharenews/pinned_view.png b/docs/images/sharenews/pinned_view.png new file mode 100644 index 00000000..851d284e Binary files /dev/null and b/docs/images/sharenews/pinned_view.png differ diff --git a/docs/images/sharenews/popup_share.png b/docs/images/sharenews/popup_share.png deleted file mode 100644 index 9b1770df..00000000 Binary files a/docs/images/sharenews/popup_share.png and /dev/null differ diff --git a/docs/images/sharenews/post_notif.png b/docs/images/sharenews/post_notif.png new file mode 100644 index 00000000..9f84243f Binary files /dev/null and b/docs/images/sharenews/post_notif.png differ diff --git a/docs/images/sharenews/posted_comment_notif.png b/docs/images/sharenews/posted_comment_notif.png new file mode 100644 index 00000000..32274710 Binary files /dev/null and b/docs/images/sharenews/posted_comment_notif.png differ diff --git a/docs/images/sharenews/posted_like_notif.png b/docs/images/sharenews/posted_like_notif.png new file mode 100644 index 00000000..f53ecc80 Binary files /dev/null and b/docs/images/sharenews/posted_like_notif.png differ diff --git a/docs/images/sharenews/posted_news.png b/docs/images/sharenews/posted_news.png index 6cdec8f7..51bb7f3c 100644 Binary files a/docs/images/sharenews/posted_news.png and b/docs/images/sharenews/posted_news.png differ diff --git a/docs/images/sharenews/resume_article.png b/docs/images/sharenews/resume_article.png index bd8735e8..e35cf3c3 100644 Binary files a/docs/images/sharenews/resume_article.png and b/docs/images/sharenews/resume_article.png differ diff --git a/docs/images/sharenews/saving_draft.png b/docs/images/sharenews/saving_draft.png index adb68cd2..44bd2e0e 100644 Binary files a/docs/images/sharenews/saving_draft.png and b/docs/images/sharenews/saving_draft.png differ diff --git a/docs/images/sharenews/search_content.png b/docs/images/sharenews/search_content.png index 6632dd12..c97ed17e 100644 Binary files a/docs/images/sharenews/search_content.png and b/docs/images/sharenews/search_content.png differ diff --git a/docs/images/sharenews/search_title.png b/docs/images/sharenews/search_title.png index 4dae87ad..9a360bbf 100644 Binary files a/docs/images/sharenews/search_title.png and b/docs/images/sharenews/search_title.png differ diff --git a/docs/images/sharenews/search_user.png b/docs/images/sharenews/search_user.png index fd4ca782..3d6b05e6 100644 Binary files a/docs/images/sharenews/search_user.png and b/docs/images/sharenews/search_user.png differ diff --git a/docs/images/sharenews/share_mynews_notif.png b/docs/images/sharenews/share_mynews_notif.png new file mode 100644 index 00000000..07d9b78f Binary files /dev/null and b/docs/images/sharenews/share_mynews_notif.png differ diff --git a/docs/images/sharenews/share_notif.png b/docs/images/sharenews/share_notif.png new file mode 100644 index 00000000..91851570 Binary files /dev/null and b/docs/images/sharenews/share_notif.png differ diff --git a/docs/images/sharenews/shared_details.png b/docs/images/sharenews/shared_details.png new file mode 100644 index 00000000..52fdb000 Binary files /dev/null and b/docs/images/sharenews/shared_details.png differ diff --git a/docs/images/sharenews/shared_like_notif.png b/docs/images/sharenews/shared_like_notif.png new file mode 100644 index 00000000..93f9ca5f Binary files /dev/null and b/docs/images/sharenews/shared_like_notif.png differ diff --git a/docs/images/sharenews/shared_message2.png b/docs/images/sharenews/shared_message2.png index 5c5392f8..a5381ebe 100644 Binary files a/docs/images/sharenews/shared_message2.png and b/docs/images/sharenews/shared_message2.png differ diff --git a/docs/images/sharenews/shared_news2.png b/docs/images/sharenews/shared_news2.png index 1be8d0a6..a1ec2a2b 100644 Binary files a/docs/images/sharenews/shared_news2.png and b/docs/images/sharenews/shared_news2.png differ diff --git a/docs/images/sharenews/shared_news_cf.png b/docs/images/sharenews/shared_news_cf.png deleted file mode 100644 index 0d510d28..00000000 Binary files a/docs/images/sharenews/shared_news_cf.png and /dev/null differ diff --git a/docs/images/sharenews/show_in_page.png b/docs/images/sharenews/show_in_page.png new file mode 100644 index 00000000..8b96a4c5 Binary files /dev/null and b/docs/images/sharenews/show_in_page.png differ diff --git a/docs/images/sharenews/success_pin.png b/docs/images/sharenews/success_pin.png index 23e46a80..27b9e45b 100644 Binary files a/docs/images/sharenews/success_pin.png and b/docs/images/sharenews/success_pin.png differ diff --git a/docs/images/sharenews/template_selector.png b/docs/images/sharenews/template_selector.png new file mode 100644 index 00000000..b0ba3686 Binary files /dev/null and b/docs/images/sharenews/template_selector.png differ diff --git a/docs/images/sharenews/unarchive_application.png b/docs/images/sharenews/unarchive_application.png new file mode 100644 index 00000000..65936129 Binary files /dev/null and b/docs/images/sharenews/unarchive_application.png differ diff --git a/docs/images/sharenews/uncorrect_video_url.png b/docs/images/sharenews/uncorrect_video_url.png new file mode 100644 index 00000000..b06d4e96 Binary files /dev/null and b/docs/images/sharenews/uncorrect_video_url.png differ diff --git a/docs/images/sharenews/unpin_activity.png b/docs/images/sharenews/unpin_activity.png index b36f1982..ce28eee5 100644 Binary files a/docs/images/sharenews/unpin_activity.png and b/docs/images/sharenews/unpin_activity.png differ diff --git a/docs/images/sharenews/unpin_details.png b/docs/images/sharenews/unpin_details.png new file mode 100644 index 00000000..b2b71b18 Binary files /dev/null and b/docs/images/sharenews/unpin_details.png differ diff --git a/docs/images/sharenews/unpin_edit.png b/docs/images/sharenews/unpin_edit.png index cfeb524b..81aa0ec9 100644 Binary files a/docs/images/sharenews/unpin_edit.png and b/docs/images/sharenews/unpin_edit.png differ diff --git a/docs/images/sharenews/unpin_icon.png b/docs/images/sharenews/unpin_icon.png deleted file mode 100644 index b12fe61a..00000000 Binary files a/docs/images/sharenews/unpin_icon.png and /dev/null differ diff --git a/docs/images/sharenews/unpin_success.png b/docs/images/sharenews/unpin_success.png index ebfbc188..5b9fe389 100644 Binary files a/docs/images/sharenews/unpin_success.png and b/docs/images/sharenews/unpin_success.png differ diff --git a/docs/images/sharenews/upload_files_form.png b/docs/images/sharenews/upload_files_form.png new file mode 100644 index 00000000..b0644061 Binary files /dev/null and b/docs/images/sharenews/upload_files_form.png differ diff --git a/docs/images/sharenews/video_creation_form.png b/docs/images/sharenews/video_creation_form.png new file mode 100644 index 00000000..245536b0 Binary files /dev/null and b/docs/images/sharenews/video_creation_form.png differ diff --git a/docs/images/sharenews/video_icon.png b/docs/images/sharenews/video_icon.png new file mode 100644 index 00000000..5f38f123 Binary files /dev/null and b/docs/images/sharenews/video_icon.png differ diff --git a/docs/images/sharenews/video_popup.png b/docs/images/sharenews/video_popup.png new file mode 100644 index 00000000..54d6c18f Binary files /dev/null and b/docs/images/sharenews/video_popup.png differ diff --git a/docs/images/sharenews/view_tab.png b/docs/images/sharenews/view_tab.png new file mode 100644 index 00000000..1f595e30 Binary files /dev/null and b/docs/images/sharenews/view_tab.png differ diff --git a/docs/images/social/CalendarPortlet.png b/docs/images/social/CalendarPortlet.png new file mode 100644 index 00000000..ebce1f08 Binary files /dev/null and b/docs/images/social/CalendarPortlet.png differ diff --git a/docs/images/social/CalendarPortletPopulated.png b/docs/images/social/CalendarPortletPopulated.png new file mode 100644 index 00000000..283e663f Binary files /dev/null and b/docs/images/social/CalendarPortletPopulated.png differ diff --git a/docs/images/social/Description_portlet.png b/docs/images/social/Description_portlet.png new file mode 100644 index 00000000..44d5d3f4 Binary files /dev/null and b/docs/images/social/Description_portlet.png differ diff --git a/docs/images/social/WhoIsOnLinePortlet.png b/docs/images/social/WhoIsOnLinePortlet.png new file mode 100644 index 00000000..850a13a0 Binary files /dev/null and b/docs/images/social/WhoIsOnLinePortlet.png differ diff --git a/docs/images/social/arrowsCalendar.png b/docs/images/social/arrowsCalendar.png new file mode 100644 index 00000000..4207c5fb Binary files /dev/null and b/docs/images/social/arrowsCalendar.png differ diff --git a/docs/images/social/editPage.png b/docs/images/social/editPage.png new file mode 100644 index 00000000..87540c73 Binary files /dev/null and b/docs/images/social/editPage.png differ diff --git a/docs/images/social/space_avatar_update.png b/docs/images/social/space_avatar_update.png index 37930d16..454a578d 100644 Binary files a/docs/images/social/space_avatar_update.png and b/docs/images/social/space_avatar_update.png differ diff --git a/docs/images/social/space_navigation_bar.png b/docs/images/social/space_navigation_bar.png index 977bdea1..f49c60fc 100644 Binary files a/docs/images/social/space_navigation_bar.png and b/docs/images/social/space_navigation_bar.png differ diff --git a/docs/images/social/update_banner.png b/docs/images/social/update_banner.png index 9ba91308..588994cd 100644 Binary files a/docs/images/social/update_banner.png and b/docs/images/social/update_banner.png differ diff --git a/docs/images/social/update_reset_space_icon.png b/docs/images/social/update_reset_space_icon.png index 71ad7d98..62c5ebd2 100644 Binary files a/docs/images/social/update_reset_space_icon.png and b/docs/images/social/update_reset_space_icon.png differ diff --git a/docs/images/whatsNew/Badges.png b/docs/images/whatsNew/Badges.png new file mode 100644 index 00000000..28d5031e Binary files /dev/null and b/docs/images/whatsNew/Badges.png differ diff --git a/docs/images/whatsNew/HomeButtonchat.png b/docs/images/whatsNew/HomeButtonchat.png new file mode 100644 index 00000000..72129780 Binary files /dev/null and b/docs/images/whatsNew/HomeButtonchat.png differ diff --git a/docs/images/whatsNew/Kudos.png b/docs/images/whatsNew/Kudos.png new file mode 100644 index 00000000..21fde3c4 Binary files /dev/null and b/docs/images/whatsNew/Kudos.png differ diff --git a/docs/images/whatsNew/OnlyOffice.png b/docs/images/whatsNew/OnlyOffice.png new file mode 100644 index 00000000..e8b15fff Binary files /dev/null and b/docs/images/whatsNew/OnlyOffice.png differ diff --git a/docs/images/whatsNew/PerkStore.png b/docs/images/whatsNew/PerkStore.png new file mode 100644 index 00000000..88e7146c Binary files /dev/null and b/docs/images/whatsNew/PerkStore.png differ diff --git a/docs/images/whatsNew/SpaceWidgets.png b/docs/images/whatsNew/SpaceWidgets.png new file mode 100644 index 00000000..293ed921 Binary files /dev/null and b/docs/images/whatsNew/SpaceWidgets.png differ diff --git a/docs/images/whatsNew/Wallet.png b/docs/images/whatsNew/Wallet.png new file mode 100644 index 00000000..33ef15e2 Binary files /dev/null and b/docs/images/whatsNew/Wallet.png differ diff --git a/docs/images/whatsNew/chat_accents.png b/docs/images/whatsNew/chat_accents.png new file mode 100644 index 00000000..143c0041 Binary files /dev/null and b/docs/images/whatsNew/chat_accents.png differ diff --git a/docs/images/whatsNew/gamificaton_board.png b/docs/images/whatsNew/gamificaton_board.png new file mode 100644 index 00000000..6b25ff2e Binary files /dev/null and b/docs/images/whatsNew/gamificaton_board.png differ diff --git a/docs/whatsnew.rst b/docs/whatsnew.rst index b5b6c203..86f273e7 100644 --- a/docs/whatsnew.rst +++ b/docs/whatsnew.rst @@ -18,117 +18,123 @@ and voting for the new features. Functional features ~~~~~~~~~~~~~~~~~~~~ -:ref:`Spaces Administration ` +:ref:`Gamification ` -With the spaces administration feature, administrators now have a way to define: - -- Who can create new spaces -- Who can manage spaces +Enhance your collaborators' engagement and motivate them to adopt a positive behavior with our gamification add-on. |image0| +|image2| + -:ref:`Edit activities and comments ` +:ref:`Rewards ` -Users can now edit their own activities and comments in the activity stream. +Discover our rewarding system allowing to recognize employees engagement through digital wallet, kudos and perk store. |image1| +|image3| + +|image4| -:ref:`Empty choice for gender field ` -Users can now decide to not indicate their gender on their profile. +:ref:`OnlyOffice Connector ` +eXo partenered with OnlyOffice editors to allow users the co-editing of MS Office documents. + +|image5| -:ref:`Mark all as read in All Notifications page ` -Users can now mark all their on-site notifications as read with a single click. +:ref:`Company branding ` -|image2| +Brand your eXo Platform server by setting your company logo easily. +|image6| -:ref:`Number of unread messages in the browser tab ` -The number of unread chat messages is now dynamically added to the page title -so that users can easily know when there is something requiring their attention just -by looking at their browser tab. +:ref:`Space templates ` +With space templates feature, create a space with the template which the most matches your needs -|image3| +|image7| -:ref:`Reset the default avatar or banner ` -Users can now reset their profile banner and picture by reverting to the default one. -It is also applicable for spaces' banners and logos. +:ref:`Space widgets ` -|image4| +New widgets are available on spaces' homepages to display descriptions, managers and events. + +|image8| Other user experience improvements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:ref:`Search bar filter in chat ` +:ref:`Home button in Desktop Chat application ` -Clear more easily the search filter in chat rooms, simply -by clicking on the cross icon. +A new ``home`` button was added to the chat application on Desktop to easily go back the platform's homepage. -|image5| +|image9| -:ref:`Create event drawer ` +:ref:`Confirm before refreshing a page ` -Creating a new event has been redesigned as an elegant drawer panel for better usability: +A confirmation popup appears when refreshing a page where you already typed some data. -|image6| +|image10| -:ref:`Unread messages badge in mini chat ` +:ref:`Open space applications by right-click ` -Keep track of unread messages that arrive while you've scrolled up. +It is now possible to open space applications in an another tab with a right-click. -|image7| +:ref:`Chat contacts filtering does not consider accents ` -We also tweaked some UIs : +Chat contact filtering is not sensitive to accents anymore. -- Added more spacing at the left and right of the activities for a better readability. -- Unified the "Show more" button with the new style used across eXo Platform. +|image11| + +:ref:`Login History can now be disabled by configuration ` + +With the new property ``exo.audit.login.enabled``, it is possible to enable or disable the login history. + +:ref:`Remove uploaded files from chat ` + +Files uploaded in chat rooms can now be deleted as any other message. -.. _TechnicalNovelties: ======================================== Technical novelties in eXo Platform 5.3 ======================================== -**Security** - -Our continuous effort to improve security lead us to -change some default permissions to avoid folder listing cases through WebDAV. +As usual, eXo Platform continues to devote efforts to enhance security and performance. +In fact, in eXo Platform 5.3, new :ref:`parameters ` has been introduced to configure max +concurrent requests to the ElasticSearch server. -**Platform RDBMS** +We also upgraded UI layer with latest versions of Vue.js and Vuetify frameworks. +We invite you to read the whole tutorial to develop portlets in eXo with Vuetify and Vue.js +in :ref:`this tutorial `. -We continued to decrease our dependency on JCR -for data persistence. Now, the following components rely on the relational -**database** storage for better speed and manageability : +In version 5.3, eXo Platform decided to remove `Shindig `__, +the component used to support Gadgets. +In fact `Shindig `__ is no more maintained and this leads to many issues such as: -- Product information -- Login history -- Wiki -- Files -- Social -- Notifications -- Email queue -- Settings +- The dependance to specific versions of some important libraries namely Guava and which is hard to upgrade +- Hardness with the platform server installation as it needs specific actions to make gadgets working -You can learn more about all data structures in -:ref:`this tutorial `. +In addition to all the above issues, maintaining and fixing issues related to gadgets and `Shindig `__ +took too much time to resolve however it is no more used. -.. |image0| image:: images/platform/SpacesAdministration.png -.. |image1| image:: images/platform/delete_edit.png -.. |image2| image:: images/social/MArkAllRead.png -.. |image3| image:: images/social/Notifications_Web_tab.png -.. |image4| image:: images/social/update_reset_banner.png -.. |image5| image:: images/chat/filter_3.png -.. |image6| image:: images/calendar/Add_event_drawer.png -.. |image7| image:: images/chat/unread_chat_msg.png +.. |image0| image:: images/whatsNew/gamificaton_board.png +.. |image1| image:: images/whatsNew/Wallet.png +.. |image2| image:: images/whatsNew/Badges.png +.. |image3| image:: images/whatsNew/Kudos.png +.. |image4| image:: images/whatsNew/PerkStore.png +.. |image5| image:: images/whatsNew/OnlyOffice.png +.. |image6| image:: images/platform/branding_page.png +.. |image7| image:: images/social/add_space_settings_tab.png +.. |image8| image:: images/whatsNew/SpaceWidgets.png +.. |image9| image:: images/whatsNew/HomeButtonchat.png +.. |image10| image:: images/platform/confirmation_popup_Chrome.png +.. |image11| image:: images/whatsNew/chat_accents.png