Articles with the tag:
Close
Changelog
Close
Try in the cloud
Try in the cloud
  • All
  • Overview
  • Customizing portal
  • Managing portal modules
  • White Labeling
  • Controlling portal access
  • Managing access rights
  • Tracking login history
  • Receiving audit trail data
  • Changing portal region
  • Creating/restoring backup
  • Deactivating/deleting portal
  • Adjusting Integration settings
  • Adjusting SMTP settings
  • Viewing portal statistics

Overview

Once your portal is created, you will need to customize and manage it so that it fitted your needs. This can be done in the portal Settings section.

To access the Settings from any portal page, click the Settings Icon icon at the top of the page or use the drop-down list in the top left corner and select the corresponding option.

You can perform the following operations via the portal Settings section:

Common settings

Security settings

Data Management settings

  • change the region of the server where your portal is hosted;
  • create and restore the portal data backup;
  • temporarily deactivate or even delete the portal forever;

Integration settings

Statistics settings

  • see the main portal statistics: creation date, total number of users, storage space used by various modules and users, user attendance.

Common settings

The Common settings section opens by default. It allows you to adapt the appearance of the portal to your needs and choose the modules you wish to use. It includes three subsections: Customization, Modules & Tools and White Label.

Customizing portal

The Customization subsection of the Common settings allows you to change the look and feel of your portal. You can use your own company logo, name and text to match your organization brand.

Customizing Portal Customizing Portal
Language and time zone settings

This section allows you to change the language of the whole portal for all portal users and to configure the time zone so that all the events of the portal will be shown with the correct date and time.

To configure the Language and Time Zone settings,

  • drop-down the Language list and select the required language to display all portal pages and notification,
    This setting specifies the default portal language for new users. Each user can change the default language later by selecting the preferred one on their profile page (this setting will have a higher priority than the language selected in the Common Settings).

    At present the online office is available in 23 languages: English, German, French, Spanish, Russian, Italian, Latvian, Portuguese (Brazilian), Turkish, Greek, Polish, Czech, simplified Chinese, Ukrainian, Vietnamese, Finnish, Portuguese, Azeri, Korean, Japanese, Slovenian, Dutch and Slovak. If your language is not yet present in the list of the available ones or the translation to your language is not complete, you may contribute to the translation sending your request at documentation@onlyoffice.com.

  • set the time zone that corresponds to your location from the Time Zone drop-down list,
  • click the Save button at the bottom of the section to apply the changes you made.
Welcome Page Settings

This section allows you to change the default title to be displayed on the Sign In page of your portal. To do that,

  • enter the name you like in the Title field (e.g. your company title, its motto, etc.),
  • click the Save button at the bottom of the section to apply the changes you made.
The same name is also used for the From field of your portal email notifications.
DNS settings

This section allows you to set an alternative URL for your portal. By default, your portal is registered at name.onlyoffice.com. To change it to your own domain name:

  1. Configure your domain name to point to the online office server by setting up the appropriate DNS records with your registrar. Please contact your registrar from whom you purchased the domain name to find out how to do it. Add a DNS CNAME entry, such as, for example: team.ourcompany.com - intranet.onlyoffice.com (for the US West (Oregon) region), intranet.onlyoffice.eu (for the EU (Frankfurt) region), or intranet.onlyoffice.sg (for the Asia Pacific (Singapore) region).
  2. After setting up your DNS CNAME entry, click the Send request button in the DNS settings section to send your request to our support team. The https://helpdesk.onlyoffice.com/ page will open in a new browser tab. Enter the details of your request and click Submit.
    In addition to setting up your custom domain, our specialists can also generate an ssl certificate using letsencrypt.
  3. After the request is processed, your custom domain name will be displayed in the DNS settings section.
Portal renaming

This section allows you to change the name part of your portal URL address name.onlyoffice.com so that your portal is available at newname.onlyoffice.com. Enter the desired name in the New portal name field and click the Save button.

Once you click the Save button, your old portal name will become available to new users who want to register a new portal.
Team template

This section allows you to name the organization (or group), its members and their activities within your portal. To do that,

  • choose one of the available presets from the Template drop-down list,

OR

  • select the Custom option from the list and enter the names yourselves in the fields below,
  • click the Save button at the bottom of the section to apply the changes you made.
Color themes

This section allows you to change the default color palette of your portal interface so that it suits your company brand. To do that,

  1. switch between the available Color Themes to preview them: Mellow green, Dark green, Deep blue, Wild pink, Bright blue,
  2. select the one which suits you best,
  3. click the Save button to apply the selected color theme.

To return to the default color theme, click the Pure orange radiobutton and save your changes.

Managing portal modules

The Modules & Tools subsection of the Common settings gives you the access to the list of portal modules and tools and the ability to manage them. To do that,

  • leave checked the necessary modules and tools and uncheck those you don't need for your work,

    Starting from v12.0, the Community module is disabled by default for newly created installations and cloud portals. It can be enabled in this section of the settings. It's also possible to manage the tools for your social network within the Community module checking those you need.

  • click the Save button at the bottom of the section to apply the changes you made.

The disabled modules and tools will be hidden from all portal users.

After enabling the modules and tools again they will become available for all portal users as well. To restrict the access, refer to the Access Rights section of the portal Settings.
Managing Portal Modules Managing Portal Modules
Custom Navigation

This section allows you to add your own items into the portal navigation menu for a greater portal usability. E.g. you can add links to some other websites, services etc.

To add a new menu item:

  1. Click the Add Item link in the Custom Navigation section. A new window opens.
    Adding custom menu items Adding custom menu items
  2. Enter the menu item title in the Label text entry field.
  3. Specify the link to the necessary resource in the URL field.
    Please note, that if your site is using HTTPS, all the links must also be in HTTPS, otherwise the warning will be displayed in the browsers.
  4. The Show in menu and Show on home page options are selected by default. You can uncheck one of them if necessary.
  5. Replace the default icons with your own ones. The Small icon, 16x16 will be used in the navigation menu located in the portal header. The Large icon, 100x100 will be displayed on the portal start page. Click the corresponding Change image link below to upload a new image.
  6. When ready, click the Save button.

The newly created navigation item will be added to the navigation menu and/or to the portal start page depending on the specified settings. It will also be displayed below the Custom Navigation title on the portal settings page. To edit the item, click the Settings Icon Settings icon next to it. In the Item Settings window, change the necessary parameters and click the Save button. If you want to remove the added navigation item, use the Remove Item button in the Item Settings window.

Default start page

This section allows you to choose the page you go to right after you log in to the portal or click the online office logo when you have already signed in. You can select one of the following options:

  • one of the portal modules (Documents, Projects, CRM, Community, People),
  • one of the tools (Mail, Talk, Calendar),
  • the Feed page,
  • the default Module Choice page.

Just check the corresponding radiobutton and click the Save button at the bottom of the section to apply the changes you made.

Pricing Page Settings

This section allows you to determine whether the pricing page should be accessible for all portal users or for administrators only.

Check the Pricing page available for administrators only box to make this page visible for portal administrators only and click the Save button at the bottom of the section to apply the changes you made.

White Labeling
This option is available for paid portals only.

The White Label subsection of the Common settings allows you to replace branding elements used in the online office interface with your own ones. You can use your company name in the text elements (such as tooltips, message boxes, etc.) as well as replace the default favicon and logos with your own logo. To do that,

  • Enter your Company name in the text entry field to change all the titles and messages in the online office interface where the default value is used replacing it with the one you specified. Click the Use as logo button below the entry field if you want to use your company name as a text logo (instead of an image logo) - all the logos below will change correspondingly.
  • Replace all the image Logos which appear in the online office:
    • Logo for the portal header (284x46) - this logo appears in the upper left corner of every portal page.
    • Logo for the Login page - light theme (432x70) - this logo appears on the Sign In page of the portal, is used if the light theme is enabled.
    • Logo for the Login page - dark theme (432x70) - this logo appears on the Sign In page of the portal, is used if the dark theme is enabled.
    • Favicon (32x32) - this logo appears in the address bar or tab of a web browser when the portal is opened in it, or on the bookmarks panel if you've added the portal address to the bookmarks.
    • Logo for the editors header (172x40) - this logo appears in the upper left corner of the online editors launched. The first, second and third logos are used for document, spreadsheet and presentation editors correspondingly if the light theme is enabled, the fourth logo is used for all editors if the dark theme is enabled.
    • Logo for the editors header - embedded mode (172x40) - this logo appears in the upper left corner of your portal documents embedded into web pages.

    Click the Change Logo link below the logo you want to replace. In the Windows Explorer window, browse for the necessary image file and click the Open button. The image will be uploaded and displayed in the corresponding Logo field.

    We recommended that you use images in the PNG format with a transparent background. To improve your logos legibility and make their outline clearly distinguishable, you also need to optimize them for use on dark or light backgrounds. The image sizes are shown for the Retina displays. For the displays with standard resolutions, the logo width and height will be resized accordingly upon upload.
  • click the Save button at the bottom of the section to apply the changes you made.

To return to the default settings, click the Restore to Default button.

White Labeling White Labeling

Security settings

The Security section allows you to control access to your portal and monitor the activity of all users. It includes four subsections: Portal Access, Access Rights, Login History and Audit Trail.

Controlling portal access

The Portal Access subsection of the Security settings allows you to provide users with secure and convenient ways to access the portal.

Changing Portal Access Settings Changing Portal Access Settings
Password strength settings

This section allows you to determine password complexity (the effectiveness of a password in resisting guessing and brute-force attacks). To do that,

  • use the Password length range bar to determine how long the password should be to be considered strong,

    By default, the password must be at least 8 but no more than 120 characters long.

  • check the appropriate boxes below the bar to determine the character set that must be used in the password: capital letters, digits, special characters,
  • click the Save button at the bottom of the section to apply the changes you made.
Two-factor authentication

This section allows you to enable two-step verification with SMS or authenticator apps that ensures more secure portal access.

For the SaaS version, the SMS provider used on your portal is selected depending on the portal region: smsc is used for CIS, Clickatell and Twilio are used for all other regions. You can add available SMS providers in the Settings -> Integration -> Third-Party Services section.
If you are using the server version, you first need to connect at least one SMS provider in the Settings -> Integration -> Third-Party Services section so that you can enable the Two-factor authentication option.

To enable two-factor authentication with SMS,

  1. make sure that one of the SMS providers is connected in the Integration section,
  2. check the By SMS radiobutton under the Two-factor authentication section,
  3. for specifying detailed settings, you can use advanced settings. Click Show Advanced Settings and set the necessary options:
    • in the Mandatory Two-factor authentication section, you can add users or groups for which two-factor verification will be performed even if the user comes from a trusted IP. For other users who are not included into the Trusted Networks list, two-factor verification is performed as usual.
    • in the Trusted Networks section, you can add trusted IP addresses for which two-factor verification will not be performed. Specify separate IP addresses in the IPv4 format (#.#.#.#, where # is a numeric value from 0 to 255), or set an IP addresses range by entering the starting and ending IP addresses of the range in the #.#.#.#-#.#.#.# format, or use CIDR masking in the #.#.#.#/# format.
  4. click the Save button at the bottom of the section to apply the changes you made.

When two-factor authentication with SMS is enabled, a user can access the portal data after entering their regular email and password or signing in via a social media account and typing in a six-digit verification code received via SMS.

The SMS messages are sent to the user primary mobile phone which is specified during the first portal login via two-factor authentication and later can be changed on the user profile page. A verification code can be resent by clicking the Send code again button, but no more often than 5 times per 5 minutes. The sent code is valid for 10 minutes.

SMS messages can be sent if you have a positive balance only. You can always check your current balance in your SMS provider account. Do not forget to replenish your balance in good time.

To enable two-factor authentication with an authenticator app,

  1. check the By authenticator app radiobutton under the Two-factor authentication section,
  2. for specifying detailed settings, you can use advanced settings. Click Show Advanced Settings and set the necessary options:
    • in the Mandatory Two-factor authentication section, you can add users or groups for which two-factor verification will be performed,
    • in the Trusted Networks section, you can add trusted IP addresses for which two-factor verification will not be performed. Specify separate IP addresses in the IPv4 format (#.#.#.#, where # is a numeric value from 0 to 255), or set an IP addresses range by entering the starting and ending IP addresses of the range in the #.#.#.#-#.#.#.# format, or use CIDR masking in the #.#.#.#/# format.
  3. click the Save button at the bottom of the section to apply the changes you made.

When two-factor authentication with an authenticator app is enabled, a user can access the portal data after entering their regular email and password or signing in via a social media account and typing in a six-digit verification code or a backup code generated by the authenticator app.

To access the portal for the first time after enabling two-factor authentication:

  1. Enter your regular credentials to access the portal. The QR code and your secret key are displayed on your portal login confirmation page.
  2. Install an authenticator app on your mobile device. You can use Google Authenticator for Android and iOS or Authenticator for Windows Phone.
  3. Open the authenticator app on your mobile device and configure it in one of the following ways:
    • Scan the QR code displayed in the browser, or
    • Manually enter your secret key displayed in the browser,
  4. On your portal login confirmation page, enter a 6-digit code generated by your application.
  5. Click the Connect app button.

To learn more on how to use two-factor authentication on your portal, you can read the following article.

Trusted mail domain settings

This section allows you to specify the mail servers used for user self-registration on your portal. By default, this option is disabled. To enable it,

  • check the Custom domains radiobutton,
  • enter the trusted mail server in the field which appears below,
  • check the Add users as guests box if you wish the added users to get the view-only permissions,
  • click the Save button at the bottom of the section to apply the changes you made.

To add more mail servers, use the Add trusted domain link. To delete a server added by mistake, click the corresponding Remove Icon icon to the right of the field.

After that, any user who has an account at a specified mail server will be able to register on their own by clicking the Click here to join link on the Sign In page and entering the email address. An invitation email with a link to the portal will be sent to the specified email address. To sign in, the user will need to follow the link provided in the email, enter a password and confirm it.

To disable this option again, just check the Disabled radiobutton.

IP security settings

This section allows you to prevent unwanted visitors from accessing your portal by allowing access to the portal from trusted networks only. If a user attempts to log in to your portal from any IP address except those you specify, this login attempt will be blocked. To restrict access to your portal based on the IP addresses,

  1. check the Enable radio button;
  2. click the Add allowed IP address link in the necessary section:
    • For all users - this section allows you to set rules which are applied to all users including full access administrators.
    • For full access administrators - this section allows you to set additional rules which are applied to full access administrators only.
  3. in the entry field that appears, specify a single IP address in the IPv4 format (#.#.#.#, where # is a numeric value from 0 to 255), or set an IP addresses range by entering the starting and ending IP addresses of the range in the #.#.#.#-#.#.#.# format, or use CIDR masking in the #.#.#.#/# format;
    You can find the information on your portal visitors IP addresses in the Login History subsection of the Security settings by clicking the Download and open report button.
  4. in the same way, add as many trusted IP addresses as you need;
  5. click the Save button at the bottom of the section.

If necessary, you can delete the added IP addresses by clicking the corresponding Remove Icon icon to the right of the IP address. To disable this option again, just check the Disable radio button and click the Save button.

Login Settings

This section allows you to protect the portal against brute-force attacks.

  1. in the Number of attempts field, set up the limit of unsuccessful login attempts by the user;
  2. in the Blocking time (sec) field, set up the time interval for blocking new login attempts;
  3. in the Check period (sec) field, set up the time interval for counting unsuccessful login attempts.

When the specified limit of unsuccessful login attempts is reached, attempts coming from the associated IP address will be banned (or, in the SaaS version, captcha will be requested) for the chosen period of time.

By default, this feature is disabled in the server version. If you want to use it, it's necessary to enable the feature in the configuration file. To learn more, read the following article.

Administrator message settings

This section allows you to display the contact form on the Sign In page so that people can send a message to the portal administrator in case they have troubles while accessing the portal.

To enable it, just check the corresponding radiobutton and click the Save button at the bottom of the section to apply the changes you made.

Session Lifetime

This section allows you to set a time limit (in munutes) during which the portal users will need to enter their portal credentials again in order to access the portal.

To set a session lifetime, check the Enable radiobutton, enter the necessary time value measured in minutes in the Lifetime field that appears and click the Save button at the bottom of the section to apply the changes you made. After that, all the users will be logged out from the portal.

Managing access rights

The Access Rights subsection of the Security settings is used to change the portal owner, grant administrator privileges to users and restrict access to certain portal modules for users and groups.

To see the detailed information about existing access levels on the portal and find out which permissions have guests, users and administrators, please refer to this section.
Changing portal owner

If the portal owner wants to appoint another portal member to this position, he/she needs to:

  1. click the Choose Owner link under his photo in the Portal Owner section,
  2. select a person from the dropdown list,
  3. click the Change Portal Owner button,
  4. check the mail box and follow the confirmation link sent in the email message.
Changing Portal Owner Changing Portal Owner
Adding administrators

The portal owner or full access administrators can grant administrator privileges to users only (not to guests). To do that, they need to proceed through the following steps:

  1. click the Show link next to the Administrators caption,
  2. click the Choose user link under the list of administrators,
  3. select a person or several persons at once from the existing users/guests or create a new administrator right here by clicking the Create new profile link,
  4. click the Save button,
  5. the selected person(s) will get the maximum access to all portal modules by default; to limit it, uncheck the Full Access box first and then the boxes corresponding to the modules you don't want to grant administrator access to.
Adding Administrators Adding Administrators
Restricting access to portal modules

The portal owner or full access administrators can restrict access to certain portal modules for some users or groups.

To restrict access to a portal module,

  1. find the necessary module section below the Administrators list,
  2. check the Users from list radio button,
  3. select the users you wish to grant access to,

    To do that, use one of the available options;

    • use the Add user link if you wish to grant access to one or more people;
    • use the Add group link if you wish to grant access to all portal users, or to one or more groups.
Restricting access to portal modules Restricting access to portal modules
Tracking login history

The Login History subsection of the Security settings is used to monitor the latest user login activity including successful logins and failed attempts with an indication of reasons.

This page displays only the last 20 records. Each record shows which action took place, who performed it and when the event occurred. You can also set the period during which the data is stored. By default, it is set to 180 days.

Tracking Login History Tracking Login History

To view the detailed statistics for the latest half year, click the Download and open report button. The report will open in a .csv file (LoginHistory_ReportStartDate-EndDate.csv).

The file will also be automatically saved to the My documents section.

The login history report includes the following details: user IP address, Browser and Platform which were used when the registered event occurred, Date and time of the event, name of the User who made an attempt to log in/log out, portal Page where the action has been performed, specific Action (for example, Login Fail. Associated Social Account Not Found).

The records are sorted chronologically in descending order, but you can easily sort and filter the data by any parameter or use the search tool to quickly find a specific record.

In the Online Users section, you can also view the list of the users who are currently logged in as well as each online user session duration.

Receiving audit trail data

The Audit Trail subsection of the Security settings allows you to browse through the list of the latest changes (creation, modification, deletion etc.) made by users to the entities (tasks, opportunities, files etc.) on your portal.

This feature is currently available for the Common section of the Documents module, Projects, CRM and People modules, as well as for portal settings.

This page displays only the last 20 records. Each record shows which action took place, who performed it and when the event occurred. You can also set the period during which the data is stored. By default, it is set to 180 days.

Receiving Audit Trail Data Receiving Audit Trail Data

To view the detailed statistics for the latest half year, click the Download and open report button. The report will open in a .csv file (AuditTrail_ReportStartDate-EndDate.csv).

The file will also be automatically saved to the My documents section.

The audit trail report includes the following details: user IP address, Browser and Platform which were used when the registered event occurred, Date and time of the event, name of the User who performed the operation, portal Page where the action has been performed, generic Action Type (for example, download, attach, updated access), specific Action (for example, Projects [Product development and promotion]. Tasks [Distribute coupons]. Status Updated: Closed ), Product and Module that the changed entity is referred to.

The records are sorted chronologically in descending order, but you can easily sort and filter the data by any parameter or use the search tool to quickly find a specific record.

Data management settings

The Data Management settings section allows you to ensure data protection and recoverability as well as to manage your portal status. It includes three subsections: Migration, Backup and Deactivating/Deleting Portal.

Changing portal region
This option is available for the owners of the paid portals only.

The Migration subsection of the Data Management settings section allows you to change the location of the server where your portal is hosted. The closer the server region is to your geographical location, the faster the portal speed will be.

Changing Portal Region Changing Portal Region

At present you can select between three server regions: EU (Frankfurt) Region, US West (Oregon) Region and Asia Pacific (Singapore). To migrate from one region to another one,

  • select the necessary Server Region from the drop-down list,
  • check the Migrate Mail as well box if you wish to transfer your mail as well,
    The Mail migration may considerably increase the migration time. Besides that, only the mail for the last 30 days will be transferred. Therefore it's recommended to set your account once again once the process is completed instead of transfering the messages.
  • notify users about portal migration leaving the corresponding box checked,
  • click the Change Server Region button to start the migration process.
Once the process is started, it cannot be cancelled.

The migration process may take some time depending of your portal data amount. During this process the portal will not be available. Once the migration is complete, you will receive the email with the new portal address.

After the migration, current passwords will be reset and users will need to restore their access. Users will receive notifications to the emails specified in their profiles and will be able to use the Set password button in this message to specify the password which will be used for signing in.

Creating backup

The Backup subsection of the Data Management settings allows you to backup your portal data.

Creating Backup Creating Backup
Data backup

To create your portal data backup manually, use the Data Backup section:

  1. select the desired Storage for your backup files:
    • select the Temporary radio button if you wish to download the backup to your local drive when the backup process is over. You'll be able to do that by using the link that appears below.
    • select the Documents radio button and click the Choose button next to the field that appears below. The Select folder window will open. Set a folder in the Common Documents section where you wish to store your backup and click the OK button.
    • select the Dropbox, Box, OneDrive, Google Drive radio button and click the Choose button next to the field that appears below. The Select folder window will open. Set a third-party resource directory located in the Common Documents section where you wish to store your backup and click the OK button.
      The third-party resource must be previously connected to the Documents module as well as make shared and put into the Common Documents section. Otherwise the Dropbox, Box, OneDrive, Google Drive option will be disabled.
    • select the Third-Party Storage radio button and choose one of the available services from the list: Amazon AWS S3 (Amazon Simple Storage Service), Google Cloud Storage, Rackspace Cloud Storage or Selectel Cloud Storage. Enter the necessary data to access the selected third-party storage in the fields below.
      The corresponding service must be previously connected in the Integration section. Otherwise, the following settings will be disabled.
      • For the Amazon AWS S3 service, the following fields are available:
        • Bucket - a unique Amazon bucket name, e.g. my-new-test-bucket-12345.
        • Region - an AWS region where your Amazon bucket resides, e.g. us-east-2.
        • Service Url - this is an optional property; change it only if you want to try a different service endpoint. Leave this field empty to use the default value.
        • Force Path Style - when true, requests will always use path style addressing. Leave this field empty, as the Service Url property is not specified.
        • Use Http - if this property is set to true, the client attempts to use the HTTP protocol, if the target endpoint supports it. By default, this property is set to false. Set it to true or leave this field empty to use the default value.
        • Server Side Encryption Method - the server-side encryption algorithm used when storing this object in S3. The possible values are:
          • None
          • Server-Side Encryption - SSE-S3 (your assets will be encrypted with strong AES-256 GCM keys, one separate key for each object. The keys themselves are encrypted with a rotating root key for additional protection) or SSE-KMS (your assets will be encrypted with with a versatile encryption mechanism. Like SSE-S3, it relies on strong AES-256 encryption method, but provides more complex and flexible model, offering separate permissions for a KMS key, audit trail feature, and ability to create unique custom keys). For SSE-KMS, you can choose Managed CMK - Default AWS managed CMK or Customer managed CMK. When the Customer managed CMK option is selected, you need to specify the KMS Key Id.
          • Client-Side Encryption - when this option is selected, you need to specify the KMS Key Id.
      • For the Google Cloud Storage service, the following field is available: Bucket.
      • For the Rackspace Cloud Storage service, the following fields are available: Public container, Private container and Region.
      • For the Selectel Cloud Storage service, the following fields are available: Private container and Public container.
    If you select the Documents or Dropbox, Box, OneDrive, Google Drive option, the backup file size affects the overall disk space used on your portal.
  2. check the Include Mail in backup box if you want to backup the Mail data as well. This increases the backup process time and backup file size, but if this option is unchecked, the Mail data will be lost after restoring and you'll need to connect accounts again.
  3. click the Make copy button.

Once the backup process is completed you'll find the backup .tar.gz file (portal-name_date_time.tar.gz) in the specified folder. If you've selected the Temporary storage, the link to download the created backup will be available for 24 hours.

To automate the backup process, use the Automatic backup section:

The Automatic backup function is only available if your pricing plan includes it.
  1. check the Enable radiobutton.
  2. select the desired Storage for your backup files (the available options are the same as those described above, except for the Temporary storage which is only available in the Data Backup section).
  3. check the Include Mail in backup box if you want to backup the Mail data as well.
  4. specify the time interval at which backups should be created: Every day with an indication of the necessary time of the day, Every week with an indication of the necessary day of the week and time of the day, or Every month with an indication of the necessary day of the month and time of the day.
  5. set The maximal number of backup copies to be stored by selecting the necessary value from the corresponding drop-down list.
  6. click the Save button.

Backups will be created automatically with the specified periodicity.

Data restore
The Restore function is only available if your pricing plan includes restoring from a backup.

To restore your portal data from the previously created backup file that has been hashed (for ONLYOFFICE Workspace Cloud 11.5 or later),

  1. Select the Source where the backup is stored.
    • select the ONLYOFFICE Documents option and click the Choose button below. In the Select file window, choose the necessary backup file stored in the Common folder and click OK.
    • select the DropBox, Box.com, OneDrive, Google Drive option (third-party services connected to the Documents module, including services connected via the WebDAV protocol) and click the Choose button below. In the Select file window, choose the necessary backup file stored in the third-party resource directory and click OK.
    • select the Third-Party Storage option, choose the necessary third-party storage previously connected in the Integration section and enter the data required to to access the chosen storage.
    • select the Computer file option, click the Choose button below, and browse for the necessary backup file stored on your local drive.
      Instead of selecting a backup file from a certain Source, you can just click the Show the backup list link below the Choose field to select the necessary backup file from the backup history (if a backup file was deleted manually from the storage, it will not be available in the list). Click the Restore link next to the necessary backup file. To delete a backup file from the list, click the Delete Icon icon.
  2. Leave the Send notification about portal restoring to users box checked to notify your portal users;
  3. Click the Restore button.

After restoring the backup in the cloud version, current passwords will be reset and users will need to restore their access via the email addresses specified in their profiles by specifying the password which will be used for signing in.

If you created a backup file in the cloud version and then restore it in the server version, access can only be restored via the Forgot your password? link on the authorization page.

For more tips, you can refer to this article for the Cloud version and the Server version.

Deactivating/deleting portal

The Deactivating/Deleting Portal subsection of the Data Management settings allows you to temporarily deactivate or permanently delete your portal.

Deactivating/Deleting Portal Deactivating/Deleting Portal
Portal deactivation

If you decide not to use the portal for some temporary reasons, deactivate it. To do that,

  1. click the Deactivate button.
  2. a link to confirm the operation will be sent to the email address of the portal owner. Follow the link to confirm the operation.
This link is valid for 7 days only. Please complete the portal deactivation process within that period.

After that, your portal and all information associated with it will be blocked so that no one has access to it during a particular period.

You will be able to reactivate your portal at any moment. To come back to the portal and start using it again, use the second link provided in the confirmation email. So, please, keep this email in a safe place.

Portal deletion

If you do not think you will use the portal and would like to delete it permanently,

  1. click the Delete button to submit your request.
  2. a link to confirm the operation will be sent to the email address of the portal owner. Follow the link to confirm the operation.
This link is valid for 7 days only. Please complete the portal deletion process within that period.

All the data stored on your portal, as well as your registration details will be deleted. You will not be able to reactivate your portal or recover any information associated with it.

Integration settings

The Integration section is used to enable the LDAP and SSO settings, integrate your portal with third-party services and adjust the SMTP settings.

LDAP settings

When using ONLYOFFICE Workspace, the first thing that you need to do is to create accounts for all your company employees. But if it numbers more than 50 persons, the process of creating new portal users will take a lot of time. Your portal offers you the LDAP Settings option which allows you to import the necessary users and groups from an LDAP Server (e.g. OpenLDAP Server or Microsoft Active Directory) to your portal, literally, in several minutes. The newly created users, in turn, don't need to memorize new passwords and logins because they will sign in to the portal using their credentials stored on your LDAP Server.

Fill out the required fields and click Save.

LDAP settings - Main page LDAP settings - Main page

For more detailed information on each field and corresponding values, please refer to the following instructions for the SaaS version and the Server version.

Single sign-on settings

The Single Sign-on section allows you to enable/disable third-party authentication using SAML, thereby providing users with a quicker, easier and more secure way to access the portal.

Generally, the Single Sign-on technology allows users to sign in only once and then get access to multiple authorized (i.e. integrated with an Identity Provider) applications/services without having to enter their credentials each time they access a different application.

Enabling SSO Authentication Enabling SSO Authentication

To learn more about configuring SSO, read the corresponding articles for the SaaS version and the Server version.

Third-party service integration

If you use the SaaS version, the authorization keys parameters for most services, such as Facebook, Twitter, Google, LinkedIn, Box, Dropbox, OneDrive, Bitly, Firebase, and Yahoo are set up automatically, so the corresponding switchers are disabled. You can connect your Facebook/Google/LinkedIn/Twitter account on your profile page right away or follow this article instructions to learn how to connect third-party services within the Documents module.

In the SaaS version, you can connect the following services on the Third-Party Services page:

  • DocuSign - to send files from the Documents module for electronic signature to your portal employees.
  • Twilio - to be able to call your CRM contacts from a web browser. You can also use Twilio to enable two-factor authentication.
  • Amazon AWS S3, Google Cloud Storage, Rackspace Cloud Storage or Selectel Cloud Storage - to backup and store data from your portal.

For more details on the third-party service integration, please refer to our instructions for the SaaS version or server version.

Adjusting Integration Settings Adjusting Integration Settings
Adjusting SMTP settings

The SMTP Settings subsection allows you to configure your portal so that the email notifications to be sent using your own SMTP server. To do that,

  • in the Host field, specify the domain name of the SMTP server you use;
  • in the Port field, specify the SMTP port number. It's recommended to use port 587 or 25.
  • check the Authentication box if the SMTP server requires authentication;
  • in the Host Login and Host Password fields, specify the login and password you use to access the SMTP server;
  • check the Auth via NTLM box to be able to login using SaslMechanismNtlm;
  • in the Sender Display Name field, specify the name of the sender which will be displayed in the From: field;
  • in the Sender Email Address field, specify the email address of the sender;
  • check the Enable SSL box to enable encrypted connections;
  • click the Save button.
    To verify whether the specified settings are correct, click the Send Test Mail button. If the settings are specified correctly, you'll receive the SMTP Test Message to the email address specified in your user profile on the portal.

For more details, please refer to this article.

Adjusting SMTP Settings Adjusting SMTP Settings

Statistics settings

The Statistics section is used to present and summarize all your portal data in order to analyze and manage them.

Viewing portal statistics

Here you can view the following information:

  • your portal creation date,
  • the number of active users registered on your portal,
  • the storage space allowed for the selected pricing plan (for the SaaS solution),
  • the base memory quota for all new users and the list of users with the amount of space used in each module (for the SaaS solution),
  • the total storage space used,

    You can also view the storage space used by each portal module or tool.

  • the total number of visits per day,

    By default, the Usage Graph shows data for the last 3 months. You can change the period selecting one of the available options: last week, last month, or for a period setting the start and end date in the corresponding fields.

Viewing Portal Statistics Viewing Portal Statistics
Managing memory quota

You can enable and set the base memory quota that will be applied to all new users:

  1. Select the With quota radio button.
  2. Set the necessary value in the input field and choose the unit of measure from the dropdown list (bytes, Kb, Mb, Gb, Tb).
  3. Click Save.

To disable the quota use the No quota option. The Recalculate button is used to recalculate the space used by users.

The user list below allows you to set the quota for several users or for a certain user separately. To easily find users, you can filter the list by email (Active, Pending), by type (Administrator, User, Guest), or by group. It's also possible to sort the list by first or last name or enter the necessary name in the search field.

To set the quota for several users:

  1. Check the necessary users in the list.
  2. Click the Edit quota button above.
  3. Set the necessary value in the input field and choose the unit of measure from the dropdown list (bytes, Kb, Mb, Gb, Tb).
  4. Click the checkmark button to save the settings.
If the memory quota you set is less than the memory used by one of the selected users, you'll get an error.

To set the quota for a certain user:

  1. Click the No quota caption to the right of the user name.
  2. Select the Edit quota option from the dropdown list.
  3. Set the necessary value in the input field and choose the unit of measure from the dropdown list (bytes, Kb, Mb, Gb, Tb).
  4. Click the checkmark button to save the settings.
If the memory quota you set is less than the memory used by the selected user, you'll get an error.
Try now for free Try and make your decision No need to install anything
to see all the features in action
You Might Also Like This:
Close