Installing MyCollab – Free and open source project management software

  1. Home
  2. Hosting MyCollab on your own server
  3. Installing MyCollab

Installing MyCollab

System requirements

  • Java Runtime Environment 8+: MyCollab could run when any JVM-compatible platform such as Oracle JRE or OpenJDK.
  • MySQL database, version 5.5+: the higher version is better
  • 1 GB RAM minimum, 2 GB RAM recommended

Download MyCollab

MyCollab has two editions:

  • MyCollab Ultimate Edition: the paid edition which provides full features of MyCollab, run faster, and a dedicated support team. This edition is suitable for a professional team who want to keep update all aspects of project activities. MyCollab Ultimate Edition offers 30 days free trial, and you can download it at https://www.mycollab.com/ee-registration/
  • MyCollab Community Edition: this free and open source edition which is the lite edition of MyCollab Ultimate Edition. It provides the essential features of tasks, issues, knowledge management, and other project activities management. Its download address is https://www.mycollab.com/ce-registration/.

Both editions share the same installation method, and requires you register an account to get the download link.

After downloading MyCollab installer file, unzip MyCollab-All-x.x.x.zip to the machine folder. Please note the user must have the write permission to that folder while MyCollab requests the write permission to write the config file at the first time you start using MyCollab.

Install MySQL server

You need to install MySQL server since MyCollab stores all data in MySQL server. If you do not install MySQL server yet, this link http://dev.mysql.com/doc/refman/5.7/en/installing.html will help you install the latest MySQL server version.

Create MyCollab database

MyCollab needs a database to run; you must create a MySQL schema by the following command:

CREATE SCHEMA mycollab DEFAULT CHARACTER SET utf8mb4 ;

Below is our example in screenshot to create the MyCollab schema

Screen Shot 2016-03-31 at 5.29.12 PM

We use character set uft8mb4 instead of utf8, you can review the difference between them at http://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html

Install Java and verify Java path

If you already know how to set up Java and your server already installed Java Runtime Environment 8+, then you can ignore this step. Otherwise, below guidelines are helpful for you

If Java is not present:

Open the console window, and type java -version. If the response message says it can not recognize Java program, then you must add java to the system path variables. Check the guideline in this link https://docs.oracle.com/javase/tutorial/essential/environment/paths.html. You must make sure Java is installed correctly on your server; otherwise, you can not run MyCollab successfully from next step.

If you are running MyCollab on Linux, you can install the Open-JDK as well

apt-get install openjdk-8-jdk

Start MyCollab

Go to %MYCOLLAB_HOME%/bin (where %MYCOLLAB_HOME% is the folder which you installed MyCollab) and start MyCollab.

Detailed instructions:

Windows
Linux, Unix, and Others
MacOS

Install MyCollab

You open the browser then type http://serveraddress:8080 to setup MyCollab, if you open browser on the server you installed MyCollab then you can use http://localhost:8080

MyCollab will show the installation page ask you several inputs to help you install MyCollab easily

MyCollab installation page

Site name: MyCollab or any value you like. The site name displays in email or browser window title

Server address: localhost is the value uses for only testing while you run MyCollab. Otherwise, you should select the server name such as the machine IP (static IP) in your LAN or domain name if you use MyCollab in WAN

Enter database server address: localhost

Note: We assume you install MySQL dev database in the same of MyCollab. Otherwise, please type the right address of MySQL that MyCollab can access.

Database name (You must create the database before): mycollab

User name: <Your value>

Password:<Your value>

Database Server Address: <Your value>

Then we will ask you give us an SMTP configuration in order MyCollab can send system notifications to you and your team.

Note: you can skip SMTP setting if you do not need to receive notification from your MyCollab installation, but we encourage you must set up SMTP to utilize the power of MyCollab in sending email notifications to notify you and your team whether an assignment is created and assigned or so on.

SMTP server name: <Your SMTP server> (Example: smtp.gmail.com)

Port: <Your SMTP server port> (Example: 587)

User name: <Your mail user name> (Example: mycollab@gmail.com)

Password: <Your mail password> (Example: Your gmail password)

Enable StartTls (y/n): <Enable StartTls or not> (Example: yes for Gmail service provider)

Enable TLS/SSL(y/n): <Enable Tls/SSL or not> (Example: yes for Yahoo or several other service providers)

Note: By default, MyCollab will run on the port 8080. You can change this port value to any value you want by edit and change variable MYCOLLAB_PORT in script mycollab.bat (on Windows) or mycollab.sh (on Linux, Unix or MacOS) and restart the server.

After filling all required fields and press button ‘Upgrade & Go’, MyCollab will validate all input fields and do the installation steps such as writing config files, write data into the database, etc. This process may take several minutes. After MyCollab finishes the installation process, it will redirect you to the MyCollab page

 

 

By default, MyCollab will run on the port 8080. You can change this port value to any value you want by edit and change variable port in the config file mycollab.ini at the folder %MYCOLLAB_HOME%/bin, and restart server

Login

  • If you are running MyCollab 5.3 and higher, at the first time of running MyCollab, it will redirect you to the page to setup the first user, account settings, and sample project data

Screen Shot 2016-06-07 at 2.26.31 PM

 

After adding the new user, MyCollab will redirect you to the project dashboard.

If you are running the MyCollab 5.2.+ and below, go to http://server_name:server_port/ and sign in as: Username: admin@mycollab.com Password: admin123

Troubleshooting

Having problems? See Common errors in installation

Translating MyCollab to your language

Help us to translate MyCollab to your language. No programming knowledge is required!

Was this article helpful to you? Yes 29 No

How can we help?