Version at: 02/05/2015, 18:01 vs. version at: 02/05/2015, 18:06
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
2020
2121#### Windows users
2222
2323* [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.
2424* You can use [Github for Windows](https://windows.github.com/) as your Git client.
2525
2626#### Mac or Linux users
2727
2828* [XAMPP](http://www.apachefriends.org/en/xampp.html) works, too.
2929
3030
3131Source code
3232--------------
3333
3434Clone our [Git repository](https://github.com/Tatoeba/tatoeba2).
3535
3636 git clone https://github.com/Tatoeba/tatoeba2.git
3737
3838Virtual host
3939---------------
4040
4141If 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/**.
4242
4343The 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".
4444
4545If 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.
4646
4747On Mac using XAMPP:
4848
4949* [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/)
5050
5151On Windows using XAMPP:
5252
5353* [http://sawmac.com/xampp/virtualhosts/](http://sawmac.com/xampp/virtualhosts/)
5454* [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/)
5555* [https://www.youtube.com/watch?v=n9BB_-VLoaY](https://www.youtube.com/watch?v=n9BB_-VLoaY)
5656
57Briefly, you will need to edit your httpd-vhosts.conf and hosts files. To edit your hosts file on Windows, make sure that:
57Briefly, you will need to edit your httpd-vhosts.conf and hosts files.
58
59You will add a section like this to the end of the httpd-vhosts.conf file:
60
61
62 <VirtualHost *:80>
63 DocumentRoot "C:\xampp\htdocs"
64 ServerName localhost
65 </VirtualHost>
66
67 <VirtualHost *:80>
68 DocumentRoot "C:\xampp\htdocs\tatoeba2"
69 ServerName tatoeba.dev
70 <Directory "C:\xampp\htdocs\tatoeba2">
71 Order allow,deny
72 Allow from all
73 </Directory>
74 </VirtualHost>
75
76
77To edit your hosts file on Windows, make sure that:
5878
5979* your folder view options are not set up to hide system files (or you won't be able to see the hosts file)
6080* you are editing as administrator (or you won't be able to save your changes)
6181
6282Note that you will need to make sure that your hosts file contains the domain name that you want to use for your virtual host. For instance:
6383
6484 127.0.0.1 tatoeba.dev
6585
6686
6787Create the config files
6888--------------------------
6989
7090### core.php
7191
7292Copy the file `app/config/core.php.template` and name it `core.php`.
7393
7494Make sure you have the search and autotranscription disabled.
7595
7696 Configure::write('Search.enabled', false);
7797 Configure::write('AutoTranscriptions.enabled', false);
7898
7999
80100### database.php
81101
82102Copy the file `app/config/database.php.template` and name it `database.php`.
83103
84104In the file `app/config/database.php`, set your login, password and database in the $default array. If you want, you can set the value of 'password' to an empty string.
85105
86106 var $default = array(
87107 'driver' => 'mysql',
88108 'persistent' => false,
89109 'host' => 'localhost',
90110 'login' => 'root',
91111 'password' => 'somepassword',
92112 'database' => 'tatoeba',
93113 'prefix' => '',
94114 'encoding' => 'utf8'
95115 );
96116
97117You don't have to worry about the rest of the file at this stage.
98118
99119
100120
101121Database
102122-------------------
103123
104124### Create the database
105125
106126First, 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`.
107127
108128Make sure you have started Apache and MySQL from the XAMPP Control Panel. Now you can issue "mysql -u root" to start MySQL from a Windows prompt. Issue these commands:
109129
110130 CREATE DATABASE tatoeba;
111131 USE tatoeba;
112132
113133### Create the tables and import the data
114134
115135#### From Trang's database
116136
117137The easiest solution is to download the copy of [Trang's local database](https://dl.dropboxusercontent.com/u/953908/tatoeba/tatoeba_database.zip) (**69 MB**). It contains data from 2010, that is around 600k sentences.
118138
119139You can import the database with the command, which takes several minutes to run:
120140
121141 mysql -u username [-p] database_name < tatoeba_database.sql
122142
123143Within this database, the passwords for all users have been set to `123`.
124144
125145#### From the scripts in docs/database
126146
127147Another solution is to execute all the scripts in this order:
128148
129149* scripts in `docs/database/tables`
130150* scripts in `docs/database/triggers`
131151* scripts in `docs/database/import`
132152
133153From there you will be able to log in with `123456` with one of the following usernames:
134154
135155* admin
136156* corpus_maintainer
137157* advanced_contributor
138158* contributor
139159* inactive
140160* spammer
141161
142162
143163Other things you may have to configure
144164----------------------------------------------
145165    
146166### tmp folder writable
147167
148168Make sure your `/app/tmp/cache` and all folders in it (models, persistent, views) are writable.
149169
150170### thread_stack for XAMPP on a Mac
151171
152172You'll need to up the default thread_stack from 64K to 256K.
153173`/Applications/XAMPP/xamppfiles/etc/my.cnf`
154174`thread_stack = 256K`
155175
156176### short_open_tag = On
157177
158178Make sure `<?` is allowed as an open tag. In your `php.ini`, check that you have:
159179
160180 short_open_tag = On
161181
162182Other Things to Install
163183--------------------------
164184
165185These can be ignored for local development of the code, but need to be installed in order to get the app fully operational.
166186
167187* imagick (for resizing images for profile avatars)
168188* Sphinx search engine
169189* Furigana
170190* autocompletion for tags is based on suggestd (TODO put link an explanation on how to compile/use it)
171191* for Chinese/Cantonese the transliteration is generated by sinoparserd (TODO add more explanation)
172192* language autodetection is based on tatodetect
diff view generated by jsdifflib

Version at: 02/05/2015, 18:01

# 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 using XAMPP:

* [http://sawmac.com/xampp/virtualhosts/](http://sawmac.com/xampp/virtualhosts/)
* [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/)
* [https://www.youtube.com/watch?v=n9BB_-VLoaY](https://www.youtube.com/watch?v=n9BB_-VLoaY)

Briefly, you will need to edit your httpd-vhosts.conf and hosts files. To edit your hosts file on Windows, make sure that:

* your folder view options are not set up to hide system files (or you won't be able to see the hosts file)
* you are editing as administrator (or you won't be able to save your changes) 

Note that you will need to make sure that your hosts file contains the domain name that you want to use for your virtual host. For instance:

    127.0.0.1    tatoeba.dev


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. If you want, you can set the value of 'password' to an empty string.

    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`. 

Make sure you have started Apache and MySQL from the XAMPP Control Panel. Now you can issue "mysql -u root" to start MySQL from a Windows prompt. Issue these commands:

    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.zip) (**69 MB**). It contains data from 2010, that is around 600k sentences.

You can import the database with the command, which takes several minutes to run:

    mysql -u username [-p] database_name < tatoeba_database.sql

Within this database, the passwords for all users have been set to `123`.

#### 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` and all folders in it (models, persistent, views) are writable. 

### 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`

### short_open_tag = On

Make sure `<?` is allowed as an open tag. In your `php.ini`, check that you have:

    short_open_tag = On

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: 02/05/2015, 18:06

# 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 using XAMPP:

* [http://sawmac.com/xampp/virtualhosts/](http://sawmac.com/xampp/virtualhosts/)
* [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/)
* [https://www.youtube.com/watch?v=n9BB_-VLoaY](https://www.youtube.com/watch?v=n9BB_-VLoaY)

Briefly, you will need to edit your httpd-vhosts.conf and hosts files. 

You will add a section like this to the end of the httpd-vhosts.conf file:


    <VirtualHost *:80>
        DocumentRoot "C:\xampp\htdocs"
        ServerName localhost
    </VirtualHost>
 
    <VirtualHost *:80>
      DocumentRoot "C:\xampp\htdocs\tatoeba2"
      ServerName tatoeba.dev
      <Directory "C:\xampp\htdocs\tatoeba2">
        Order allow,deny
        Allow from all
      </Directory>
    </VirtualHost>


To edit your hosts file on Windows, make sure that:

* your folder view options are not set up to hide system files (or you won't be able to see the hosts file)
* you are editing as administrator (or you won't be able to save your changes) 

Note that you will need to make sure that your hosts file contains the domain name that you want to use for your virtual host. For instance:

    127.0.0.1    tatoeba.dev


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. If you want, you can set the value of 'password' to an empty string.

    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`. 

Make sure you have started Apache and MySQL from the XAMPP Control Panel. Now you can issue "mysql -u root" to start MySQL from a Windows prompt. Issue these commands:

    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.zip) (**69 MB**). It contains data from 2010, that is around 600k sentences.

You can import the database with the command, which takes several minutes to run:

    mysql -u username [-p] database_name < tatoeba_database.sql

Within this database, the passwords for all users have been set to `123`.

#### 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` and all folders in it (models, persistent, views) are writable. 

### 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`

### short_open_tag = On

Make sure `<?` is allowed as an open tag. In your `php.ini`, check that you have:

    short_open_tag = On

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