Advanced Configuration – Free and open source project management software

  1. Home
  2. Hosting MyCollab on your own server
  3. Advanced Configuration

Advanced Configuration

MyCollab is a highly configurable open source project management when we try not to use any hardcore value in our code also we do not want to keep lengthy configuration options that make people confuse. You will read up-to-date MyCollab configuration options here (for Community edition). With premium users, you may access to our private places and do more configurations for advanced features.

MyCollab configuration are listed in form of key, value format. All of them are persisted in file %MYCOLLAB_HOME%/conf/mycollab.properties with %MYCOLLAB_HOME% is folder path value which you install MyCollab.

Note: if you customize MyCollab community, we do not deliver mycollab.properties but a template file mycollab.properties.templates. You should clone a copy and rename to the file mycollab.properties and follow below instructions as usual.


#====================================================
# You can visit link http://community.mycollab.com/configuration/
# to get all configuration parameters and their meanings
#====================================================
#====================================================
# SITE CONFIGURATION
#====================================================

 

site.name:

Name your MyCollab instance site. For instance: if you name ‘Your Company’, then in MyCollab dialogs we will show site name branding with your name value.

server.address:

Server address that you and your team will access MyCollab via browser. For instance:

  • If you installed MyCollab on your PC, and use for testing by only you, you can set its value is localhost. Then you can access MyCollab with address http://localhost/
  • If you installed MyCollab in one server in your LAN network and it is used not only you but your team members, they you give server address by the IP (or machine name) in your LAN, and any of you can access MyCollab with address http://<your LAN IP>/ for example.

pull_method:
The method to pull data from server to client. They are two values: push or pull. Push method is recommended, but if your network causes the push method does not work properly then you should use pull method


#====================================================
# DATABASE CONFIGURATION
#====================================================

db.driverClassName: Value must be com.mysql.jdbc.Driver

db.url: The format string must be jdbc:mysql://{database server}/{database schema}?useUnicode=true&characterEncoding=utf-8&autoReconnect=true. Where:

  • database server: address of MySQL database server. For instance, if you install MySQL at the same machine which install MyCollab, then you can set value is localhost, otherwise you can set database server has value is machine name, or IP address in your LAN network.
  • database schema: schema name of MyCollab database you has created. See how to create MyCollab schema at here

db.username: Database user name

db.password: Database password

#=====================================================
# MAIL CONFIGURATION
# SMTP Mail setting to use in
#=====================================================

mail.smtphost: Host of your SMTP server

mail.port: Port of your SMTP server

mail.username: SMTP username

mail.password: SMTP password

mail.isTLS: true/false value indicate whether SMTP use StartTls or not

mail.isSSL: true/false value indicate whether SMTP use SSL or not

#=====================================================
# ERROR REPORTING
# This email is used to receive any error causes during
# MyCollab running. It just collect java stack trace not
# any end user sensitive data. In case you are serious not
# want to send report automatically to our team, you can
# leave this field to empty
#=====================================================

error.sendTo:support@mycollab.com


#=====================================================
# LINK CONFIGURATION
# You should not change these values.
#=====================================================

cdn.url:Value must be http://%s:%d/assets/

app.url:Value must be http://%s:%d/

resource.downloadUrl: Value must be http://%s:%d/file/

Example

Below is the full example of mycollab.properties we use in our development workspace

#SITE CONFIGURATION

site.name=localhost

server.address=localhost
pull_method=push

#DATABASE CONFIGURATION

db.driverClassName=com.mysql.jdbc.Driver

db.url=jdbc:mysql://localhost/mycollab_live?useUnicode=true&characterEncoding=utf-8&autoReconnect=true

db.username=root

db.password=***

mail.smtphost=smtp.gmail.com

mail.port=587

mail.username=mail@esofthead.com

mail.password=****

mail.isTLS=true

mail.isSSL=false

#ERROR REPORTING

error.sendTo=support@mycollab.com

#LINKS CONFIGURATION

cdn.url=http://%s:%s/assets/

app.url=http://%s:%s/

resource.downloadUrl=http://%s:%d/file/

Was this article helpful to you? Yes 3 No

How can we help?