Differential D19985 Diff 56795 devel/zanata-platform/files/pkg-message.in

Changeset View

Standalone View

devel/zanata-platform/files/pkg-message.in

Property	Old Value	New Value
fbsd:nokeywords	null	yes \ No newline at end of property
svn:eol-style	null	native \ No newline at end of property
svn:mime-type	null	text/plain \ No newline at end of property

				================================================================================

				Zanata platform uses these components:
				WildFly - Zanata application (.war) is deployed here
				MySQL database
				ClamAV

				When running it for the first time, the following steps are necessary.

				# MySQL

				After running the MySQL server, create a database/username for Zanata, example:
				mysql> CREATE DATABASE zanata /!40100 DEFAULT CHARACTER SET utf8 /;
				mysql> CREATE USER 'zanata'@'localhost' IDENTIFIED BY 'zanatapw';
				mysql> GRANT ALL ON zanata.* TO 'zanata'@'localhost';

				# WildFly

				A WildFly config sample file for Zanata is installed in
				%%APP_HOME%%/standalone/configuration/standalone-zanata.xml.sample
				you need to copy it to %%APP_HOME%%/standalone/configuration/standalone.xml and
				then configure it properly. The main attention points are:
				- Database credentials
				- SMTP authentication

				# Zanata Startup

				To enable Zanata, put the following lines in /etc/rc.conf:
				%%WILDFLYV%%_enable="YES"
				lwhsuUnsubmitted Done Inline Actions Perhaps we also need to guide user to edit /etc/rc.conf or use sysrc(8). lwhsu: Perhaps we also need to guide user to edit /etc/rc.conf or use sysrc(8).
				mysql_enable="YES" # If it's running on the same machine
				clamav_freshclam_enable="YES" # If you are using antivirus
				clamav_clamd_enable="YES"

				# Admin user

				After running Zanata for the first time, you need to execute this script to
				create an admin user, remember to change the password:
				$ fetch https://raw.githubusercontent.com/zanata/zanata-platform/master/server/docker/conf/admin-user-setup.sql \
				-o /tmp
				$ mysql -u<username> -p<password> zanata < /tmp/admin-user-setup.sql

				*******************************************************
				* Remember to change the admin password and API token *
				*******************************************************
				matUnsubmitted Not Done Inline Actions This file is really, really, really too long, nobody will ever read it (and probably never see it either). All this should probably be removed, keep only the link, it probably contains all of this. mat: This file is really, really, really too long, nobody will ever read it (and probably never see…
				dbaioAuthorUnsubmitted Done Inline Actions The instructions are fragmented, we don't have a single link for it. What about removing this from pkg-message and install instructions into DATADIR? And inform users about it in the pkg-message? dbaio: The instructions are fragmented, we don't have a single link for it. What about removing this…
				lwhsuUnsubmitted Not Done Inline Actions While I feel it's fine to have all these in pkg-message, how about this: let's put these instructions on wiki and put the link here? lwhsu: While I feel it's fine to have all these in pkg-message, how about this: let's put these…
				dbaioAuthorUnsubmitted Done Inline Actions For me it's fine. We can copy Jenkins structure and insert a Install page: https://wiki.freebsd.org/Zanata --> Home (to be written) https://wiki.freebsd.org/Zanata/Setup --> Setup instructions like Jenkins (to be written) https://wiki.freebsd.org/Zanata/Install --> Port install instructions here! dbaio: For me it's fine. We can copy Jenkins structure and insert a Install page: https://wiki.
				lwhsuUnsubmitted Not Done Inline Actions I think it's fine. lwhsu: I think it's fine.

				More information about the installation process at:
				http://docs.zanata.org/en/release/user-guide/system-admin/configuration/installation/

				===============================================================================