Version at: 01/02/2015, 17:17 vs. version at: 01/02/2015, 17:53
11# How to Install Tatoeba
22
33Introduction
44---------------
55
66Unless you are a Windows user, we recommend that you use [IMOUTO](https://github.com/Tatoeba/admin) to install Tatoeba so that you do not have to configure everything manually.
77
88If you are a Windows user or if for some reason you have issues with IMOUTO, you can still try to set things up manually. This article will try to guide you in doing that.
99
1010
1111Required tools
1212------------------
1313
1414You will need to install the following:
1515
1616* Apache
1717* PHP 5.3
1818* MySQL
1919* Git client
20* imagick (for resizing images for profile avatars) This can be ignored for local development of the code.
2120
2221#### Windows users
2322
2423* [XAMPP](http://www.apachefriends.org/en/xampp-windows.html) will do the trick for Apache/PHP/MySQL. But you may need to use version **1.7.7** of XAMPP rather than the latest version, because Tatoeba currently uses PHP 5.3.
2524* You can use [Github for Windows](https://windows.github.com/) as your Git client.
2625
2726#### Mac or Linux users
2827
2928* [XAMPP](http://www.apachefriends.org/en/xampp.html) works, too.
3029
3130
3231Source code
3332--------------
3433
3534Clone our [Git repository](https://github.com/Tatoeba/tatoeba2).
3635
3736 git clone https://github.com/Tatoeba/tatoeba2.git
3837
3938Virtual host
4039---------------
4140
4241If you already have some other websites set up on your machine, you will need to set up a virtual host. The point is that instead of going to something like **http://localhost/tatoeba2**, you go to some custom URL. I personally use **http://tatoeba.dev/**.
4342
4443The reason is because CakePHP will not handle the URL rewriting properly if you try to browse through a subdirectory. You will get some error saying something like "The action tatoeba2 is not defined in controller PagesController".
4544
4645If you don't know how to set up a virtual host, you should be able to find tutorial by googling it. Here are some links:
4746
4847* On Mac using XAMPP:
4948[http://f6design.com/journal/2012/03/11/configuring-virtualhosts-in-xampp-on-mac/](http://f6design.com/journal/2012/03/11/configuring-virtualhosts-in-xampp-on-mac/)
5049* On Windows 7 using XAMPP:
5150[http://austinpassy.com/tutorials/setting-up-virtual-hosts-wordpress-multisite-with-xampp-on-windows-7/](http://austinpassy.com/tutorials/setting-up-virtual-hosts-wordpress-multisite-with-xampp-on-windows-7/)
5251
5352
5453Create the config files
5554--------------------------
5655
5756### core.php
5857
5958Copy the file `app/config/core.php.template` and name it `core.php`.
6059
6160Make sure you have the search and autotranscription disabled.
6261
6362 Configure::write('Search.enabled', false);
6463 Configure::write('AutoTranscriptions.enabled', false);
6564
6665
6766### database.php
6867
6968Copy the file `app/config/database.php.template` and name it `database.php`.
7069
7170In the file `app/config/database.php`, set your login, password and database in the $default array.
7271
7372 var $default = array(
7473 'driver' => 'mysql',
7574 'persistent' => false,
7675 'host' => 'localhost',
7776 'login' => 'root',
7877 'password' => 'somepassword',
7978 'database' => 'tatoeba',
8079 'prefix' => '',
8180 'encoding' => 'utf8'
8281 );
8382
8483You don't have to worry about the rest of the file at this stage.
8584
8685
8786
8887Database
8988-------------------
9089
9190### Create the database
9291
9392First, create the database. Make sure the name you use here is the name you've set in `app/core/database.php`. I'll name it `tatoeba`.
9493
9594 CREATE DATABASE tatoeba
9695 USE tatoeba
9796
9897### Create the tables and import the data
9998
10099#### From Trang's database
101100
102101The easiest solution is to download the copy of [Trang's local database](https://dl.dropboxusercontent.com/u/953908/tatoeba/tatoeba_database.sql). It contains data from 2010, that is around 600k sentences.
103102
104103You can import the database with the command:
105104
106105 mysql -u username -p database_name < tatoeba_database.sql
107106
108107All the passwords have been replace so you will be able to log in with the password `123` on any login.
109108
110109#### From the scripts in docs/database
111110
112111Another solution is to execute all the scripts in this order:
113112
114113* scripts in `docs/database/tables`
115114* scripts in `docs/database/triggers`
116115* scripts in `docs/database/import`
117116
118117From there you will be able to log in with `123456` with one of the following usernames:
119118
120119* admin
121120* corpus_maintainer
122121* advanced_contributor
123122* contributor
124123* inactive
125124* spammer
126125
127126
128127Other things you may have to configure
129128----------------------------------------------
130129    
131130### tmp folder writable
132131
133132Make sure your `/app/tmp/cache` is writabe as well as any folder in it (models, persistent, views).
134133
135134### thread_stack for XAMPP on a Mac
136135
137136You'll need to up the default thread_stack from 64K to 256K.
138137`/Applications/XAMPP/xamppfiles/etc/my.cnf`
139138`thread_stack = 256K`
140139
141140
142141
143142Other Things to Install
144143--------------------------
145144
146145These can be ignored for local development of the code, but need to be installed in order to get the app fully operational.
147146
148147* imagick (for resizing images for profile avatars)
149148* Sphinx search engine
150149* Furigana
151150* autocompletion for tags is based on suggestd (TODO put link an explanation on how to compile/use it)
152151* for Chinese/Cantonese the transliteration is generated by sinoparserd (TODO add more explanation)
153152* language autodetection is based on tatodetect
diff view generated by jsdifflib

Version at: 01/02/2015, 17:17

# How to Install Tatoeba

Introduction
---------------

Unless you are a Windows user, we recommend that you use [IMOUTO](https://github.com/Tatoeba/admin) to install Tatoeba so that you do not have to configure everything manually.

If you are a Windows user or if for some reason you have issues with IMOUTO, you can still try to set things up manually. This article will try to guide you in doing that.


Required tools
------------------

You will need to install the following:

* Apache
* PHP 5.3
* MySQL
* Git client
* imagick (for resizing images for profile avatars) This can be ignored for local development of the code.

#### Windows users

* [XAMPP](http://www.apachefriends.org/en/xampp-windows.html) will do the trick for Apache/PHP/MySQL. But you may need to use version **1.7.7** of XAMPP rather than the latest version, because Tatoeba currently uses PHP 5.3.
* You can use [Github for Windows](https://windows.github.com/) as your Git client.

#### Mac or Linux users

* [XAMPP](http://www.apachefriends.org/en/xampp.html) works, too.


Source code
--------------

Clone our [Git repository](https://github.com/Tatoeba/tatoeba2).

    git clone https://github.com/Tatoeba/tatoeba2.git

Virtual host
---------------

If you already have some other websites set up on your machine, you will need to set up a virtual host. The point is that instead of going to something like **http://localhost/tatoeba2**, you go to some custom URL. I personally use **http://tatoeba.dev/**.

The reason is because CakePHP will not handle the URL rewriting properly if you try to browse through a subdirectory. You will get some error saying something like "The action tatoeba2 is not defined in controller PagesController".

If you don't know how to set up a virtual host, you should be able to find tutorial by googling it. Here are some links:

* On Mac using XAMPP:
[http://f6design.com/journal/2012/03/11/configuring-virtualhosts-in-xampp-on-mac/](http://f6design.com/journal/2012/03/11/configuring-virtualhosts-in-xampp-on-mac/)
* On Windows 7 using XAMPP:
[http://austinpassy.com/tutorials/setting-up-virtual-hosts-wordpress-multisite-with-xampp-on-windows-7/](http://austinpassy.com/tutorials/setting-up-virtual-hosts-wordpress-multisite-with-xampp-on-windows-7/)


Create the config files
--------------------------

### core.php

Copy the file `app/config/core.php.template` and name it `core.php`.

Make sure you have the search and autotranscription disabled.

    Configure::write('Search.enabled', false);
    Configure::write('AutoTranscriptions.enabled', false);


### database.php

Copy the file `app/config/database.php.template` and name it `database.php`.

In the file `app/config/database.php`, set your login, password and database in the $default array.

    var $default = array(
        'driver' => 'mysql',
        'persistent' => false,
        'host' => 'localhost',
        'login' => 'root',
        'password' => 'somepassword',
        'database' => 'tatoeba',
        'prefix' => '',
        'encoding' => 'utf8'
    );

You don't have to worry about the rest of the file at this stage.



Database
-------------------

### Create the database

First, create the database. Make sure the name you use here is the name you've set in `app/core/database.php`. I'll name it `tatoeba`.

    CREATE DATABASE tatoeba
    USE tatoeba

### Create the tables and import the data

#### From Trang's database

The easiest solution is to download the copy of [Trang's local database](https://dl.dropboxusercontent.com/u/953908/tatoeba/tatoeba_database.sql). It contains data from 2010, that is around 600k sentences.

You can import the database with the command:

    mysql -u username -p database_name < tatoeba_database.sql

All the passwords have been replace so you will be able to log in with the password `123` on any login.

#### From the scripts in docs/database

Another solution is to execute all the scripts in this order:

* scripts in `docs/database/tables`
* scripts in `docs/database/triggers`
* scripts in `docs/database/import`

From there you will be able to log in with `123456` with one of the following usernames: 

* admin
* corpus_maintainer
* advanced_contributor
* contributor
* inactive
* spammer


Other things you may have to configure
----------------------------------------------
	
### tmp folder writable

Make sure your `/app/tmp/cache` is writabe as well as any folder in it (models, persistent, views). 

### thread_stack for XAMPP on a Mac

You'll need to up the default thread_stack from 64K to 256K.
`/Applications/XAMPP/xamppfiles/etc/my.cnf`
`thread_stack = 256K`



Other Things to Install
--------------------------

These can be ignored for local development of the code, but need to be installed in order to get the app fully operational.

* imagick (for resizing images for profile avatars)
* Sphinx search engine
* Furigana
* autocompletion for tags is based on suggestd (TODO put link an explanation on how to compile/use it)
* for Chinese/Cantonese the transliteration is generated by sinoparserd (TODO add more explanation)
* language autodetection is based on tatodetect

version at: 01/02/2015, 17:53

# How to Install Tatoeba

Introduction
---------------

Unless you are a Windows user, we recommend that you use [IMOUTO](https://github.com/Tatoeba/admin) to install Tatoeba so that you do not have to configure everything manually.

If you are a Windows user or if for some reason you have issues with IMOUTO, you can still try to set things up manually. This article will try to guide you in doing that.


Required tools
------------------

You will need to install the following:

* Apache
* PHP 5.3
* MySQL
* Git client

#### Windows users

* [XAMPP](http://www.apachefriends.org/en/xampp-windows.html) will do the trick for Apache/PHP/MySQL. But you may need to use version **1.7.7** of XAMPP rather than the latest version, because Tatoeba currently uses PHP 5.3.
* You can use [Github for Windows](https://windows.github.com/) as your Git client.

#### Mac or Linux users

* [XAMPP](http://www.apachefriends.org/en/xampp.html) works, too.


Source code
--------------

Clone our [Git repository](https://github.com/Tatoeba/tatoeba2).

    git clone https://github.com/Tatoeba/tatoeba2.git

Virtual host
---------------

If you already have some other websites set up on your machine, you will need to set up a virtual host. The point is that instead of going to something like **http://localhost/tatoeba2**, you go to some custom URL. I personally use **http://tatoeba.dev/**.

The reason is because CakePHP will not handle the URL rewriting properly if you try to browse through a subdirectory. You will get some error saying something like "The action tatoeba2 is not defined in controller PagesController".

If you don't know how to set up a virtual host, you should be able to find tutorial by googling it. Here are some links:

* On Mac using XAMPP:
[http://f6design.com/journal/2012/03/11/configuring-virtualhosts-in-xampp-on-mac/](http://f6design.com/journal/2012/03/11/configuring-virtualhosts-in-xampp-on-mac/)
* On Windows 7 using XAMPP:
[http://austinpassy.com/tutorials/setting-up-virtual-hosts-wordpress-multisite-with-xampp-on-windows-7/](http://austinpassy.com/tutorials/setting-up-virtual-hosts-wordpress-multisite-with-xampp-on-windows-7/)


Create the config files
--------------------------

### core.php

Copy the file `app/config/core.php.template` and name it `core.php`.

Make sure you have the search and autotranscription disabled.

    Configure::write('Search.enabled', false);
    Configure::write('AutoTranscriptions.enabled', false);


### database.php

Copy the file `app/config/database.php.template` and name it `database.php`.

In the file `app/config/database.php`, set your login, password and database in the $default array.

    var $default = array(
        'driver' => 'mysql',
        'persistent' => false,
        'host' => 'localhost',
        'login' => 'root',
        'password' => 'somepassword',
        'database' => 'tatoeba',
        'prefix' => '',
        'encoding' => 'utf8'
    );

You don't have to worry about the rest of the file at this stage.



Database
-------------------

### Create the database

First, create the database. Make sure the name you use here is the name you've set in `app/core/database.php`. I'll name it `tatoeba`.

    CREATE DATABASE tatoeba
    USE tatoeba

### Create the tables and import the data

#### From Trang's database

The easiest solution is to download the copy of [Trang's local database](https://dl.dropboxusercontent.com/u/953908/tatoeba/tatoeba_database.sql). It contains data from 2010, that is around 600k sentences.

You can import the database with the command:

    mysql -u username -p database_name < tatoeba_database.sql

All the passwords have been replace so you will be able to log in with the password `123` on any login.

#### From the scripts in docs/database

Another solution is to execute all the scripts in this order:

* scripts in `docs/database/tables`
* scripts in `docs/database/triggers`
* scripts in `docs/database/import`

From there you will be able to log in with `123456` with one of the following usernames: 

* admin
* corpus_maintainer
* advanced_contributor
* contributor
* inactive
* spammer


Other things you may have to configure
----------------------------------------------
	
### tmp folder writable

Make sure your `/app/tmp/cache` is writabe as well as any folder in it (models, persistent, views). 

### thread_stack for XAMPP on a Mac

You'll need to up the default thread_stack from 64K to 256K.
`/Applications/XAMPP/xamppfiles/etc/my.cnf`
`thread_stack = 256K`



Other Things to Install
--------------------------

These can be ignored for local development of the code, but need to be installed in order to get the app fully operational.

* imagick (for resizing images for profile avatars)
* Sphinx search engine
* Furigana
* autocompletion for tags is based on suggestd (TODO put link an explanation on how to compile/use it)
* for Chinese/Cantonese the transliteration is generated by sinoparserd (TODO add more explanation)
* language autodetection is based on tatodetect

Note

The lines in green are the lines that have been added in the new version. The lines in red are those that have been removed.

Actions