Actions

Installation FAQ/zh-hant: Difference between revisions

From LimeSurvey Manual

(Updating to match new version of source page)
(Updating to match new version of source page)
Line 4: Line 4:
=Installation on your computer=
=Installation on your computer=


LimeSurvey can be installed on your computer with MAMP/XAMP or any other system. But your computer is not a web server : it's not accessible via web by other user.  
LimeSurvey can be installed on your computer with MAMP/XAMP or any other system. But your computer is not a web server - it's not accessible via web to any other user.  


Then if you want to spread your survey on the web : you have to  
In order to make your survey reachable to other users via the web, you need to either:


* own a server  
* own a server or a web space from a host provider;
* or a web space at a hoster
* or find a LimeSurvey-specialized host provider.
* find a LimeSurvey instance specialized hoster


{{Alert|Installation on your computer is not done to share your survey on internet.}}
{{Alert|An installation on your computer is not done to share your survey on internet!}}


=Starting installation=
=Starting installation=


===如果我無法透過安裝程序建立數據庫,怎麼辦?===
==How can I create a database and a user in MySQL with command line access?==


You have to enter the below commands in your mysql.
You have to enter the below commands in your MySQL:


create database '''<your_database_name>''';
*<code>create database '''<your_database_name>''';</code>


create user '''<your_database_username>''';
*<code>create user '''<your_database_username>''';</code>


create user '''<your_database_username>'''@localhost;
*<code>create user '''<your_database_username>'''@localhost;</code>


set password for '''<your_database_username>''' = PASSWORD(''''<your_database_password>'''');
*<code>set password for '''<your_database_username>''' = PASSWORD(''''<your_database_password>'''');</code>


set password for '''<your_database_username>'''@localhost = PASSWORD(''''<your_database_password>'''');
*<code>set password for '''<your_database_username>'''@localhost = PASSWORD(''''<your_database_password>'''');</code>


grant all on '''<your_database_name>'''.* to ''''<your_database_username>'''';
*<code>grant all on '''<your_database_name>'''.* to ''''<your_database_username>'''';</code>


grant all on '''<your_database_name>'''.* to ''''<your_database_username>''''@'localhost';
*<code>grant all on '''<your_database_name>'''.* to ''''<your_database_username>''''@'localhost';</code>


You have to replace '''<your_database_name>''', '''<your_database_username>''' and '''<your_database_password>''' in above commands with according values.
In terminal, <code>'''<your_database_name>'''</code>, <code>'''<your_database_username>'''</code>, and <code>'''<your_database_password>'''</code> have to be replaced with the according/desired values.


===我應該設定甚麼權限?===
===我應該設定甚麼權限?===


/limesurvey/tmp 目錄需要設定 read/write/execute  的使用權限 (chmod 777) - 本目錄存放所有上傳檔案及暫時建立的檔案. 其他全部目錄及檔案可以設定為 read/execute 的使用權限 (chmod 755). 但是 如果您想使用內建的 apache 安全工具 (去建立 htpasswd 及 htaccess 檔案) admin 目錄就需要設定成 read/write/execute (777). admin 目錄裏面的檔案則可以設定成 read/execute (chmod 755).
Normally, the script creates a new database, and then the table structure. However, if your server/ISP doesn't give you admin rights to create a new database in MySQL, you will need to contact your server administrator to get the necessary database created (or create it yourself if you receive the required permissions). The newly created blank database should include the appropriate access rights (i.e.: read/write/create). Then, you should be able start the LimeSurvey installation, which will create the tables within the newly created database.


==Blank page when accessing the Install page==
==Blank page when accessing the Install page==
Line 45: Line 44:
*Verify you have the MySQL PHP module (php-mysql) installed.
*Verify you have the MySQL PHP module (php-mysql) installed.
*Verify your PHP install is loading the PHP.ini file your are modifying and not parsing other PHP.INI files on your system.
*Verify your PHP install is loading the PHP.ini file your are modifying and not parsing other PHP.INI files on your system.
*Verify the location and permissions of the following setting in your PHP.ini
*Verify the location and permissions of the following setting in your PHP.ini:


<syntaxhighlight lang="c" enclose="div">upload_tmp_dir="/temp"
<syntaxhighlight lang="c" enclose="div">upload_tmp_dir="/temp"


session.save_path="/temp"</syntaxhighlight>
session.save_path="/temp"</syntaxhighlight>
*Verify your server runs a suitable PHP version (e.g. this "blank page" problem appeared with PHP v4.4 and LimeSurvey v2.00+).
*Verify if your server runs a suitable PHP version.


==Error messages because of non-existing resources==
==Error messages because of non-existing resources==


Sometimes files are not uploaded correctly or were broken during upload. This leads to several different error messages. Most of them refer to a file or function within a file which can't be found.
Sometimes, files are not uploaded correctly or were broken during the upload process. This leads to several different error messages. Most of them refer to a file or function within a file which can't be found.


'''Solution:''' Re-upload all files using the binary mode of your FTP program.
'''Solution:''' Re-upload all files using the binary mode of your FTP program.
Line 60: Line 59:
=Requirements page=
=Requirements page=


===mbstring (Multibyte String Functions) library 是甚麼?===
==What is the mbstring (Multibyte String Functions) library?==


The mbstring library PHP 函數程序庫,可以把字元集轉換語言. 如果你要執行 LimeSurvey.,京可能用得上它。 想檢視一下是否已安裝這個函數程序庫,你可以在網站空間建立一個 test.php 檔案,內容如下︰
The mbstring library is a PHP library that can convert char sets from one language to another. You need it if you want to run LimeSurvey. To check if it is already installed, open the URL from an web browser:


  <nowiki>http://<your_server>/<your_limesurvey_directory>/admin/install/phpinfo.php</nowiki>
  <nowiki>http://<your_server>/<your_limesurvey_directory>/admin/install/phpinfo.php</nowiki>


然後用瀏覽器打開檔案,你會看到一些信息. 查看字串 'mbstring'. 如果找得到,請繼續. 如果你找不到,可能出於以下的原因︰
A lot of information will be shown. Search for the string 'mbstring' under the '''Configuration''' section. If you find the mbstring section then all should be well and you can continue on with your LimeSurvey installation!


If you find the mbstring section then all should be well and you can continue on with your LimeSurvey installation!
'''If you don't find the mbstring section''', you might have a problem on your hands. There are three possible scenarios:
 
*If it's your host provider's server, ask for the activation of that extension in PHP or further information on how you can activate it - if you have a good administration panel for your server, you may be able to activate it yourself;
'''If you don't find the mbstring section''' you might have a problem on your hands.
*If it's your own '''Linux''' server, you may have to re-compile PHP and include the mbstring library. Ask the Linux experts how to do that. However, you can install it using your Linux package manager, which is mostly available in all Linux distributions nowadays;
 
**If you are using a version of Linux that supports 'yum' (CentOS, RedHat, Fedora):
然後用瀏覽器打開檔案,你會看到一些信息. 查看字串 'mbstring'. 如果找得到,請繼續. 如果你找不到,可能出於以下的原因︰
***Use the terminal (as a super user) and type: '''yum install php-mbstring''';
*問題出在伺服器供應商. 向它請求啟用 php 內的該項延伸功能. 如果它介以客為尊,就可以照樣辦得到。
***Make sure to update /etc/php.ini and uncomment the various mbstring params;
*問題出在你的 Linux 伺服器. 你要重新編譯 PHP ,並包含 mbstring library. 可以請救 Linux 專家的做法.
***Make sure to restart apache after installing it: '''/etc/init.d/httpd restart''';
**如果使用支援 'yum' (CentOS, RedHat, Fedora) 的Linux 系統, 你可以容易使用到終端機鍵入:
*If it's your own '''Windows''' server, search for php.ini on your system, open it with an editor and search for mbstring. Most probably, the line that contains that string is commented out with a semicolon. Remove the semicolon, save, and restart your web server.
***'''yum install php-mbstring'''
**安裝後必須重新啟動 apache:
***'''/etc/init.d/httpd restart'''
*問題出在你的 windows 伺服器. Oh.. 這容易之至. 在系統搜尋 php.ini 檔案, 然後用編輯器打開它去搜尋 mbstring. 通常這一句的句首會有分號標示為註腳. 只需要移除這個分號,存檔,然後把伺服器重新開機即可。


== Stuck at checking file system permissions ==
== Stuck at checking file system permissions ==
If SELinux is activated (primarily on CentOS) then you might get an error that the file system permissions are not correct but the list of directories is empty. SELinux prevents writing even though the permissions are on e.g. 777 or 755.
If SELinux is activated (primarily on CentOS), then you might get an error that the file system permissions are not correct, even if the list of directories is empty. SELinux prevents writing even though the permissions are on for example on 777 or 755. To configure SELinux correctly for your server - check out the [https://wiki.centos.org/HowTos/SELinux SELinux documentation].
You need to configure SELinux for your server correctly - check out the [https://wiki.centos.org/HowTos/SELinux SELinux documentation].


=After database creation=
=After database creation=
Line 91: Line 85:
===Symptoms===
===Symptoms===
* LimeSurvey installed OK, and database was created, but instead of the admin page, you get an empty page
* LimeSurvey installed OK, and database was created, but instead of the admin page, you get an empty page
* Web surver log shows "Fatal error: Call to a member function on a non-object in /path/to/limesurvey/admin/login_check.php on line 69"
* Web server log shows "Fatal error: Call to a member function on a non-object in /path/to/limesurvey/admin/login_check.php on line 69"


===Fix===
===Fix===


This is probably an incorrect setting for $rooturl or $rootdir in config.php. In particular, config.php attempts to set $rootdir correctly by calling <nowiki>dirname('''FILE''')</nowiki> and while this usually works, it can be upset when LimeSurvey is installed in a user's home or public_html directory and the home directory is mounted over NFS. Try setting $rootdir manually, and in particular, while your shell or pwd command may show a path like "/disks/hostname/home/username/public_html/limesurvey", try using "/home/username/public_html/limesurvey".
This is probably related to an incorrect setting for <code>$rooturl</code> or <code>$rootdir</code> in config.php. The file config.php attempts to set <code>$rootdir</code> correctly by calling <code><nowiki>dirname('''FILE''')</nowiki></code>. While this usually works, it can be upset when LimeSurvey is installed in a user's home or public_html directory and the home directory is mounted over NFS. To set up manually the <code>$rootdir</code>, (your shell or pwd command may show you a path like "/disks/hostname/home/username/public_html/limesurvey"), try using "/home/username/public_html/limesurvey".


==When accessing admin page, the browser keeps running and will eventually fail to show it==
==When accessing the admin page, the browser keeps running and will eventually fail to show it==


===Symptoms===
===Symptoms===
* LimeSurvey installed OK and database was created. But when you access the admin page, the browser keeps running and will eventually fail to show the page.
* LimeSurvey installed OK and the database was created. But when you access the admin page, the browser keeps running and will eventually fail to show the page.
* When you check the web server access log, its size has become so big (in some cases, more than 2 GB).
* When you check the web server access log, its size has become quite big (in some cases, more than 2 GB).
* Inside the access log, you get this message filling the log.
* Inside the access log, you get this message filling the log:


Warning: fread() [function.fread]: Length parameter must be greater than 0 in /limesurvey/classes/php-gettext/streams.php on line 120
{{Alert|title=Warning|text=''fread() [function.fread]: Length parameter must be greater than 0 in /limesurvey/classes/php-gettext/streams.php on line 120.}}''


''Note:'' line number may be different depending on your LimeSurvey version.
{{Note|The line number may be different depending on your LimeSurvey version.}}


===Fix===
===Fix===
Line 114: Line 108:
mbstring.func_overload = 0
mbstring.func_overload = 0


''Note:'' This means no function overloading. See PHP manual for this setting: [http://us3.php.net/manual/en/mbstring.overload.php Function Overloading Feature]
{{Note|This means no function overloading. See the PHP manual for this setting: [http://us3.php.net/manual/en/mbstring.overload.php Function Overloading Feature].}}


==When accessing admin page, the browser reports Fatal error: Call to a member function gT() on a non-object in login_check.php on line 76==
==When accessing admin page, the browser reports Fatal error: Call to a member function gT() on a non-object in login_check.php on line 76==


===Symptoms===
===Symptoms===
* LimeSurvey installed OK and database was created. But when rdirected to the admin page, the browser displayed the the listed error.
* LimeSurvey installed OK and database was created. But when redirected to the admin page, the browser displayed the the listed error.
* $rootdir and $rooturl are correctly set in config.php.
* <code>$rootdir</code> and <code>$rooturl</code> are correctly set in config.php.
* The disk path name for limesurvey installation directory includes one of the following characters: ()+
* The disk path name for limesurvey installation directory includes one of the following characters: '''(''',''')''' or '''+'''.


''Note:'' Other characters may also induce the same behaviour
{{Note|Other characters may also induce the same behaviour.}}


===Fix===
===Fix===


Move / rename the limesurvey installation directory so that pathname does not include either the '''(''' or ''')''' characters
Move/rename the limesurvey installation directory so that the path name includes non of the following characters: '''(''', ''')''' or '''+''' characters.


=After installation=  
=After installation=  


For all issues happening after a successful installation please refer to the [[Troubleshooting]] page.
For all issues happening after a successful installation, please refer to the [[Troubleshooting]] page.

Revision as of 15:10, 7 August 2017

Contents:

Installation on your computer

LimeSurvey can be installed on your computer with MAMP/XAMP or any other system. But your computer is not a web server - it's not accessible via web to any other user.

In order to make your survey reachable to other users via the web, you need to either:

  • own a server or a web space from a host provider;
  • or find a LimeSurvey-specialized host provider.
  An installation on your computer is not done to share your survey on internet!


Starting installation

How can I create a database and a user in MySQL with command line access?

You have to enter the below commands in your MySQL:

  • create database <your_database_name>;
  • create user <your_database_username>;
  • create user <your_database_username>@localhost;
  • set password for <your_database_username> = PASSWORD('<your_database_password>');
  • set password for <your_database_username>@localhost = PASSWORD('<your_database_password>');
  • grant all on <your_database_name>.* to '<your_database_username>';
  • grant all on <your_database_name>.* to '<your_database_username>'@'localhost';

In terminal, <your_database_name>, <your_database_username>, and <your_database_password> have to be replaced with the according/desired values.

我應該設定甚麼權限?

Normally, the script creates a new database, and then the table structure. However, if your server/ISP doesn't give you admin rights to create a new database in MySQL, you will need to contact your server administrator to get the necessary database created (or create it yourself if you receive the required permissions). The newly created blank database should include the appropriate access rights (i.e.: read/write/create). Then, you should be able start the LimeSurvey installation, which will create the tables within the newly created database.

Blank page when accessing the Install page

The problem is not with the LimeSurvey installation but with the PHP installation.

  • Verify you have the MySQL PHP module (php-mysql) installed.
  • Verify your PHP install is loading the PHP.ini file your are modifying and not parsing other PHP.INI files on your system.
  • Verify the location and permissions of the following setting in your PHP.ini:
upload_tmp_dir="/temp"

session.save_path="/temp"
  • Verify if your server runs a suitable PHP version.

Error messages because of non-existing resources

Sometimes, files are not uploaded correctly or were broken during the upload process. This leads to several different error messages. Most of them refer to a file or function within a file which can't be found.

Solution: Re-upload all files using the binary mode of your FTP program.

Requirements page

What is the mbstring (Multibyte String Functions) library?

The mbstring library is a PHP library that can convert char sets from one language to another. You need it if you want to run LimeSurvey. To check if it is already installed, open the URL from an web browser:

http://<your_server>/<your_limesurvey_directory>/admin/install/phpinfo.php

A lot of information will be shown. Search for the string 'mbstring' under the Configuration section. If you find the mbstring section then all should be well and you can continue on with your LimeSurvey installation!

If you don't find the mbstring section, you might have a problem on your hands. There are three possible scenarios:

  • If it's your host provider's server, ask for the activation of that extension in PHP or further information on how you can activate it - if you have a good administration panel for your server, you may be able to activate it yourself;
  • If it's your own Linux server, you may have to re-compile PHP and include the mbstring library. Ask the Linux experts how to do that. However, you can install it using your Linux package manager, which is mostly available in all Linux distributions nowadays;
    • If you are using a version of Linux that supports 'yum' (CentOS, RedHat, Fedora):
      • Use the terminal (as a super user) and type: yum install php-mbstring;
      • Make sure to update /etc/php.ini and uncomment the various mbstring params;
      • Make sure to restart apache after installing it: /etc/init.d/httpd restart;
  • If it's your own Windows server, search for php.ini on your system, open it with an editor and search for mbstring. Most probably, the line that contains that string is commented out with a semicolon. Remove the semicolon, save, and restart your web server.

Stuck at checking file system permissions

If SELinux is activated (primarily on CentOS), then you might get an error that the file system permissions are not correct, even if the list of directories is empty. SELinux prevents writing even though the permissions are on for example on 777 or 755. To configure SELinux correctly for your server - check out the SELinux documentation.

After database creation

Blank page after database creation

Symptoms

  • LimeSurvey installed OK, and database was created, but instead of the admin page, you get an empty page
  • Web server log shows "Fatal error: Call to a member function on a non-object in /path/to/limesurvey/admin/login_check.php on line 69"

Fix

This is probably related to an incorrect setting for $rooturl or $rootdir in config.php. The file config.php attempts to set $rootdir correctly by calling dirname('''FILE'''). While this usually works, it can be upset when LimeSurvey is installed in a user's home or public_html directory and the home directory is mounted over NFS. To set up manually the $rootdir, (your shell or pwd command may show you a path like "/disks/hostname/home/username/public_html/limesurvey"), try using "/home/username/public_html/limesurvey".

When accessing the admin page, the browser keeps running and will eventually fail to show it

Symptoms

  • LimeSurvey installed OK and the database was created. But when you access the admin page, the browser keeps running and will eventually fail to show the page.
  • When you check the web server access log, its size has become quite big (in some cases, more than 2 GB).
  • Inside the access log, you get this message filling the log:
  Warning : fread() [function.fread]: Length parameter must be greater than 0 in /limesurvey/classes/php-gettext/streams.php on line 120.

The line number may be different depending on your LimeSurvey version.

Fix

This may be caused by the mbstring.func_overload setting. Check the setting in your php.ini and set as the following.

mbstring.func_overload = 0

This means no function overloading. See the PHP manual for this setting: Function Overloading Feature.

When accessing admin page, the browser reports Fatal error: Call to a member function gT() on a non-object in login_check.php on line 76

Symptoms

  • LimeSurvey installed OK and database was created. But when redirected to the admin page, the browser displayed the the listed error.
  • $rootdir and $rooturl are correctly set in config.php.
  • The disk path name for limesurvey installation directory includes one of the following characters: (,) or +.
Other characters may also induce the same behaviour.

Fix

Move/rename the limesurvey installation directory so that the path name includes non of the following characters: (, ) or + characters.

After installation

For all issues happening after a successful installation, please refer to the Troubleshooting page.