Apache Tika

207 Pages·2017·2.18 MB·English

BSCW Administrator Documentation
Release 7.0.0
OrbiTeam Software
Dec 20, 2017

CONTENTS
1 HowtoreadthisManual 1
2 InstallationoftheBSCWserver 3
2.1 GeneralRequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Securityconsiderations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3 UpgradingtoBSCW7.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3.1 UpgradingonUnix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.3.2 UpgradingonWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3 InstallationprocedureforUnix 17
3.1 Systemrequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.3 SoftwareforBSCWPreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.4 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.1 ApacheHTTPServerConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4.2 BSCWinstanceconfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.4.3 Administratoraccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.4.4 De-Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.5 DatabaseServerStartup,GarbageCollectionandBackup . . . . . . . . . . . . . . . . . . . . . 33
3.5.1 BSCWStartup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
3.5.2 GarbageCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.5.3 Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6 FolderMailDelivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.1 BSCWmaildeliveryagent(MDA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.6.2 LocalMailTransferAgent(MTA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4 InstallationprocedureforWindows 43
4.1 Systemrequirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4.2 InstallationandConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.3 SoftwareforBSCWPreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.4 DatabaseServerandGarbageCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4.4.1 WindowsService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4.4.2 TaskScheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4.5 FurtherConfigurationDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.5.1 BSCWServerRootDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.5.2 ApacheHTTPServerConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.5.3 IISConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
4.5.4 De-Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.6 FolderMailDelivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
5 ConfigurationofBSCWServers 65
5.1 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
5.2 conf/config.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
5.2.1 MANDATORYserversettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
5.2.2 Mailhandling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
i
5.2.3 Serveraccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
5.2.4 web/proxyserversettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
5.2.5 BSCWappearancesettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
5.2.6 OptionalBSCWpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.2.7 BSCWdatabaseserversettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
5.3 conf/config_actions.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.4 conf/config_applet.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.5 conf/config_cal.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.6 conf/config_clientmap.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.7 conf/config_controls.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.8 conf/config_convert.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.9 conf/config_countries.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.10 conf/config_grid.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.11 conf/config_guided_tours.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.12 conf/config_help.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.13 conf/config_html_ui.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.13.1 UserProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.13.2 Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
5.14 conf/config_icon.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.15 conf/config_icons.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.16 conf/config_meet.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.17 conf/config_menus.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.18 conf/config_metadata.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.19 conf/config_mimegroups.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.20 conf/config_mime_icons.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.21 conf/config_mimemsg.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.22 conf/config_mime.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.23 conf/config_mobile_ui.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.24 conf/config_mpick.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.25 conf/config_portlets.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.26 conf/config_prio_categ.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.27 conf/config_quicksearch.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.28 conf/config_search.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.29 conf/config_service.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
5.30 conf/config_styles.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
5.31 msg/<lang>/lg_msgconfig.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
6 BSCWPackages 113
6.1 ContentSearchPyLucIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
6.1.1 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
6.1.2 Commandlinetools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
6.1.3 Indexcreationandupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
6.2 LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
6.2.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
6.2.2 LDAPBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
6.3 DesktopWidgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
6.4 DocumentApproval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
6.5 Blog(Weblogs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
6.6 BSync-DesktopSynchronisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
6.7 Case–FileSynchronisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
6.8 Expire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
6.9 ExportPDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
6.10 Flow-Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
6.11 Http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
6.11.1 EnablingtheBSCWHTTPserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
6.11.2 DisablingtheBSCWHTTPserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
6.12 Incognito . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
6.13 Metaprofiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ii
6.14 Microblogging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
6.15 OnlineOffice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
6.16 Poll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
6.17 SSO–SingleSignOn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
6.17.1 CASAuthentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
6.17.2 OpenID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
6.17.3 ShibbolethAuthentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
6.18 Sync-MSOutlookSynchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
6.19 Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
6.20 WebFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
7 AdministrationofBSCWServers 139
7.1 AdministrationusingtheWebInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
7.1.1 BSCWstatuspage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
7.1.2 BSCWAccessManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
7.1.3 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
7.1.4 BSCWlicencemanagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
7.2 Administrationusingthebsadminscript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
7.3 Useradministration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
7.3.1 Userstatuswithbsadminusers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
7.3.2 Userregistrationwithbsadminregister . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
7.3.3 Usermanagementwithbsadmin(rename|chpwd|rmuser) . . . . . . . . . . . . . . . . 153
7.3.4 Additionalanonymoususers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
7.4 AsynchronousServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
7.4.1 UserNotificationServices(UNO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
7.4.2 Useraccountexpiry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
7.4.3 Automaticdiskusageupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
7.5 Publicspacedeactivation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
7.6 WebDAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.6.1 MicrosoftSupportforWebDAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
7.6.2 KnownProblems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
7.7 Quota-DiskUsageLimitation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
7.7.1 LimitClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
7.7.2 QuotaActivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.7.3 Calculationofcurrentdiskusage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
7.7.4 Reportdiskusage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
7.8 DefinitionofRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
7.8.1 TheBSCWroleconcept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
7.8.2 Roledefinitionanddefaultroles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
7.8.3 Site-specificRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
7.9 Site-specificbanner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
7.10 Server-widetemplatefolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
7.11 WebServiceAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.12 Someusefulhints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
8 BSCWHelp 175
8.1 Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
8.1.1 Existingtranslations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
8.1.2 Translationinstructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
8.2 BSCWUpdates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
9 BSCWlicense 177
9.1 Licenseapplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
9.2 Licensechanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
10 FrequentlyAskedQuestions(FAQ) 179
10.1 BSCWServerUsage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
10.1.1 WhatdoIneedtouseBSCW? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
10.1.2 DoIneedaspecialapplicationforuploadingdocuments? . . . . . . . . . . . . . . . . . 179
iii
10.1.3 HowisBSCWintendedtobeused . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
10.1.4 Icannotlogin. Theserverrejectsme-whatshallIdo? . . . . . . . . . . . . . . . . . . 180
10.1.5 HowdoIchangemypassword? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
10.1.6 HowdoIconfiguremywebbrowser? . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
10.1.7 HowdoIconnecttoBSCWusingWebDAV? . . . . . . . . . . . . . . . . . . . . . . . 180
10.1.8 HowdoIdestroyaworkspace? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
10.1.9 HowdoIdeletemyaccount? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
10.1.10 HowdoIhandleaBSCWerror? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
10.1.11 Ireachedthelimitofmydiskspace-whatshallIdo? . . . . . . . . . . . . . . . . . . . 184
10.1.12 WhydoesMS-Wordmarkadocumentasread-only? . . . . . . . . . . . . . . . . . . . 184
10.1.13 IstherearestrictionforthesizeofdocumentsIupload? . . . . . . . . . . . . . . . . . . 184
10.2 BSCWServerSoftware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
10.2.1 HowdoIgettheBSCWsoftware? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
10.2.2 CanItrytheBSCWsoftware? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
10.2.3 HowdoIkeepuptodatewithBSCWdevelopmentsandnewreleases?. . . . . . . . . . 185
10.3 BSCWServerAdministration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
10.3.1 Whatfacilitiesareavailableforserveradministrators?. . . . . . . . . . . . . . . . . . . 185
10.3.2 HowdoIdeleteauserfromtheBSCWserver? . . . . . . . . . . . . . . . . . . . . . . 186
10.3.3 HowdoIrenameauser? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
10.3.4 HowdoIregisteranewuser(i.e. withoutsendingemail)? . . . . . . . . . . . . . . . . 186
10.3.5 HowdoIrestrictthecreationofworkspaces? . . . . . . . . . . . . . . . . . . . . . . . 186
10.3.6 HowdoIrestrictthecreationofnewuseraccounts? . . . . . . . . . . . . . . . . . . . . 187
10.3.7 HowdoIfindthecorrespondingfileforaBSCWdocument? . . . . . . . . . . . . . . . 187
10.3.8 MayIremovethecontentsoftheBSCW“Temp”directory? . . . . . . . . . . . . . . . 187
10.3.9 HowdoIupgrademyBSCWserverinstancetoanewversion? . . . . . . . . . . . . . . 188
10.3.10 HowdoImigrateaBSCWdatabasetoanotherhost? . . . . . . . . . . . . . . . . . . . 189
10.3.11 WhydoIgeta“licenseexpired”error? . . . . . . . . . . . . . . . . . . . . . . . . . . 190
10.3.12 Changingthe“SERVER_ROOT”withoutserviceinterruption . . . . . . . . . . . . . . 190
10.3.13 TheBSCWserverdoesnotwork,thedatabaseseemstobecorrupted. . . . . . . . . . . 190
10.3.14 WhydoIgetconnectproblemsduring“UpgradeLicense”? . . . . . . . . . . . . . . . . 192
10.3.15 MyBSCWdatabaseseemstobecorrupt,whatcanIdo? . . . . . . . . . . . . . . . . . 192
10.3.16 HowcanIuploadfileslargerthan100MBwhenusingIIS? . . . . . . . . . . . . . . . . 193
10.3.17 Whycan’tBSCWprovideWebDAVwithMicrosoftIISWebserver? . . . . . . . . . . . 193
10.4 BSCWInstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
10.4.1 WhatdoIneedtoinstalltheBSCWserversoftware? . . . . . . . . . . . . . . . . . . . 193
10.4.2 WhereshouldIinstalltheBSCWserversoftware(Unix)?. . . . . . . . . . . . . . . . . 194
10.4.3 WhydoIgeta“500ServerError”whenItrytoregistermyself? . . . . . . . . . . . . . 194
10.4.4 CanIputthedatafilesfortheserveronaseparatedisk? . . . . . . . . . . . . . . . . . 194
10.4.5 WhatcanIdoifIgetaServiceException: getState, ()error . . . . . . . 194
10.4.6 HowcanIprovideaBSCWuserinterfaceindifferentlanguages? . . . . . . . . . . . . 195
10.4.7 WhydoIgeta"No module named crypt"error? . . . . . . . . . . . . . . . . . 195
10.4.8 WhydoIgeta"Permission denied"error? (Unix) . . . . . . . . . . . . . . . . 195
10.4.9 WhydoIgeta"RuntimeError: var/www/bscw.cgi: No setgid"?. . . 197
PythonModuleIndex 199
Index 201
iv
CHAPTER
ONE
HOW TO READ THIS MANUAL
BeforeinstallingyourBSCWserveryoushouldreadatleast:
• the introduction to Installation of the BSCW server (in particular, section Upgrading to BSCW 7.0.0 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,Release7.0.0
2 Chapter1. HowtoreadthisManual
CHAPTER
TWO
INSTALLATION OF THE BSCW SERVER
As a prerequisite for installing a BSCW server you need either a server host running a Unix system - the
BSCW server is supported on Linux and BSD - or a server host running Microsoft Windows 7/8/10, Server
2008/2012/2016.
2.1 General Requirements
Thehardwarerequirementsdependlargelyonthenumberofusersthatareexpectedtousethesystem. Ingeneral,
the hardware requirements are not particularly high. For example, a >3,2 GHz Intel Core/Xeon or AMD A-
series/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
• aPython3.5interpreter
• (optional)extensionsforPython(PyLucene,ldap3)
• (optional)convertersoftwarefortheBSCWpreviewfeature,seesections3.3SoftwareforBSCWPreview
(Unix)or4.3SoftwareforBSCWPreview(Windows)fordetails
TheBSCWservercanbeinstalledonaCGIcompliantWebserver,e.g.theApacheHTTPserverortheMicrosoft’s
InternetInformationServer(IIS)(werecommendtheApacheHTTPserverversion2.4). ThePythoninterpreters
is freely available from the Python website (http://www.python.org/). We currently support version 3.5 of the
Pythoninterpreteronly.
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/8/10orServer2008/2012/2016.There-
fore,theinstallationprocessforUnixandWindowsisdescribedseparatelyinsectionsInstallationprocedurefor
UnixandInstallationprocedureforWindowsofchapters3and4,respectively. Youneedtoreadonlyoneofthe
twosections,dependingonyourplatform.
TheconfigurationprocesstoalargeextentisidenticalforUnixandWindows.Wheneveradifferenceisnecessary,
thisisdescribedattherespectiveplacesinthismanual.
Note: Pleasealsoconsultchapter10FrequentlyAskedQuestions(FAQ)inthismanual-ortheon-lineversion
at http://www.bscw.de/english/faq.html - for common and platform-specific installation questions; if you have a
problemnotaddressedthere,[email protected].
3
BSCWAdministratorDocumentation,Release7.0.0
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 Upgrading to BSCW 7.0.0
If you are installing BSCW for the first time please refer to the installation sections (Installation procedure for
Unix,InstallationprocedureforWindows). Forupgrading,youessentiallyproceedthesamewayasshowninthe
installationsection.
Note:
• IfyouareusingtheApacheHTTPserveryoumustrestartthewebserveraftereachupgrade.
• ItispossibletoupgradeyourPythontoversion3.5beforeaBSCWupgrade.
• TolistallinstalledBSCWinstancesontheinstallationhostrunbsadmin manage_servers -l:
$ ./bin/bsadmin manage_servers -l
/home/bscw/srv/bscw.domain.org: BSCW 5.2.0
> bin\bsadmin manage_servers -l
c:\bscw\srv\bscw.domain.org: BSCW 5.2.0
4 Chapter2. InstallationoftheBSCWserver