== About ==
. Website: https://rocketgit.com
. Author: Catalin(ux) M. BOIE
. Description: Light and fast Git hosting solution
. License: Affero GPLv3+
. Language: PHP (plan to rewrite everything in C in the near future)
. Database: PostgreSQL
. Project start date: 2011-03-04


== Features ==
. Free software
. No Java
. No Javascript
. Upgrades with the standard tools of the distributions
. Very little dependencies, all packaged in main-stream distributions
. SELinux friendly
. Very small (RPM is around 400KiB)
. IPv6 ready
. Internationalization ready


== Install ==
. Install RocketGit from source (./configure && make && make install) or
	with a package manager:
	Fedora:
		dnf install http://kernel.embedromix.ro/dinorepo-0.0.10-1.noarch.rpm
		dnf install rocketgit
	CentOS/RedHat/Oracle
		yum install http://kernel.embedromix.ro/dinorepo-el-0.0.11-1.noarch.rpm
		yum install rocketgit

	Edit /etc/rocketgit/config.php
	Edit /etc/rocketgit/php-fpm.conf
	Edit /etc/rocketgit/pool.conf

. Activate rocketgit php-fpm:
	systemctl enable --now rocketgit-fpm

. PHP
	Adjust php.ini to:
		- allow enough RAM and execution time
		- fix timezone (date.timezone = UTC, for example)
	You may want to activate an op cache to speed up the PHP scripts:
		apt/yum/dnf install php-opcache
	Also, we recommend to activate opcache also for cli:
	change opcache.enable_cli to 1 in /etc/php.d/10-opcache.ini and
	/etc/php-zts.d/10-opcache.ini.

. Install and prepare a web server: nginx/apache:
	nginx is recommended because of the chunked encoding in POST requests.
	apt/yum/dnf install nginx
	or
	apt/yum/dnf install httpd mod_ssl

	Edit /etc/nginx/conf.d/rocketgit.conf
	(or /etc/httpd_or_apache2/conf.d/rocketgit.com).
	Pay attention to the path to the certificate:
	Debian like: use /etc/ssl/certs/ssl-cert-snakeoil.pem and
		/etc/ssl/private/ssl-cert-snakeoil.key for a self signed cert.

	Activate web server (nginx)
		systemctl enable nginx.service
		systemctl restart nginx.service

	Or activate Apache web server
		systemctl enable httpd.service
		systemctl restart httpd.service

. Activate sshd (for ssh:// access)
	systemctl enable --now sshd.service

. Activate rocketgit-git.socket (for git:// access, optional)
	systemctl enable --now rocketgit-git.socket

. Prepare PostgreSQL server
	RedHat like: yum/dnf install postgresql-server
	Debian like: apt install postgresql

	Add the following lines, before wildcard matches, in
	RedHat like: /var/lib/pgsql/data/pg_hba.conf:
	Debian like: /etc/postgresql/*/main/pg_hba.conf:

	local	rocketgit	rocketgit			trust
	host 	rocketgit	rocketgit	127.0.0.1/32	trust
	host 	rocketgit	rocketgit	::1/128		trust

	RedHat like:
	export PGSETUP_INITDB_OPTIONS="--data-checksums" # recommended
	postgresql-setup --initdb # (TAKE CARE! YOU MAY DESTROY ALL YOUR DATA!)
	systemctl enable postgresql.service
	systemctl start postgresql.service

	Debian like: TODO

	Notes:
	- Check also the config file (/etc/rocketgit/config.php) and set
	correctly the rg_sql string.
	- If the web server and the db are not on the same host, you need to
	replace 127.0.0.1 and ::1 with your "safe network". You may want to use
	md5/etc. for authentication. Also, you may want to change
	'listen_addresses' to '*'. You should also want to activate SSL.

	# Create a PostgreSQL user and database
	su - postgres
	createuser --createdb --no-createrole --no-superuser rocketgit
	createdb -O rocketgit rocketgit

. Prepare the mail
	To be able to generate e-mails as other user, you have to:
	For sendmail:
		- Enable daemon:
			systemctl enable sendmail.service
		- Edit /etc/mail/trusted-users and add 'rocketgit' and 'apache'.
		- Restart daemon:
			systemctl restart sendmail.service

. Edit firewall to permit ssh, git, http and https ports
	In /etc/sysconfig/iptables (IPv4) and ip6tables (IPv6), add something
	like this:
		-A INPUT -m tcp -p tcp --dport ssh -j ACCEPT
		-A INPUT -m tcp -p tcp --dport git -j ACCEPT
		-A INPUT -m tcp -p tcp --dport http -j ACCEPT # optional
		-A INPUT -m tcp -p tcp --dport https -j ACCEPT

	If you use firewalld:
		firewall-cmd --permanent --add-port=ssh/tcp
		firewall-cmd --permanent --add-port=git/tcp
		firewall-cmd --permanent --add-port=http/tcp # optional
		firewall-cmd --permanent --add-port=https/tcp
		firewall-cmd --reload

. Point your browser to the newly created server and you will be asked to
	create the admin account.

. As admin user, go to Admin -> Settings and check if any setting should be
	tweaked. It is very important to set the 'Host name' value.

. Activate the builder service, if you want:
	systemctl enable --now rocketgit-builder

. Activate the worker service, if you want:
	systemctl enable --now rocketgit-worker@main


== Thanks ==
. Special thanks to my family that supports me in this project.
. Special thanks to my brother that contributed brain and time to this project.
. Special thanks to git people for the best tool to manage the sources.
. Special thanks to Petre Bandac for free hosting of rg2 server.
. Special thanks to a lot of people that came with suggestions.
. Special thanks to gitosys, Gitorious and other projects from where I learned
	things.
. Special thanks to OWASP for their good documentation on how to write a
	secure web application.
. See AUTHORS file for all the people who contributed to this project.