Skip to content
This repository has been archived by the owner on Jul 18, 2022. It is now read-only.

Configuration

fschoeppl edited this page Aug 27, 2012 · 2 revisions

Main-Configuration

Before you start building the system, you have to configure the core accordingly to your needs. If you use tomcat6 or 7, you need to adjust the following file:

org.backmeup.rest\src\main\resources\bl.properties

If you just use the embedded server, you need to adjust the following file:

org.backmeup.embedded\src\main\resources\bl.properties

The following settings MUST be adjusted to your needs:

# The callbackUrl will be used for OAuth to redirect to the web platform
# Enter your own URL here, e. g.:
callbackUrl = http://www.localhost.at:9998

# The emailVerficationUrl will be used as callback for the verification emails. The verification key replaces the %s entry within the url, e. g.:
emailVerificationUrl = http://www.localhost.at:9998/verify_email/%s

# The minimal allowed password length
minimalPasswordLength = 8

# the temprorary directory to use for the plugin layer
job.temporaryDirectory = /tmp/bmu

Adjust the connection to the keyserver:

# the following settings will result as "https://keysrv.backmeup.at/keysrv"
keyserver.scheme = https
keyserver.host = keysrv.backmeup.at
keyserver.path = /keysrv

# the truststore contains the public key of the keysrv
keyserver.truststore = bmu-keysrv.truststore
keyserver.truststoreType = jks
keyserver.truststorePwd = 123456
# to specify truststorePwd, use keyserver.truststorePwd = ...

# the keystore contains the private / public key of the backmeup core
keyserver.keystore = bmu-core-pwd.p12
keyserver.keystoreType = pkcs12
keyserver.keystorePwd = 123

# if this setting is true, the host of the keyserver will not be validated
keyserver.allowAllHostnames = true

If you change the scheme to "http", no keystores and / or truststores are needed. You might create your own keystores by using keytool.

Make sure you copy bl.properties, the key- and truststores to following locations:

org.backmeup.embedded/src/main/resources
org.backmeup.rest/src/main/resources
org.backmeup.keyserver.client/src/test/resources
org.backmeup.logic.impl/src/test/resources

The following settings can be adjusted:

# when a new user is being registered, the email regex will be validated to make sure that the entered email address is ok
# email regex provided by http://www.regular-expressions.info/email.html, can be adjusted here:
emailRegex = ^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$

# The job.backupname is the foldername within the destination of a backup
# %SOURCE% is a placeholder for the source string of the backup (e. g. dropbox); this string will be parsed by a SimpleDateFormat-instance
# Characters written between '...' will not be interpreted by SimpleDateFormat (therefore the 'M' in BMU will not be converted into the Month.
job.backupname = 'BMU_%SOURCE%_'dd_MM_yyyy_hh_mm
# resutling in backupnames like: "BMU_Dropbox_10_01_2013_10_05"

E-Mail-Layer-Configuration

The core is using the JavaMail API for sending e-mails to newly registered users to verify their ownership of the address as well as sending e-mails when an backup error occurs. The following file must be configured to use this layer:

org.backmeup.utilities\src\main\resources\mail.properties

You have to configure a valid SMTP e-mail account:

# the smtp server to use, e. g. smtp.gmail.com for gmail services
mail.smtp.host=smtp.gmail.com

# the user to connect with the smtp server
mail.user=user@gmail.com

# the name of the sender
mail.from=user@gmail.com

# password of the account
mail.password=password

# port of the smtp server
mail.smtp.port=465

# use the following settings for TLS protected SMTP servers
mail.smtp.starttls.enable=true
mail.smtp.auth=true
mail.smtp.socketFactory.port=465
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
mail.smtp.socketFactory.fallback=false