Add section about utf8mb4 database encoding

Dominik Sander 9 years ago
parent
commit
3133e08e5d
2 changed files with 9 additions and 4 deletions
  1. 7 2
      doc/install/installation.md
  2. 2 2
      doc/install/requirements.md

+ 7 - 2
doc/install/installation.md

@@ -178,16 +178,21 @@ You are done installing the database and can go back to the rest of the installa
178 178
 If you are using a local MySQL server the database configuration should look like this (use the password of the huginn MySQL user you created earlier):
179 179
 
180 180
     DATABASE_ADAPTER=mysql2
181
-    DATABASE_ENCODING=utf8
182 181
     DATABASE_RECONNECT=true
183 182
     DATABASE_NAME=huginn_production
184 183
     DATABASE_POOL=20
185 184
     DATABASE_USERNAME=huginn
186
-    DATABASE_PASSWORD=""
185
+    DATABASE_PASSWORD='$password'
187 186
     #DATABASE_HOST=your-domain-here.com
188 187
     #DATABASE_PORT=3306
189 188
     #DATABASE_SOCKET=/tmp/mysql.sock
190 189
 
190
+    DATABASE_ENCODING=utf8
191
+    # MySQL only: If you are running a MySQL server >=5.5.3, you should
192
+    # set DATABASE_ENCODING to utf8mb4 instead of utf8 so that the
193
+    # database can hold 4-byte UTF-8 characters like emoji.
194
+    #DATABASE_ENCODING=utf8mb4
195
+
191 196
 **Important**: Uncomment the RAILS_ENV setting to run Huginn in the production rails environment
192 197
 
193 198
     RAILS_ENV=production

+ 2 - 2
doc/install/requirements.md

@@ -2,7 +2,7 @@
2 2
 
3 3
 ## Operating Systems
4 4
 
5
-### Supported Unix distributions
5
+### Supported Unix distributions by this guide
6 6
 
7 7
 - Ubuntu (12.04 and 14.04)
8 8
 - Debian (Jessie and Wheezy)
@@ -17,7 +17,7 @@
17 17
 - Gentoo
18 18
 - FreeBSD
19 19
 
20
-On the above unsupported distributions is still possible to install Huginn. Follow the [installation guide](./installation.md) and substitute the `apt` commands with the corresponding package manager commands of your distribution.
20
+On the above unsupported distributions is still possible to install Huginn, and many people do. Follow the [installation guide](./installation.md) and substitute the `apt` commands with the corresponding package manager commands of your distribution.
21 21
 
22 22
 ### Non-Unix operating systems such as Windows
23 23