|
Navigation: Dokumentation der Administrator-Einstellungen |
Scroll
|
Diese Einstellungen können über verschiedene Konfigurationsdateien im VisShare-Repository vorgenommen werden:
Datei |
Beschreibung |
|---|---|
server/config/settings.json |
Die Datei enthält Einstellungen zu den VisShare-Serverkonfigurationen, die in die Datenbank geschrieben werden |
server/datasources.json |
Die Datei enthält die Verbindungsinformationen für die Datenbank, die Dateiablage und den Mailserver |
client/assets/settings/settings.js |
Die Datei enthält Einstellungen zum Anpassen der VisShare-Benutzeroberfläche |
Server-seitige Settings.json
Die Datei settings.json wird einmalig mit der bei der Einrichtung festgelegten Konfiguration geschrieben. Diese Datei sollte sich mit einem nachgestellten Unterstrich (settings.json_) innerhalb des Verzeichnisses befinden. Durch Entfernen des Unterstrichs wird der Inhalt dieser Datei beim nächsten Neustart des VisShare-Dienstes in die Datenbank geschrieben. Dadurch wird auch der Unterstrich nach erfolgreicher Übernahme wieder eingefügt.
Name |
Beschreibung |
Standardwert |
|---|---|---|
Laufwerksname |
Der Pfad zur Dateiablage des WebViewers (vom VisShare-Dienst aus gesehen) |
/VisShare_Models/ (innerhalb des VisShare Installations-Repository) |
WVDriveName |
Der Pfad zur Dateiablage des WebViewers (vom WebViewer-Dienst aus gesehen) |
/VisShare_Models/ |
LDAPUrl |
URL zum LDAP-Server |
nichts |
LDAPBaseDN |
Die BaseDN zum Starten der LDAP-Verbindung |
nichts |
LDAPBindDN |
Zusätzliche Suche der LDAP-Verbindung |
nichts |
UseLDAP |
Option, ob LDAP verwendet wird |
false |
LDAPOnly |
Option, die das Anmeldungen nur über LDAP erlaubt (keine lokalen Benutzer) |
false |
AdminVerification |
Option, die festlegt, ob Benutzer von einem Administrator verifiziert werden müssen, bevor sie VisShare nutzen können |
true |
AllowGuests |
Option, die festlegt, ob Gäste erlaubt sind, wenn AdminVerification aktiviert ist (ein Gast ist eine eingeschränkte Rolle) |
true |
RemotePublic |
Option, die festlegt, ob öffentliche Projekte ohne Anmeldung erreichbar sind |
false |
SendingMail |
Die Mailadresse, die zum Versenden von Mails verwendet wird |
Bei der Installation festgelegt |
SendMailsOnConfirm |
Option, die festlegt, ob Mails an bestimmte E-Mail-Adressen gesendet werden, wenn ein neuer Benutzer über die Benutzer-Mail bestätigt wird |
false |
ConfirmMailRecipients |
Ein Array mit den Empfangsadressen (kommagetrennt) für die bestätigten Benutzer |
nichts |
Konvertieren |
Option, die festlegt, ob hochgeladene Dateien in 3DVS konvertiert werden |
true |
DeleteNative |
Option, die festlegt, ob die hochgeladenen nativen Dateien nach der Konvertierung in 3DVS gelöscht werden |
false |
SingleSession |
Option, die festlegt, ob ein Benutzer nur eine Sitzung starten kann (eine Datei ansehen). Falls gesetzt, wird beim Versuch, eine zweite Sitzung zu öffnen, ein Fehler ausgegeben, bevor die WebViewer-Sitzung initialisiert wird |
false |
UseTenants |
Option, die festlegt, ob Benutzer-Pools verwendet werden |
true |
InviteOnly |
Option, die festlegt, ob neue Benutzer nur registriert werden können, wenn sie von bestehenden Benutzern eingeladen werden |
false |
AdminCreationOnly |
Option, die festlegt, ob neue Benutzer nur von Admins erstellt werden können (keine Registrierung) |
false |
AdminVerificationLDAP |
Option, die festlegt, ob auch LDAP-Benutzer zunächst von einem Administrator überprüft werden müssen |
false |
AllowDownloads |
Option, die festlegt, ob Downloads generell erlaubt sind |
false |
OnlyAdminProjects |
Option, die festlegt, ob Projekte nur von Admins erstellt werden können |
false |
IgnoreOnConvert |
Eine Liste mit Dateierweiterungen, die beim Hochladen nicht konvertiert werden sollen. Diese Dateien sind in der Benutzeroberfläche gekennzeichnet und werden nicht im WebViewer geöffnet. Stattdessen wird beim Klicken ein Fehler ausgegeben |
leer |
AllowIgnoredFileTypeDownload |
Eine Liste mit Dateierweiterungen als Teilmenge der Einstellungen für IgnoreOnConvert. Diese Dateien werden durch Anklicken heruntergeladen (anstatt einen Fehler zu erzeugen) Beachten Sie: Damit können Sie "browser-native" Dateien wie PDFs im Browser selbst (durch den Download) anzeigen, anstatt sie in einer WebViewer-Sitzung zu betrachten |
leer |
UserCount |
LIC-Einstellung, die die Anzahl der registrierten Benutzer auf dem VisShare begrenzt (um den Wert der Lizenz bei Bedarf weiter zu reduzieren) |
0 (entspricht deaktiviert) |
SessionsPerUser |
LIC-Einstellung zur Begrenzung der Sitzungen, die ein Benutzer öffnen kann (um den Wert der Lizenz bei Bedarf weiter zu reduzieren) |
0 (entspricht deaktiviert) |
RemoteSessionCount |
LIC-Einstellung, die die Anzahl der Sitzungen begrenzt, die aus der Ferne geöffnet werden können (durch öffentliche Remote-Projekte, um den Wert der Lizenz bei Bedarf weiter zu reduzieren) |
0 (entspricht deaktiviert) |
LinkSessionCount |
LIC-Einstellung, die die Anzahl der Sitzungen begrenzt, die aus der Ferne geöffnet werden können (durch Remote-Links, um den Wert der Lizenz bei Bedarf weiter zu reduzieren) |
0 (entspricht deaktiviert) |
Nicht dokumentierte Einstellungen
Beachten Sie: Diese Einstellungen sollten vom Administrator nicht ohne unsere Anleitung geändert werden:
Name |
Beschreibung |
Standardwert |
|---|---|---|
ServerUrl |
Die vollständige URL des Servers |
Bei der Installation festgelegt |
WebViewerBackendUrl |
Die WebSocket-URL für die Backend-Verbindung VisShare <> WebViewer Hinweis: Sollte lokal sein, um Angriffe von außen zu verhindern. |
ws://localhost:9999 |
WebViewerClientUrl |
Die vollständige URL für den HTTP-Aufruf des WebViewer-Endpunkts |
<ServerUrl, die beim Setup angegeben wurde>/visshare_webviewer |
WebViewerClientWebSocketUrl |
Die WebSocket-URL für den WebViewer-Client |
ws(s)://<ServerUrl, die beim Setup angegeben wurde, ohne http(s)>/visshare_webviewer/ws |
ConfirmationUrl |
Die URL eines neuen Benutzers wird in der Bestätigungsmail angezeigt |
Bei der Installation festgelegt (= ServerUrl) |
ConfirmationRedirectUrl |
Die URL, die in automatisierten Mails verwendet wird, um auf die Seiten von VisShare weiterzuleiten |
Bei der Installation festgelegt (= ServerUrl) |
KASKey |
Ein gemeinsamer Schlüssel zwischen der VisShare Backend-Anwendung und dem KAS-Konverterdienst, der Aufträge authentifiziert |
vs-kas-key |
KASTimeout |
Ein Timeout für Jobs, nach Überschreiten dieser Dauer werden Jobs entfernt |
600000 |
UseAdvancedRegister |
Eine Markierung, die anzeigt, dass eine spezielle Seite mit zusätzlichen Registrierungsdaten von einem neuen Benutzer angefordert wird, bevor die Registrierung abgeschlossen wird Beachten Sie: Wird für das interne VisShare verwendet, um weitere Kundeninformationen zu erhalten |
false |
AdvancedRegisterMail |
Die Empfänger-Mails für die auf der erweiterten Registrierungsseite erfassten Kundendaten (kommagetrennt) |
leer |
Color1 |
Einstellung der Hauptfarbe (sollte über das Programm geändert werden) |
#d67c1c |
Color2 |
Einstellung der Sekundärfarbe (sollte über das Programm geändert werden) |
#ffc662 |
Color3 |
Einstellung der Tertiärfarbe (sollte über das Programm geändert werden) |
#fcd797 |
Banner |
Der Name des SVG-Banners (sollte über das Programm geändert werden) |
Kisters_banner.svg |
Logo |
Der Name der Logo-SVG (sollte über das Programm geändert werden) |
Kisters_logo.svg |
Server-seitige datasources.json
Die datasource-Datei enthält die Verbindungsparameter für die Datenbank und den SMTP-Server sowie den Speicherort für die Dateien. Die Erstkonfiguration erfolgt über das Setup. VisShare liest diese Datei bei jedem Start des Dienstes. Sie müssen sie also nicht umbenennen, aber der Dienst muss neu gestartet werden, um die Änderungen zu übernehmen.
Der Abschnitt PostgreSQL behandelt die Datenbankverbindung. Während VisShare den URL-Parameter für die Verbindung verwendet, können/sollten die anderen Parameter für eine bessere Übersicht ebenfalls angepasst werden.
Der Abschnitt filestorage umfasst den Speicherort des Dateispeichers. Hier sollte nur der Parameter root geändert werden, wenn der Speicherort geändert werden muss. Das anfängliche Repository ist das Standardverzeichnis VisShare/VisShare_Models.
Beachten Sie: Ändern Sie immer die Laufwerkseinstellungen aus der settings.json (siehe oben) und den WebViewer-Renderer (CRendererInstance.ini) ModelRepo-Konfigurationen entsprechend zu diesem Root-Repository. Der KAS-Konvertierungsdienst erhält den Pfad von VisShare, es ist keine Änderung erforderlich.
Der E-Mail-Abschnitt behandelt die Verbindungsparameter des SMTP-Servers. Dies hängt stark von dem SMTP-Server ab, mit dem sich VisShare verbinden soll, und auch die Parameter können sich von Fall zu Fall ändern. Die Voreinstellung sollte die „grundlegendsten“ SMTP-Server-Anforderungen abdecken. Zusätzliche Informationen finden Sie in der Nodemailer-Dokumentation (das Loopback-Framework verwendet Nodemailer als Mailing-Modul): https://www.nodemailer.com/about/
Client-seitige settings.js
Diese Datei enthält Einstellungen für die Benutzeroberfläche und das Verhalten der VisShare-Anwendung. Änderungen können ohne Neustart des Dienstes vorgenommen werden. Beachten Sie jedoch, dass der Browser-Cache geleert werden muss, um die Änderungen zu sehen.
Name |
Beschreibung |
Standardwert |
|---|---|---|
VSShareBackendUrl |
Die URL für die HTTP-Aufrufe der API |
Wurde während der Installation auf die VisShare-Server-URL eingestellt |
UseAdvancedRegister |
Option, die festlegt, ob der Client nach der Registrierungsanfrage auf die erweiterte Registrierungsseite umgeleitet werden soll |
false |
AdminCreationOnly |
Falls eingestellt, wird die Schaltfläche zum Registrieren ausgeblendet |
false |
VisShareDisclaimerUrl |
Die URL des VisShare-Haftungsausschlusses |
|
VisShareImprintUrl |
Die URL des VisShare-Impressums |
|
ShowTermsAfterRegister |
Wenn diese Option aktiviert ist, wird einem neuen Benutzer nach der Registrierung die Seite mit den Allgemeinen Geschäftsbedingungen angezeigt |
false |
HidePrivate |
Wenn diese Option aktiviert ist, wird der gesamte private Abschnitt verborgen (privates Projekt, freigegebene Dateien, mit mir geteilt) |
false |
HideMailLinks |
Wenn diese Option aktiviert ist, werden die Optionen zum Senden von Freigabelinks ausgeblendet |
false |
HidePasswordReset |
Wenn diese Option aktiviert ist, werden die Optionen zum Ändern und Vergessen des Passworts ausgeblendet |
false |
HideResendMail |
Wenn diese Option aktiviert ist, wird die Option zum erneuten Senden von E-Mails ausgeblendet |
false |
OnlyAdminProjectTypeChanges |
Wenn diese Option aktiviert ist, können nur VisShare-Administratoren die Option im Kontextmenü sehen, mit der Sie den Projekttyp in „Showcase /Öffentlich“ ändern können |
false |
Zusätzliche Anpassungen/Konfiguration
Es gibt ein paar zusätzliche Dateien, die vom Administrator geändert werden können, um die Anwendung weiter anzupassen:
Pfad |
Beschreibung |
|---|---|
Client-Seite |
|
client/assets/info-pages/info-page-auth.html |
Die Informationsseite, die angezeigt wird, wenn ein angemeldeter und bestätigter Benutzer auf das Fragezeichen-Symbol klickt |
client/assets/info-pages/info-page-guest.html |
Die Informationsseite, die angezeigt wird, wenn ein Gast oder ein nicht angemeldeter Benutzer auf das Fragezeichen-Symbol klickt |
Server-seitige Mail-Vorlagen |
|
server/views/account-creation.html |
Die Vorlage der E-Mail, die ein Administrator bei der Kontoerstellung an Benutzer sendet |
server/views/advanced-register-mail.html |
Die Vorlage der E-Mail, die an die Empfänger der erweiterten Registrierungsdaten gesendet wird |
server/views/invite-mail.html |
Die Vorlage der E-Mail, die an eine Mail-Adresse gesendet wird, die von einem VisShare-Benutzer eingeladen wurde |
server/views/password-reset.html |
Die Vorlage der E-Mail, die an einen Benutzer gesendet wird, der ein Zurücksetzen des Passworts beantragt hat |
server/views/share-mail.html |
Die Vorlage der E-Mail, die an eine Mailadresse gesendet wird, wenn eine automatisierte Mail bei der Erstellung eines Freigabelinks gesendet werden soll |
server/views/user-confirmed.html |
Die Vorlage der E-Mail, die an die Empfänger von Mails gesendet wird, wenn ein neuer Benutzer sein Konto über die Mail verifiziert hat |
server/views/verify.ejs |
Die Vorlage der E-Mail, die an neue Benutzer gesendet wird, um sie zu bitten, ihr Konto zu verifizieren |
Dienstskripte, die beim Start des Dienstes ausgeführt werden, wenn der abschließende Unterstrich entfernt wird – Der Inhalt wird beim Start des Servers verarbeitet und die Datei wird dann geleert und umbenannt |
|
server/config/adminCreation.json |
Dieses Skript erstellt beim Start ein Admin-Konto mit der angegebenen Login-Mail und dem Passwort |
server/config/projectDefaultsManagement.json |
Dieses Skript wird verwendet, um einen Standard-Projekteigentümer und einen Standard-Projektadministrator bereitzustellen. Diese Datei hat keine „Unterstrich-Logik“, da sie bei jedem Start des Dienstes gelesen und in den Laufzeitspeicher der Anwendung geschrieben wird ▪ProjectDefaultOwnerEmail ▪EIN Eigentümer, der für alle Projekte verwendet wird, anstatt des Projekt-Erstellers selbst ▪ProjectDefaultAdminEmails ▪Mehrere Admins (durch Komma getrennte Mails), die zu jedem erstellten Projekt hinzugefügt werden |
server/config/syncCreation.json |
Dieses Skript erstellt ein neues Projekt und wendet eine Synchronisierung darauf an, indem es die folgenden Parameter übergibt: ▪Directory ▪Der Pfad zu dem Repository, das für die Synchronisierung verwendet wird ▪OwnerMail ▪Die E-Mail (= Anmeldename) des Eigentümers, unter dem das Projekt erstellt werden soll ▪CreateBackup ▪Option, die festlegt, ob die Synchronisierung mit der Backup-Option erfolgen soll ▪ProjectName ▪Der Name, mit dem das Projekt initialisiert wird ▪UserPoolId ▪Die ID des Benutzer-Pools, der diesem Projekt zugeordnet werden soll |
server/config/syncDeletion.json |
Dieses Skript löscht Synchronisierungen, indem es den Pfad des Sync-Verzeichnisses in einer kommagetrennten Liste übergibt |
LDAP-Verbindung
Die letzte Datei, die vom Benutzer geändert werden soll, ist die LDAP-Verbindungsdatei (server/scripts/ldapAuth.js).
Diese Datei enthält den JS-Code für die Verbindung zu einem LDAP-Server über das Modul ldap.js. Ein Administrator muss die Verbindungsmethode ändern, damit VisShare einen Benutzer mit einer E-Mail/Passwort-Authentifizierung an diesen LDAP-Server binden kann. Die Voreinstellung in dieser Datei kann als Beispielcode verwendet werden, wie eine solche Verbindung hergestellt werden kann, aber es ist sehr wahrscheinlich, dass Änderungen vorgenommen werden.
Die Parameter für den Verbindungsaufruf, die dynamisch gefüllt werden und vom Administrator für den Code gegen den LDAP-Server verwendet werden können, sind:
▪Die Login-Mail, die der Benutzer bei der Anmeldung angegeben hat
▪password
▪Das Passwort, das der Benutzer bei der Anmeldung angegeben hat
▪serverURL
▪Die URL des LDAP-Servers, die in den Datenbank-Einstellungen angegeben ist
▪baseDN
▪Die Basis-DN wird über die Datenbank-Einstellungen bereitgestellt
▪bindDN
▪Die zusätzlichen Suchparameter für die LDAP-Verbindung werden über die Einstellungen der Datenbank bereitgestellt
▪callback(error, response)
▪Diese Methode sollte aufgerufen werden, nachdem die LDAP-Verbindung hergestellt wurde
▪Bei Erfolg: Aufruf mit der positiven Authentifizierungsantwort aus dem LDAP -> cb(undefined, response);
▪Bei Fehler: Aufruf mit Fehlerantwort von LDAP -> cb(error, undefined);
