BSCW Administrator Documentation Release 5.2.3 OrbiTeam Software Jul 05, 2019 CONTENTS 1 HowtoreadthisManual 1 2 InstallationoftheBSCWserver 3 2.1 GeneralRequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.2 Securityconsiderations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.3 EU-GeneralDataProtectionRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.4 UpgradingtoBSCW5.2.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.4.1 UpgradingonUnix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 2.4.2 UpgradingonWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3 InstallationprocedureforUnix 19 3.1 Systemrequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3.3 SoftwareforBSCWPreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 3.4 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 3.4.1 ApacheHTTPServerConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 3.4.2 BSCWinstanceconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 3.4.3 Administratoraccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 3.4.4 De-Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 3.5 DatabaseServerStartup,GarbageCollectionandBackup . . . . . . . . . . . . . . . . . . . . . 35 3.5.1 BSCWStartup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 3.5.2 GarbageCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 3.5.3 Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 3.6 FolderMailDelivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 3.6.1 BSCWmaildeliveryagent(MDA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 3.6.2 LocalMailTransferAgent(MTA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 4 InstallationprocedureforWindows 45 4.1 Systemrequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 4.2 InstallationandConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 4.3 SoftwareforBSCWPreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 4.4 DatabaseServerandGarbageCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 4.4.1 WindowsService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 4.4.2 TaskScheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 4.5 FurtherConfigurationDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 4.5.1 BSCWServerRootDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 4.5.2 ApacheHTTPServerConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 4.5.3 IISConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 4.5.4 De-Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 4.6 FolderMailDelivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 5 ConfigurationofBSCWServers 69 5.1 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 5.2 conf/config.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 5.2.1 MANDATORYserversettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 i 5.2.2 Mailhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 5.2.3 Serveraccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 5.2.4 web/proxyserversettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 5.2.5 BSCWappearancesettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 5.2.6 OptionalBSCWpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 5.2.7 BSCWdatabaseserversettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 5.3 conf/config_actions.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 5.4 conf/config_applet.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 5.5 conf/config_cal.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 5.6 conf/config_clientmap.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 5.7 conf/config_controls.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 5.8 conf/config_convert.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 5.9 conf/config_countries.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 5.10 conf/config_easy_ui.py. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 5.11 conf/config_help.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 5.12 conf/config_html_ui.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 5.12.1 UserProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 5.12.2 Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 5.13 conf/config_icons.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.14 conf/config_meet.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.15 conf/config_menu.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.16 conf/config_metadata.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.17 conf/config_mimegroups.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.18 conf/config_mimeicons.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.19 conf/config_mimemsg.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 5.20 conf/config_mime.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 5.21 conf/config_mobile_ui.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 5.22 conf/config_mpick.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 5.23 conf/config_portlets.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 5.24 conf/config_prio_categ.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 5.25 conf/config_quicksearch.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 5.26 conf/config_search.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 5.27 conf/config_service.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 5.28 conf/config_styles.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 5.29 msg/<lang>/lg_msgconfig.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 6 BSCWPackages 117 6.1 ContentSearchPyLucIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 6.1.1 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 6.1.2 Commandlinetools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 6.1.3 Indexcreationandupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 6.2 LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 6.2.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 6.2.2 LDAPBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 6.3 DesktopWidgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 6.4 DocumentApproval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 6.5 Blog(Weblogs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 6.6 Case–FileSynchronisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 6.7 Easy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 6.8 Expire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 6.9 ExportPDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 6.10 Flow-Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 6.11 Http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 6.11.1 EnablingtheBSCWHTTPserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 6.11.2 DisablingtheBSCWHTTPserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 6.12 Incognito . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 6.13 Metaprofiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 6.14 Microblogging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 ii 6.15 Mobileaccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 6.16 Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 6.17 Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 6.18 Presence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 6.19 Readers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 6.20 RSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 6.20.1 ExportofBSCWeventhistories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 6.20.2 RSSreferencelinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 6.20.3 ReadingofRSSeventfeeds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 6.21 Securekeymanagement(deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 6.21.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 6.21.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 6.22 SSO–SingleSignOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 6.22.1 CASAuthentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 6.22.2 OpenID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 6.22.3 ShibbolethAuthentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 6.23 Sync-MSOutlookSynchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 6.24 Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 6.25 Timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 6.26 WebFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 7 AdministrationofBSCWServers 149 7.1 AdministrationusingtheWebInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 7.1.1 BSCWstatuspage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 7.1.2 BSCWAccessManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 7.1.3 Configurationmenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 7.1.4 BSCWlicencemanagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 7.2 Administrationusingthebsadminscript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 7.3 Useradministration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 7.3.1 Userstatuswithbsadminusers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 7.3.2 Userregistrationwithbsadminregister . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 7.3.3 Usermanagementwithbsadmin(rename|chpwd|rmuser) . . . . . . . . . . . . . . . . 162 7.3.4 Additionalanonymoususers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 7.4 AsynchronousServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 7.4.1 UserNotificationServices(UNO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 7.4.2 Useraccountexpiry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 7.4.3 Automaticdiskusageupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 7.5 Publicspacedeactivation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 7.6 WebDAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 7.6.1 MicrosoftSupportforWebDAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 7.6.2 KnownProblems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 7.7 Quota-DiskUsageLimitation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 7.7.1 LimitClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 7.7.2 QuotaActivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 7.7.3 Calculationofcurrentdiskusage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 7.7.4 Reportdiskusage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 7.8 DefinitionofRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 7.8.1 TheBSCWroleconcept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 7.8.2 Roledefinitionanddefaultroles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 7.8.3 Site-specificRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 7.9 Site-specificbanner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 7.10 Server-widetemplatefolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 7.11 WebServiceAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 7.12 Someusefulhints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 8 BSCWHelp 183 8.1 Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 8.1.1 Existingtranslations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 iii 8.1.2 Translationinstructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 8.2 BSCWUpdates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 9 BSCWlicense 185 9.1 Licenseapplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 9.2 Licensechanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 10 FrequentlyAskedQuestions(FAQ) 187 10.1 BSCWServerUsage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 10.1.1 WhatdoIneedtouseBSCW? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 10.1.2 DoIneedaspecialapplicationforuploadingdocuments? . . . . . . . . . . . . . . . . . 187 10.1.3 HowisBSCWintendedtobeused . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 10.1.4 Icannotlogin. Theserverrejectsme-whatshallIdo? . . . . . . . . . . . . . . . . . . 188 10.1.5 HowdoIchangemypassword? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 10.1.6 HowdoIconfiguremywebbrowser? . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 10.1.7 HowdoIconnecttoBSCWusingWebDAV? . . . . . . . . . . . . . . . . . . . . . . . 188 10.1.8 HowdoIdestroyaworkspace? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 10.1.9 HowdoIdeletemyaccount? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 10.1.10 HowdoIhandleaJavaScripterror? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 10.1.11 HowdoIhandleaBSCWerror? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 10.1.12 Ireachedthelimitofmydiskspace-whatshallIdo? . . . . . . . . . . . . . . . . . . . 193 10.1.13 WhydoesMS-Wordmarkadocumentasread-only? . . . . . . . . . . . . . . . . . . . 193 10.1.14 IstherearestrictionforthesizeofdocumentsIupload? . . . . . . . . . . . . . . . . . . 193 10.2 BSCWServerSoftware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 10.2.1 HowdoIgettheBSCWsoftware? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 10.2.2 CanItrytheBSCWsoftware? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 10.2.3 HowdoIkeepuptodatewithBSCWdevelopmentsandnewreleases?. . . . . . . . . . 194 10.3 BSCWServerAdministration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 10.3.1 Whatfacilitiesareavailableforserveradministrators?. . . . . . . . . . . . . . . . . . . 194 10.3.2 HowdoIdeleteauserfromtheBSCWserver? . . . . . . . . . . . . . . . . . . . . . . 195 10.3.3 HowdoIrenameauser? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 10.3.4 HowdoIregisteranewuser(i.e. withoutsendingemail)? . . . . . . . . . . . . . . . . 195 10.3.5 HowdoIrestrictthecreationofworkspaces? . . . . . . . . . . . . . . . . . . . . . . . 195 10.3.6 HowdoIrestrictthecreationofnewuseraccounts? . . . . . . . . . . . . . . . . . . . . 196 10.3.7 HowdoIfindthecorrespondingfileforaBSCWdocument? . . . . . . . . . . . . . . . 196 10.3.8 MayIremovethecontentsoftheBSCW“Temp”directory? . . . . . . . . . . . . . . . 196 10.3.9 HowdoIupgrademyBSCWserverinstancetoanewversion? . . . . . . . . . . . . . . 197 10.3.10 HowdoImigrateaBSCWdatabasetoanotherhost? . . . . . . . . . . . . . . . . . . . 198 10.3.11 WhydoIgeta“licenseexpired”error? . . . . . . . . . . . . . . . . . . . . . . . . . . 199 10.3.12 Changingthe“SERVER_ROOT”withoutserviceinterruption . . . . . . . . . . . . . . 199 10.3.13 TheBSCWserverdoesnotwork,thedatabaseseemstobecorrupted. . . . . . . . . . . 199 10.3.14 WhydoIgetconnectproblemsduring“UpgradeLicense”? . . . . . . . . . . . . . . . . 201 10.3.15 MyBSCWdatabaseseemstobecorrupt,whatcanIdo? . . . . . . . . . . . . . . . . . 201 10.3.16 HowcanIuploadfileslargerthan100MBwhenusingIIS? . . . . . . . . . . . . . . . . 202 10.3.17 Whycan’tBSCWprovideWebDAVwithMicrosoftIISWebserver? . . . . . . . . . . . 202 10.4 BSCWInstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 10.4.1 WhatdoIneedtoinstalltheBSCWserversoftware? . . . . . . . . . . . . . . . . . . . 202 10.4.2 WhereshouldIinstalltheBSCWserversoftware(Unix)?. . . . . . . . . . . . . . . . . 203 10.4.3 WhydoIgeta“500ServerError”whenItrytoregistermyself? . . . . . . . . . . . . . 203 10.4.4 CanIputthedatafilesfortheserveronaseparatedisk? . . . . . . . . . . . . . . . . . 203 10.4.5 WhatcanIdoifIgetaServiceException: getState, ()error . . . . . . . 203 10.4.6 HowcanIprovideaBSCWuserinterfaceindifferentlanguages? . . . . . . . . . . . . 204 10.4.7 WhydoIgeta"Permission denied"error? (Unix) . . . . . . . . . . . . . . . . 204 10.4.8 WhydoIgeta"RuntimeError: var/www/bscw.cgi: No setgid"?. . . 206 PythonModuleIndex 207 Index 209 iv CHAPTER ONE HOW TO READ THIS MANUAL BeforeinstallingyourBSCWserveryoushouldreadatleast: • the introduction to Installation of the BSCW server (in particular, section Upgrading to BSCW 5.2.3 of chapter2ifyouareupgradinganBSCWinstance), • eithersectionInstallationprocedureforUnixofchapter3orsectionInstallationprocedureforWindowsof chapter4,dependingontheoperatingsystemyouareusing. This should be sufficient to install the BSCW server and carry out the initial configuration of the server. If you haveproblemswiththeinstallationandinitialconfigurationprocess,youshouldreadtherespectivesub-sectionof • InstallationprocedureforUnixor • InstallationprocedureforWindows dependingonyouroperatingsystem. Seealso: Chapter10: FrequentlyAskedQuestions(FAQ) Ingeneral,thisshouldgiveyouenoughinformationtogetyourBSCWserverupandrunning. The BSCW server is initially equipped with a license which allows usage and testing of the BSCW server for a trial period of 90 (ninety) days. After 90 days, the BSCW server is no longer fully usable (except for a few fundamentaloperationssuchastheupgradelicenseoperation). Therefore,ifyoudecidetousetheBSCWserver for a longer period, you need to acquire a license. The acquisition of licenses is described in BSCW license. If youhaveproblemswhenupgradingyourBSCWlicense,youshouldalsohavealookattherespectiveentriesin FrequentlyAskedQuestions(FAQ)orcontactOrbiTeam([email protected]). The BSCW server has a considerable number of configuration options. If you have gained some experience with usage of the BSCW system you should read chapter 5 Configuration of BSCW Servers to find out what configurationoptionsareavailableandwhethertheycouldbeusedtosatisfytherequirementsofyourusersbetter than the default settings as specified in the code you downloaded. Additionally you may want to enable some extrapackages. Seealso: Chapter6BSCWPackagesforadetaileddescriptionoftheadditionalBSCWfunctionalityprovidedinpackage extensions. Ingeneral,theadministrativeoverheadforrunningaBSCWserverisverylow. Infact,youmayinstallandcon- figureyourBSCWserversuchthatyoupracticallyneverneedtobotherwithadministration.Mostlikely,however, soonerorlateryoumayhavequestionssuchas“Howmanyusersareregisteredatmyserver?”,“HowcanIrename ordeleteauser?”,or“HowcanIrestrictthecreationofworkspaces?”Answerstosuchadministrativequestions canbefoundinchapter7AdministrationofBSCWServersandinchapter10BSCWServerAdministration. 1 BSCWAdministratorDocumentation,Release5.2.3 2 Chapter1. HowtoreadthisManual CHAPTER TWO INSTALLATION OF THE BSCW SERVER AsaprerequisiteforinstallingaBSCWserveryouneedeitheraserverhostrunningaUnixsystem-theBSCW serverissupportedonLinuxandBSD-oraserverhostrunningMicrosoftWindows7/10,Server2012/2016/2019. 2.1 General Requirements The hardware requirements depend largely on the number of users that are expected to use the system. In gen- eral, the hardware requirements are not particularly high. For example, a >3,2 GHz Intel Core/Xeon or AMD EPYC/Opteron with at least 4 cores, 8 GB RAM and >500 GB disk space should provide an environment with satisfactoryperformanceforabout200users. The BSCW server is an extension of a Web Server with the respective BSCW functionality. The extension is implemented through the CGI interface, which is supported by almost all Web servers. The BSCW software is writteninPython(seethePythonwebsiteathttp://www.python.org/). Therefore,besidestheBSCWsoftware,the installationoftheBSCWserverrequires • aWebServer • aPython2.7interpreter • (optional)extensionsforPython(pylucene,python-ldap) • (optional)convertersoftwarefortheBSCWpreviewfeature,seesections3.3SoftwareforBSCWPreview (Unix)or4.3SoftwareforBSCWPreview(Windows)fordetails TheBSCWservercanbeinstalledonaCGIcompliantWebserver,e.g.theApacheHTTPserverortheMicrosoft’s InternetInformationServer(IIS)(werecommendtheApacheHTTPserverversion2.4). ThePythoninterpreteris freelyavailablefromthePythonwebsite(http://www.python.org/).Wecurrentlysupportversion2.7ofthePython interpreteronly. After installation the BSCW server needs to be configured. Only very few configuration efforts are required as a minimum since a few variables (e.g. the email address of the system administrator of the BSCW server) need always be set individually. The server offers a large number of configuration options but we recommend that initially a BSCW system administrator uses the default settings, except for those options which need to be configuredasaminimum. TheinstallationprocessisdifferentbetweenUnixsystemsandWindows7/10orServer2012/2016/2019. There- fore,theinstallationprocessforUnixandWindowsisdescribedseparatelyinsectionsInstallationprocedurefor UnixandInstallationprocedureforWindowsofchapters3and4,respectively. Youneedtoreadonlyoneofthe twosections,dependingonyourplatform. TheconfigurationprocesstoalargeextentisidenticalforUnixandWindows.Wheneveradifferenceisnecessary, thisisdescribedattherespectiveplacesinthismanual. Note: Pleasealsoconsultchapter10FrequentlyAskedQuestions(FAQ)inthismanual-ortheonlineversionat https://www.bscw.de/en/support/-forcommonandplatform-specificinstallationquestions;ifyouhaveaproblem notaddressedthere,[email protected]. 3 BSCWAdministratorDocumentation,Release5.2.3 2.2 Security considerations NewlyinstalledBSCWinstancesdohavethefollowingpossiblysecurityrelevantfeaturesenabledbydefault: 1. Enableduserself-registration AnewlyinstalledBSCWinstanceallowseveryregisteredusertocreateanewuseraccountbyregistering a new email address. This is probably not in all situations the desired behavior. If you do not want to allow the self-registration of new user accounts by registered users, you have to disable this feature by setting in the instance configuration file <bscw-runtime-path>/conf/config.py the directive MAY_REGISTER to a non empty list. See the directive description in the instance configuration file for details. 2. Enabledwebservices BSCWoffersarangeofservicesviadifferentwebserviceprotocols: XML-RPC,JSON,SOAP.Basically mostoftheactionsavailableontheuserinterface(like“addfolder”)areaccessibleviaawebserviceAPI. OfcourseaccesstoAPIisrestrictedviaaccesscontrolasintheregularuserinterface(i.e.,authentication andBSCWinternalrolesandrightsarerespected). TheavailabilityofthewebserviceAPIondifferentuser levelscanbeconfiguredbyeditingtheACCEPT_WEBSERVICESdirectiveintheinstanceconfigurationfile <bscw-runtime-path>/conf/config.py. Seealso: BSCWdatabaseserversettingsofchapter5forthedescriptionoftheACCEPT_WEBSERVICESdirective pagefordetails. 3. Enabled“publicspace” BydefaultBSCWallowsusersinthe“manager”roletopublishthecontentsofafolderina“publicspace”, whichcanbeaccessedbyeveryoneovertheWorld-Wide-Webwithoutbeingaregistereduseroftheserver. Recentlymisuseofthisfeaturewasreported(userspublishedinappropriatecontent). Todisablethepublic spaceforallusersseesection7.5Publicspacedeactivation. 4. Environmentwithcredentialinformation(Unix) Depending on the authentication method the user credentials are passed via an environment variable (Ba- sic/Cookie authentication) in plain text to the bscw.cgi process. Even if the credential information is removedimmediatelyfromtheenvironmentthismightimposeasecurityproblemonsystemsrunningother applicationswiththeuser-idoftheApachewebserver. Inthiscasesuchanapplicationmaydiscloseuser namesandpasswordsfromtheenvironmentofarunningbscw.cgiprocess. 2.3 EU - General Data Protection Regulation TheGeneralDataProtectionRegulation(GDPR)(EU)2016/679isaregulationinEUlawondataprotectionand privacyforallindividualswithintheEuropeanUnion. The GDPR aims primarily to give control to citizens and residents over their personal data and to simplify the regulatoryenvironmentforinternationalbusinessbyunifyingtheregulationwithintheEU. AccordingtotheGDPRBSCWhasintroducedthefollowingmeasures: • Inordertosimplifytheinformationaboutprocessedpersonaldata,therecordingofeventshasbeenextended foruseraccountsaccordingly. • Inadditiontotheuser[i]nfopageonthewebinterface,foreachuseraccountanexportofpersonaldatais possiblewiththecommandlineprogrambsadmin userdatainamachine-readableformat(JSON). • After the deletion of an user account, an audit log (history) of events is saved to an external file in the directory <bscw-runtime-path>/var/data/rmuserarc to document all processing operations (includingdeletion). Thisauditlogfileisautomaticallyremovedattheendofthefollowingyear(see§76BDSG-Protokollierung (4))bythe/etc/cron.daily/bscwCronscript(seeBSCWStartupfordetails). 4 Chapter2. InstallationoftheBSCWserver
Description: