yoff/obsr repository overview

⁠AhsayOBSR v6.29.0.0

proprietary backup service software

⁠How to

• Run: docker run -p "80:8080" -p "443:8443" yoff/obsr
• Safely stop: docker stop --time 60 CONTAINER_NAME

⁠Paths

• OBSR Configuration: /obsr/conf/
• OBSR/Catalina logs: /obsr/logs/
• OBS System logs and policies: /obsr/system/
• OBS Users: /obsr/user/
• RPS System logs: /obsr/rps-system/
• RPS reciever home: /obsr/rcvshome/

⁠Environment Variables

⁠Standard Configuration

If set, the following environment variables will overwrite existing configuration.

• OBS_USERNAME (system): Administrator username
• OBS_PASSWORD (VLUwclQO7rj46TQ+cfKBdg==): Hash of administrator password. Alternatively, a plain-text password can be used if OBS_PASSWORD_HASHED is set to anything except "Y"
• OBS_PASSWORD_HASHED (Y): Indicates that the value of OBS_PASSWORD is already hashed.
• OBS_HOSTNAME (localhost)
• OBS_LICENSE_NAME (EvaluationOnly)
• OBS_LICENSE_KEY (62pMG-YPD6l-3ggaG-b5MCT-xA)
• OBS_USER_HOME (user): Absolute or relative path from "/obsr"
• OBS_SMTP_HOST (smtp.your-company.com)
• OBS_SMTP_USER ()
• OBS_SMTP_PASSWORD ()
• OBS_REPORT_SENDER_NAME (Backup Manager)
• OBS_REPORT_SENDER_EMAIL ([email protected]⁠)
• OBS_ADMIN_NAME (System Admin)
• OBS_ADMIN_EMAIL ([email protected]⁠)
• OBS_ENFORCE_SSL (): If TRUE, tomcat will redirect http connections to /obs/jsp/user/* and /obs/jsp/system/* to https. If FALSE, this rule will be removed.
• ROOT_ENFORCE_SSL (): If TRUE, tomcat will redirect http connections to /* to https. If FALSE, this rule will be removed.
• RPS_USERNAME (system)
• RPS_PASSWORD_HASH (2dLf2cvC) Must be a hash. Default is the hash of "system"
• RPS_REPORT_SENDER_NAME (Backup Manager)
• RPS_REPORT_SENDER_EMAIL ([email protected]⁠)
• RPS_ENFORCE_SSL (): If TRUE, tomcat will redirect http connections to /rps/jsp/system/* to https. If FALSE, this rule will be removed
• RDR_ENABLED (false): If "true" (case-sensitive) will join an RDR
• RDR_PROTOCOL (https)
• RDR_HOSTNAME ()
• RDR_PORT (443)
• RDR_USER (system)
• RDR_PASSWORD (system): Hash of password for RDR. Alternatively, a plain-text password can be used if RDR_PASSWORD_HASHED is set to anything other than "true" (case-sensitive)
• RDR_PASSWORD_HASHED (false): If set to "true" (case-sensitive) OBSR will will not hash RDR_PASSWORD
• RDR_CLIENT_HOST ()
• OBSR_HTTP_PORT (8080): Port must be higher than 1024
• OBSR_HTTPS_PORT (8443): Port muust be higher than 1024
• OBSR_KEYSTORE_FILE (conf/keystore): path to the java keystore file
• OBSR_KEYSTORE_PASSWORD (changeit): java keystore password
• OBSR_PROTOCOLS (TLSv1,SSLv2Hello): Sets tomcat's sslEnabledProtocols
• OBSR_PROXIED (): If TRUE, tomcat will trust "X-Forwarded-For" header

⁠Advanced Configuration

The following environment variables will be re-applied with each start of the docker container.

• OBSR_HIDE_CR_FRAME (Empty): If TRUE, will hide the bottom copyright bar frame
• OBSR_ROOT_REDIRECT (Empty): If set, will create an html meta-tag redirect from / to a different URI (eg: /obs/jsp/user/)
• OBSR_DOWNLOAD_REDIRECT (Empty): If set, will create an html meta-tag redirect from /download to a different URI (eg: /obs/jsp/user/wizard/install/)
• OBSR_MAC (Empty): If set, will spoof the OS MAC to the OBSR software (eg: BE:02:A4:D2:14:7F).
• OBSR_REMOVE_ADS (Empty): If TRUE, ads will be removed at prior to every tomcat start.

⁠Branding

The following environment variables will only apply if its respective .properties file does not exist.

• COMPANY_NAME_FULL (Backup Provider)
• COMPANY_NAME_SHORT (Backup Provider)
• COMPANY_URL (https://acme.com⁠)
• OBS_FULL_NAME (Online Backup Server)
• OBS_SHORT_NAME (OBS)
• OBS_SERVICE (Online Backup Services)
• USER_GUIDE_URL ({0}/obs/www/getDocument.do?locale=en&doc=/doc/obs-user-guide.pdf)
• OBS_FAQ_URL ({0}/obs/www/getDocument.do?locale=en&doc=/doc/obs-faq.pdf)
• BUY_LICENSE_URL (/coupon)
• RPS_FULL_NAME (Replication Server)
• RPS_SHORT_NAME (RPS)
• OBM_FULL_NAME (Online Backup Manager)
• OBM_SHORT_NAME (OBM)
• OBM_SCHEDULER (Online Backup Scheduler)
• ACB_FULL_NAME (A-Click Backup)
• ACB_SHORT_NAME (ACB)
• RDR_FULL_NAME (Redirector)
• RDR_SHORT_NAME (RDR)

⁠Features and notes

• The application runs as the limited user "ahsay" (400:400)
• Catalina is started with the 'run' command to prevent daemonizing. Likewise, nohup has been removed from startup.sh
• SSLv2Hello is enabled to provide backwards compatibility for older Ahsay agents (<= 6.21.0.0)
• docker stop (SIGTERM) is caught and redirected at catalina.sh stop for a safe shutdown. If your OBS needs more than 10 seconds to stop, be sure to use the --time n flag prevent docker from prematurely resorting to kill.
• Ahsay's check-v7-license-required.zip has been included. Run against an active OBSR with docker exec CONTAINER_NAME ShowV7Usage.sh
• On-the-fly branding using env variables
• Agents downloads, Agent liveupdates, docs, and java-x86 have been removed.
• landing page has a title attribute
• favicon.ico from obsr/webapps/obs/jsp/icon/obm.gif