Skip to content

Latest commit

 

History

History
44 lines (40 loc) · 3.58 KB

general-installation-guide.md

File metadata and controls

44 lines (40 loc) · 3.58 KB

Installation Guide

You have 4 options:

  • If you want just to see the app, take a look at one of our environments like QA. You can register a user, create topics, code review, etc.
  • You can start a local virtual environment without pulluting your OS and without tedious configuration. See our JTalks VM project
  • If you'd like to run it locally, install the project from binaries (war file), see below.
  • If you want to contribute, you may want to build it from sources.

So if you want to run the app locally (from binaries or sources), you need to install basic environment:

####Installing from Binaries

  • Download latest version from our repository, you're interested in *.war files inside of directories.
  • Rename it to jcommune.war, put it into your $TOMCAT_HOME$/webapps (don't start Tomcat yet).
  • Now you need to configure DB access and other stuff. It's done via configuration file, the sample can be found here, its name should be the same as the war-file name and it should be placed into $TOMCAT_HOME/conf/Catalina/localhost. For more details, read comments inside of the file per se.
  • What's left is to start the Tomcat which is described in basic environment installation
  • If you don't want to install Poulpe to administrate the forum (create branches, give permissions to user groups), you can use our SQL files that fill DB for you so that you can test it. You'll need to apply these scripts.

####Building from sources

  • You'll need to install a dev environment (linux instructions, windows instructions). Alternatively to Git, you may want to download the sources directly as a zip if you don't have Git and you don't want to install it. This won't allow you to contribute to the project though.
  • Clone the project: [email protected]:jtalks-org/jcommune.git. Now you can work with that project from your IDE.
  • If you want to deploy it from command line.. Step into the folder and build it: mvn clean package
  • Repeat everything from Installing from Binaries but instead of downloading war-file, just grab it from jcommune/jcommune-view/jcommunew-web-view/target

####Advanced configuration of MySQL Server

  • Make sure that you are using MySQL Server ver. 5.7.9 or higher. Edit the my.cnf file (my.ini on Windows operating systems) in your MySQL server. The configuration file may be located on one of the following paths (in priority order): WINDOWS: - %PROGRAMDATA%\MySQL\MySQL Server X.X\my.ini (my.cnf) - %WINDIR%\my.ini (my.cnf) - C:\my.ini (my.cnf) - INSTALLDIR\my.ini (my.cnf) Unix, Linux и OS X: - /etc/my.cnf - /etc/mysql/my.cnf - SYSCONFDIR/my.cnf
  • Locate the [mysqld] section in the file, and add or modify the following parameters: [mysqld] character-set-client-handshake = FALSE character-set-server = utf8mb4 collation-server = utf8mb4_unicode_ci
  • Without making this changes symbols from UTF8MB4 character set will be displayed like '??'.
  • Restart your MySQL server for the changes to take effect.