Windows and Mac

Running MateCat natively on Mac or Windows is not supported.
If you want to install MateCat on Windows or Mac we suggest using the virtual machine appliance provided.
This guide will focus solely on Linux setup.

Linux

This guide will assume you are on a Debian based Linux distribution (Debian >= 6 or Ubuntu >= 12.04).

Important notice for ActiveMQ and Redis (optional)

ActiveMQ provides a Web Console binded on port 61613.
This means that if your machine is accessible externally, then everyone can access the web console.
In the same way, Redis accepts command-line connections on port 6379.
Remember to add the proper firewall rules to prevent unauthorized access.Go to top

Installing MateCat

This section assumes you’ll install MateCat under the home of user matecat (/home/matecat).
In order to create that user, use the following:

adduser --disabled-password --gecos "" matecat

Install git and clone the repository

If you already have GIT, skip this section. Otherwise, install GIT by typing:

apt-get install git

Switch to the newly created user

su - matecat

Then clone the repository in /home/matecat:

git clone https://github.com/matecat/MateCat.git cattool

The above will create the directory cattool and will download all MateCat codebase in it. Go to top

Initialize the database

Navigate to the configuration directory:

cd ~/cattool/lib/Model

and send the database template to your MySQL instance with the following command

mysql -u root -p < matecat.sql

Type the MySQL root password when prompted

Important notice for remote MySQL setups (optional)

Please note that the grants for the default database user (matecat) are open to any host: matecat@%.
In case you are deploying the database on a public server we suggest to limit the hosts with access privileges.

Use the commands below to limit access to localhost only, or replace “localhost” with the IP of the server MateCat is running on:

Open a MySQL shell (type the password when prompted)

mysql -u root -p

Delete the current “matecat” user

delete from mysql.user where user = 'matecat' and host = '%';

Create a new matecat user with access privileges limited to only some hosts

grant all privileges on matecat.* to 'matecat'@'localhost' identified by 'matecat01';

Create the virtualhost

Navigate to the directory

cd ~/cattool/INSTALL

Create the virtualhost file from the sample template

cp matecat-vhost.conf.sample matecat-vhost.conf

and use the following command for replacing the string @@@path@@@ in the virtualhost with the fullpath of the cattool folder previously created via the clone action (in this guide it’s assumed to be /home/matecat/cattool):

sed -i "s/@@@path@@@/\/home\/matecat\/cattool/g" matecat-vhost.conf

IMPORTANT NOTE: In the virtualhost file are specified the maximum values for memory, upload and post size.
By default these values are:

memory_limit: 1024M

upload_max_filesize: 200M

post_max_size: 200M

If you need to change these values, open the virtualhost in an editor:

nano matecat-vhost.conf

And customize the default settings. Finally, save and close the editor.

Turning on Node.js

Enabling Google+ login

Warning: this feature is optional, but without it MateCat can only be used in anonymous mode

MateCat uses Google+ login as authentication mechanism: you can keep track of your projects in a private panel under “Manage” section by logging in with any valid Google account. Note that this is not limited to GMail: any valid email address can be used, upon registration as a Google account.

In order to enable it, you need a Google account
If you don’t have a client id and client secret, please visit Google Developers Console and follow these instructions:

click on “Create Project“, specify a project name, a project ID and check “I agree with Google ToS” checkbox; it may take a little to create your project

click on your newly created project

select “APIs & auth” on left sidebar

scroll down the list to “Google+ API” and switch the status of ON

go back to left sidebar and, under “APIs & auth” menu, select “Credentials“

click on “Create new client ID” buttonu

under APPLICATION TYPE, select “Web application” option

under AUTHORIZED JAVASCRIPT ORIGINS, insert the domain MateCat will be accessed from

under REDIRECT URIs, insert “http://<domain>/oauth/response” or “http://localhost/oauth/response”, where <domain> is the domain that you specified in the previous step

click on “Create client ID“. Take note of the “Client ID” and a “Client secret” you just obtained

In this case you can ignore the FILTERS_MASHAPE_KEY parameter, it has no effect for instances running outside of Mashape.

Pay attention that MateCat Filters relies on some commercial components to support certain filetypes (PDF and OCR, for example).
If you run a local instance of MateCat Filters you’ll have to buy and install the required commercial components to support all the file formats.
Using the hosted version available on Mashape you don’t have to bother about this.

For all the info on MateCat Filters and a full list of the hosted API features see filters.matecat.com.

Update MateCat

If you have already installed your MateCat instance, follow this guide to keep your instance up to date.

Connect

MateCat is an enterprise-level, online CAT tool which makes post-editing and outsourcing easy

Enterprise Users? Contact Us

MateCat is used by large enterprises not just as a CAT tool, but also as a platform to build innovative services and tools. We provide software customization, hosting, dedicated support etc. for companies, organizations and translation agencies with specific requirements. Contact us for more information.