Control Panel
v3.5
ONLYOFFICE Control Panel changelog
Version 3.5.2
Release date: 02/29/2024
- Added the ability to restrict access rights to the application files for the Others group.
- Fixed issue with redirect to the portal main page when opening Control Panel after a day on Ubuntu 22.10.
- Fixed retrieving data error when opening the backup page.
- Fixed issue when backup with Mail is not performed after disabling and enabling encryption (added text about stopping services and the instruction to the Help Center).
- Fixed issue when features are not saved to the new tariff when setting a quota for the portal.
- Edited sources build.
Version 3.5
Release date: 03/14/2023
- Changed API methods for migration, implemented progressQueue.
- Changed settings for connecting third-party storages. Added tooltips for fields. Added the 'Server Side Encryption Method' block for Amazon AWS S3.
- Added logos for dark theme in the Branding section. Logos for the About page are now separate fields in the Advanced tab.
- Added the ability to set the portal memory quota.
Version 3.1.1
Release date: 08/08/2022
- Fixed issue with file indexing.
- Fixed elasticsearch container errors when updating ONLYOFFICE Groups.
- Fixed issue with brand logos after updating in the Docker installation.
- Fixed texts and layout for the Migration feature.
Version 3.1
Release date: 05/25/2022
- Added the Data Import page that allows to import data from Nextcloud, ownCloud and GoogleWorkspace to ONLYOFFICE Workspace.
- Moved Elasticsearch to a separate container.
- Fixed bugs.
Version 3.0
Release date: 06/07/2021
- License agreement dialog when installing docker components added.
- The inactive button with an action for uninstalled components (downloading and installing the available version) fixed.
- Indexing progress display added.
- New checks when restoring data from a local or a 3rd party storage.
- SSOAuth was removed from Control Panel. It's now available as a portal setting in Community Server.
- Bugs 47721, 49101, 49187, 49273, 49272, 49324, 46386, 49585 from the internal bugtracker fixed.
- 3rd party licenses and copyright updated.
Version 2.9.1
Release date: 12/10/2020
- Bug Fixes & Performance Improvements.
Version 2.9
Release date: 10/14/2020
- Control Panel is available in the free Community version with all settings excepting the editors logo replacement;
- Added the vsyscall check to the installation scripts when installing Mail Server on Debian with kernel 4.18.0 and later;
- Redesign of the navigation menu: added Common and Portal settings sections, added icons to menu items;
- Added the advanced rebranding page in the Common Settings;
- Added the possibility to reindex the full-text search;
- Updated
node.js, updated packages (transition to samlify for SSO);
- Added the Encryption at rest block in the Storage section;
- Added the Private Room section for the server version only;
- Added the
upgrade page with a proposal to upgrade to Enterprise Edition;
- Added the
activate page with a possibility to upload a license file;
- Added the HideAuthPage option to the SSO settings to hide the authorization page. When the HideAuthPage option is enabled, an automatic redirect from the authorization page to the SSO service will occur.
- Added the Sign in to domain option on the authorization page.
- Transition to the new
samlify library;
- Added the HideAuthPage option to the SSO settings to hide the authorization page. When the HideAuthPage option is enabled, an automatic redirect from the authorization page to the SSO service will occur.
Version 2.7
Release date: 04/25/2019
- Added more fields mapped for the users loaded via LDAP: user photo, birthday, contacts, primary phone number;
- Added the setting to autosync LDAP on schedule;
- Added the possibility to give administrator rights to the user group at the portal via LDAP;
- Updated the rules for LDAP users.
Version 2.5.1
Release date: 04/07/2018
- Fixed the
Server internal error error when using the groups enclosed inside each other in the AD (bug #37414).
- Fixed the issue when the user data between the Service Provider and the portal was transferred via HTTP only, even when HTTPS was enabled.
Version 2.4.0
Release date: 01/13/2018
- Fixed the
Invalid ssoConfig error which occurred when the link to the IdP contained the question mark '?', e.g.: IdP Single Sign-On Endpoint URL: https://accounts.google.com/o/saml2/idp?idpid=777777;
- Fixed the
Invalid authentication token error which prevented from adding a user to the portal using the AD FS, in case the + or - characters were present when sending the encrypted data.
Version 2.3.0
Release date: 12/15/2017
- Added the changelog for Control Panel and link to it;
- Fixed the bug when JWT parameters were not sent when updating Document Server(bug #36270);
- Fixed the bug when
Audit Trail heading was present at the login history page (bug #36026);
- The current machine is now checked for being linked with the domain name for multiple portals.
- Fixed the bug with the
LDAP Domain not found error which occurred if the DN record had no DC records (the users with Sun/Oracle DS were affected); now if the LDAP domain could not be specified, the LDAP domain will acquire the unknown value or the ldap.domain value from the web.appsettings.config configuration file;
- Fixed the bug with the
Sizelimit Exceeded error when trying to get more than 1000 users from the Active Directory;
- Increased the login speed with the Group Membership setting enabled;
- Added additional logging;
- Fixed the bug with LDAP operation hanging when using Mono v5.2.0 and older;
- Fixed the bug with the error when trying to login using the email address entered in the fields different from the
Mail Attribute;
- Fixed the bug occurring in the enclosed groups, when the users were displayed not in all groups.
Version 2.2.0
Release date: 10/31/2017
- Added the
documentserver-prepare4shutdown.sh script launch when updating the document-server for the correct edited document saving.
- Dramatically changed LDAP integration, migrated to the single library for the work with LDAP (Novell.Directory.Ldap.NETStandard, Nuget, MIT);
- Login and email are now split into two separate fields;
- Added the support for big data;
- Increased the work speed via the LDAP protocol (the connection to the server and receiving the data is now made once per session, added the limits when only a certain number of results is necessary, fixed the slow login for bit data, removed the sorting out used to find the SID parameter);
- Fixed the user re-creation issue;
- Fixed the duplicate username issue;
- Fixed the already existing email issue;
- Replaced the LDAP user deletion with account deactivation (for further data migration and data safety);
- Instead of re-creating a user with an unknown SID but an existing email the data is updated;
- Added the attempt to save the correct UserName/Login in case a similar one is already taken on the portal.
- Added the AD FS support;
- Replaced the Single Sign-on link at the authorization page with the customizable button, added the button customization to the SSO setting of the Control Panel.
Version 2.1.0
Release date: 07/03/2017
- Added the support of letsencrypt service for the domain certificate generation.
- Added the new
sso.auth service;
- Added the new SSO settings page;
- Added the support for Shibboleth.
Version 2.0.0
Release date: 05/25/2017
- The Control Panel migrated from
MVC to Node.js.
Version 1.6.0
Release date: 12/05/2016
- Added LDAP synchronization for users and groups when saving the settings, after login and using the Sync button;
- Changed email formation for LDAP users;
- Fixed the problem of creation of users with invalid emails;
- Fixed the problem of duplicate users;
- Added icons and hints to the users in the list for the admin;
- Blocked for editing the user profile fields imported using LDAP;
- Added the real LDAP password saving to the database during login in case LDAP Auth is disabled, now the LDAP users will become common portal users when LDAP Auth is disabled;
- Added new API Settings method - Sync LDAP;
- Added new translations;
- Bug fixes.
- Made changes at the Update page for the Control Panel for Windows;
- Updates are performed using the downloaded installation packages for each module.
- The current installed component version numbers are obtained via API request to the Community Server.
- The new versions available for download are obtained via the request to the https://download.onlyoffice.com/install/windows/updates.txt file, where all the latest component version numbers and links for their download are stored in the JSON format.
Introduction
Single Sign-on (SSO) is a technology that allows users to sign in only once and then get access to multiple applications/services without re-authentication.
If a web portal includes several large independent sections (forum, chat, blogs etc.), a user can undergo the authentication procedure within one of the services and automatically get access to all other services without entering credentials several times.
SSO is always ensured by the joint operation of two applications: an Identity Provider and a Service Provider (hereinafter referred to as "IdP" and "SP"). ONLYOFFICE SSO implements the SP only. A lot of different providers can act as an IdP, but this article considers the OneLogin implementation.
If you want to use SSO when connecting ONLYOFFICE Desktop Editors to your ONLYOFFICE Workspace, disable Private Rooms in the Control Panel.
Preparing ONLYOFFICE Workspace for the SSO setup
- Install ONLYOFFICE Workspace v. 11.0.0 for Docker or any later version with the SSO support.
- Add a domain name, e.g., myportal-address.com.
- On your portal, go to the Control Panel -> HTTPS, create and apply the letsencrypt certificate for the traffic encryption (to enable HTTPS on your portal).
Creating an IdP in OneLogin
- Sign up for OneLogin, if you have not yet registered.
- Sign in to OneLogin as an administrator.
- Go to the Administration section.
- Click the Applications menu. Click the Add App button.
- In the Find Application search field, type in the following text: SAML Custom Connector (Advanced):
- Select the found option.
- In a new window that opens, enter any Display Name, for example, "IDP OneLogin Onlyoffice v11 Test", to distinguish this application from others, replace icons with your own ones and click the Save button.
- Go to the Configuration submenu and fill in the fields according to the table below:
Please specify your own domain name or public IP where your ONLYOFFICE SP is hosted instead of myportal-address.com.
- Click the Save button and go to the Parameters submenu.
- Use the + button to create 5 parameters (
givenName, sn, mail, title, mobile). Check the Include in SAML assertion option and specify a value from the Value list, suitable for issuing from the field catalog of the LDAP directory, for all of them:
- Once you fill in all the necessary fields for SAML assertion attributes in the IdP, you should receive nearly the same result as shown in the figure below. Click the Save button.
- Go to the SSO submenu. Choose a valid certificate from the certificate list by clicking the Change link, if you have several certificates. In the SAML Signature Algorithm field, leave the SHA-1 option and click the Save button:
- Copy the link from the Issuer URL field (e.g., https://app.onelogin.com/saml/metadata/4d87973f-629d-4a52-812e-bde45eff92b8) and go to the ONLYOFFICE portal signing in as an administrator. Open the Control Panel -> SSO page.
- Make sure that you are signed in as an Administrator to your ONLYOFFICE Control Panel and click the SSO tab in the PORTAL SETTINGS section on the left sidebar.
You can only register one enterprise Identity Provider for your organization on the ONLYOFFICE portal.
- Enable SSO using the Enable Single Sign-on Authentication switcher and paste the link copied from the OneLogin issuer URL into the URL to Idp Metadata XML field.
Press the button with the upward arrow to load the IdP metadata. The ONLYOFFICE SP Settings form will be automatically filled in with your data from the OneLogin IdP.
- In the Custom login button caption field, you can enter any text instead of the default one (Single Sign-on). This text will be displayed on the button used to login to the portal with the Single Sign-on service at the ONLYOFFICE authentication page.
- Now you need to create a certificate in the SP Certificates section. To do that, click the Add certificate button in the corresponding section.
- In the opened modal window, click the Generate New Self-Signed Certificate link, choose the signing and encrypt option in the Use for list. Before you save the certificate, copy the Public Certificate text to the clipboard (it will be necessary for OneLogin), then click the OK button.
- You should get nearly the same result:
- It is not necessary to adjust the Attribute Mapping form, since we specified the same parameters when creating OneLogin IdP. The following values are used:
| First Name |
givenName |
| Last Name |
sn |
| Email |
mail |
| Location |
l |
| Title |
title |
| Phone |
mobile |
In the Advanced Settings section, you can check the Hide auth page option to hide the default authentication page and automatically redirect to the SSO service.
ImportantIf you need to restore the default authentication page (to be able to access the portal if you your IDP server fails), you can add the /Auth.aspx?skipssoredirect=true key after the domain name of your portal in the browser address bar.
- Click the Save button. The ONLYOFFICE SP Metadata section should be opened. Verify that our settings are publicly available by clicking the Download SP Metadata XML button. The XML file contents should be displayed.
- Return to OneLogin to set up encryption, open your application and go to the Configuration setting. Scroll down the page - the new SAML Encryption field for entering an encryption key should appear. Paste the copied Public Certificate text from the step 4 of this instruction into this field and click the Save button:
Creating users in OneLogin and giving them access to ONLYOFFICE
To create users in OneLogin and provide them access to our ONLYOFFICE SP, perform the following steps:
- go to the OneLogin All Users page signing in as an administrator,
- create a new user or edit an existing one,
- go to the Applications submenu and click the + button,
- select our newly created application from the list and click CONTINUE,
- in a new window that opens add the missing data and click the SAVE button,
- now the user is able to work in ONLYOFFICE SP.
Checking the work of the ONLYOFFICE SP with the OneLogin IdP
Logging in to ONLYOFFICE on the SP side
- Go to the ONLYOFFICE Authentication page (e.g., https://myportal-address.com/Auth.aspx).
- Click the Single sign-on button (the caption may differ if you have specified your own text when configuring ONLYOFFICE SP). If the button is missing, this means that SSO is not enabled.
- If all the SP and IdP parameters are set correctly, we will be redirected to the OneLogin IdP login form:
- Enter the login and password of the user who has been granted access to the ONLYOFFICE SP and click the LOG IN button.
- If the credentials are correct, we will be redirected to the main page of the portal (the user will be created automatically if missing, or the data will be updated if changed in the IDP).
Logging out from ONLYOFFICE SP
- An SSO user can log out from the ONLYOFFICE portal using the Sign Out menu. The user should also be automatically logged out from the OneLogin IdP in case he/she is logged out from all other applications that he/she has been granted access to in OneLogin and that he/she previously signed in to.
- If you signed out successfully, you will be redirected to the portal authentication page.
- If you click the Single Sign-on button once again, you will be redirected to the OneLogin login page again (this means that you successfully logged out from the portal):
Profiles for users added with SSO authentication
The possibility to edit user profiles created using the SSO authentication is restricted. The user profile fields received from the IdP are disabled for editing (i.e. First Name, Last Name, Email, Title and Location). You can edit these fields from your IdP account only.
The figure below shows the Actions menu for an SSO user:
The following figure shows an SSO user profile opened for editing:
The users created using the SSO authentication are marked with the SSO icon in the user list for the portal administrators: