# Copyright 1999-2018 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 EAPI="6" # Maintainer notes: # - This ebuild uses Bundler to download and install all gems in deployment mode # (i.e. into isolated directory inside application). That's not Gentoo way how # it should be done, but GitLab has too many dependencies that it will be too # difficult to maintain them via ebuilds. # USE_RUBY="ruby23" EGIT_REPO_URI="https://gitlab.com/gitlab-org/${PN}.git" EGIT_COMMIT="v${PV}" EGIT_CHECKOUT_DIR="${WORKDIR}/all" inherit eutils git-r3 ruby-ng user systemd GITLAB_GITALY_VERSION="0.66.0" GITLAB_PAGES_VERSION="0.6.1" GITLAB_SHELL_VERSION="5.11.0" GITLAB_WORKHORSE_VERSION="3.3.1" DESCRIPTION="GitLab is a free project and repository management application" HOMEPAGE="https://about.gitlab.com/" RESTRICT="mirror" LICENSE="MIT" SLOT="0" KEYWORDS="~amd64 ~x86 ~arm64" IUSE="kerberos mysql +postgres +unicorn systemd pages rugged_use_system_libraries" ## Gems dependencies: # charlock_holmes dev-libs/icu # grape, capybara dev-libs/libxml2, dev-libs/libxslt # rugged dev-util/cmake, virtual/pkgconfig # json dev-util/ragel # pygments.rb python 2.7+ # execjs net-libs/nodejs, or any other JS runtime # pg dev-db/postgresql # mysql virtual/mysql # GEMS_DEPEND=" dev-libs/icu dev-libs/libxml2 dev-libs/libxslt dev-libs/re2 dev-util/ragel >=net-libs/nodejs-4.3.0 >=sys-apps/yarn-0.17.0 postgres? ( >=dev-db/postgresql-9.6:* ) mysql? ( virtual/mysql ) kerberos? ( virtual/krb5 )" CDEPEND=" dev-util/cmake virtual/pkgconfig" COMMON_DEPEND=" ${GEMS_DEPEND} ~dev-vcs/gitlab-shell-${GITLAB_SHELL_VERSION} >=dev-vcs/git-2.8.4 ~www-servers/gitlab-workhorse-${GITLAB_WORKHORSE_VERSION} kerberos? ( !app-crypt/heimdal ) rugged_use_system_libraries? ( net-libs/http-parser dev-libs/libgit2:0/26 ) pages? ( ~www-servers/gitlab-pages-${GITLAB_PAGES_VERSION} ) ~www-servers/gitlab-gitaly-${GITLAB_GITALY_VERSION}" DEPEND=" ${CDEPEND} ${COMMON_DEPEND}" RDEPEND=" ${COMMON_DEPEND} >=dev-db/redis-2.8 virtual/mta systemd? ( sys-apps/systemd:0= )" ruby_add_bdepend " virtual/rubygems >=dev-ruby/bundler-1.15.4" # # fix-sendmail-config: # Fix default settings to work with ssmtp that doesn't know '-t' argument. # fix-redis-config-path: # Point to the absolute location of redis_config.rb # PATCHES=( "${FILESDIR}/01-${PN}-8.7.5-fix-sendmail-config.patch" "${FILESDIR}/02-${PN}-9.0.0-fix-redis-config-path.patch" "${FILESDIR}/03-${PN}-10.2.8-database.yml.patch" "${FILESDIR}/04-${PN}-9.3.0-fix-check-task.patch" "${FILESDIR}/05-${PN}-9.0.0-replace-sys-filesystem.patch" "${FILESDIR}/06-${PN}-8.17.0-fix-webpack-config.patch" "${FILESDIR}/08-${PN}-10.4.4-general-config.patch" ) MY_NAME="gitlab" MY_USER="git" # should be same as in gitlab-shell DEST_DIR="/opt/${MY_NAME}" CONF_DIR="/etc/${MY_NAME}" LOGS_DIR="/var/log/${MY_NAME}" TEMP_DIR="/var/tmp/${MY_NAME}" all_ruby_unpack() { git-r3_fetch git-r3_checkout } all_ruby_prepare() { # fix paths sed -i \ -e "s|/home/git/gitlab/tmp|/run/${MY_NAME}|g" \ lib/support/nginx/gitlab || die "failed to filter nginx/gitlab" # modify default database settings for PostgreSQL sed -i -E \ -e 's|(username:).*|\1 gitlab|' \ -e 's|(password:).*|\1 gitlab|' \ -e 's|(socket:).*|\1 /run/postgresql/.s.PGSQL.5432|' \ config/database.yml.postgresql \ || die "failed to filter database.yml.postgresql" # rename config files mv config/gitlab.yml.example config/gitlab.yml mv config/unicorn.rb.example config/unicorn.rb local dbconf=config/database.yml if use postgres && ! use mysql; then mv ${dbconf}.postgresql ${dbconf} rm ${dbconf}.mysql elif use mysql && ! use postgres; then mv ${dbconf}.mysql ${dbconf} rm ${dbconf}.postgresql fi # remove useless files rm -r lib/support/{deploy,init.d} use unicorn || rm config/unicorn.rb } all_ruby_install() { local dest=${DEST_DIR} local conf=${CONF_DIR} local logs=${LOGS_DIR} local temp=${TEMP_DIR} # prepare directories diropts -m750 dodir ${logs} ${temp} diropts -m755 dodir ${conf} ${dest}/public/uploads dosym ${temp} ${dest}/tmp dosym ${logs} ${dest}/log # install configs insinto ${conf} doins -r config/* dosym ${conf} ${dest}/config echo 'export RAILS_ENV=production' > "${D}/${dest}/.profile" # remove needless dirs rm -Rf config tmp log # install the rest files # using cp 'cause doins is slow cp -Rl * "${D}/${dest}"/ cp -Rl .??* "${D}/${dest}"/ # install logrotate config dodir /etc/logrotate.d cat > "${D}/etc/logrotate.d/${MY_NAME}" <<-EOF ${logs}/*.log { missingok delaycompress compress copytruncate } EOF ## Install gems via bundler ## cd "${D}/${dest}" local without="development test aws" local flag; for flag in mysql postgres unicorn kerberos; do without+="$(use $flag || echo ' '$flag)" done local bundle_args="--deployment ${without:+--without ${without}}" use "rugged_use_system_libraries" && export RUGGED_USE_SYSTEM_LIBRARIES="YES" einfo "Running bundle install ${bundle_args} ..." ${RUBY} /usr/bin/bundle install ${bundle_args} || die "bundler failed" einfo "Cleaning old gems ..." ${RUBY} /usr/bin/bundle clean # clean gems cache rm -Rf vendor/bundle/ruby/*/cache rm -Rf vendor/bundle/ruby/*/bundler/gems/charlock_holmes-dde194609b35/.git ## RC script ## if use systemd ; then ewarn "Beware: systemd support has not been tested, use at your own risk!" systemd_newunit "${FILESDIR}/gitlab-8.13.0-sidekiq.service" "gitlab-sidekiq.service" systemd_dounit "${FILESDIR}/gitlab-unicorn.service" systemd_dounit "${FILESDIR}/gitlab-workhorse.service" systemd_dounit "${FILESDIR}/gitlab-mailroom.service" systemd_dotmpfilesd "${FILESDIR}/gitlab.conf" else local rcscript=gitlab-10.4.4-sidekiq.init use unicorn && rcscript=gitlab-10.4.4-unicorn.init cp "${FILESDIR}/${rcscript}" "${T}" || die sed -i \ -e "s|@USER@|${MY_USER}|g" \ -e "s|@GITLAB_BASE@|${dest}|g" \ -e "s|@LOGS_DIR@|${logs}|g" \ "${T}/${rcscript}" \ || die "failed to filter ${rcscript}" newinitd "${T}/${rcscript}" "${MY_NAME}" fi # fix permissions fowners -R ${MY_USER}:${MY_USER} ${dest} ${temp} ${logs} } pkg_postinst() { elog "If this is an update from a previous version, stop your GitLab" elog "instance and issue the following command to perform all required" elog "migrations:" elog " emerge --config \"=${CATEGORY}/${PF}\"" elog "PLEASE NOTE: It's HIGHLY recommended to backup your database" elog "before running the config phase. Run these commands (as root):" elog elog " cd /opt/gitlab" elog " sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production" elog elog "If you're using OpenRC, you can use the following command:" elog elog " /etc/init.d/gitlab backup" elog elog "If this was a fresh install, follow these steps:" elog elog "1. Configure your GitLab's settings in ${CONF_DIR}/gitlab.yml." elog elog "2. Configure your database settings in ${CONF_DIR}/database.yml" elog " for \"production\" environment." elog elog "3. Then you should create a database for your GitLab instance, if you" elog " haven't done so already." elog if use postgres; then elog "If you have local PostgreSQL running, just copy&run:" elog " su postgres" elog " psql -c \"CREATE ROLE gitlab PASSWORD 'gitlab' \\" elog " NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN;\"" elog " createdb -E UTF-8 -O gitlab gitlabhq_production" elog " Note: You should change your password to something more random..." elog fi elog "4. Finally execute the following command to initialize the environment:" elog " emerge --config \"=${CATEGORY}/${PF}\"" elog " Note: Do not forget to start Redis server first!" elog elog "If you're running GitLab behind an SSL proxy such as nginx or Apache and" elog "you can't login after the upgrade, be sure to read the section about the" elog "verification of the CSRF token in GitLab's trouble-shooting guide at" elog "http://goo.gl/5XGRGv." if use postgres; then elog "Please note: As of GitLab 8.6, users of PostgreSQL need to enable the" elog "`pg_trgm` extension by running the following command as a PostgreSQL" elog "super user for *every* GitLab database:" elog " CREATE EXTENSION IF NOT EXISTS pg_trgm;" elog "For details, see the documentation at the GitLab website." fi if use mysql ; then ewarn "You must grant the GitLab user permissions the following on the database:" ewarn " mysql -u root -p -e \\" ewarn " \"GRANT TRIGGER ON \`gitlab\`.* TO 'gitlab'@'localhost';\"" ewarn "PLEASE also read this document about needed migrations on MySQL:" ewarn ewarn "https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/database_mysql.md" ewarn ewarn "Failing to follow those instructions may make the config phase fail!" fi } pkg_config() { einfo "Checking configuration files" if [ ! -r "${CONF_DIR}/database.yml" ]; then eerror "Copy ${CONF_DIR}/database.yml.* to" eerror "${CONF_DIR}/database.yml and edit this file in order to configure your" eerror "database settings for \"production\" environment." die fi local email_from="$(ryaml ${CONF_DIR}/gitlab.yml production gitlab email_from)" local git_home="$(egethome ${MY_USER})" # configure Git global settings if [ ! -e "${git_home}/.gitconfig" ]; then einfo "Setting git user" su -l ${MY_USER} -c " git config --global user.email '${email_from}'; git config --global user.name 'GitLab'" \ || die "failed to setup git name and email" fi su -l ${MY_USER} -c "git config --global repack.writeBitmaps true" # determine whether this is an update or a fresh install. we do this by # checking whether the ${DEST_DIR}/.git directory exists or not # if [ -d "${DEST_DIR}/.git" ]; then local update=true else local update=false fi if use mysql ; then ewarn "Please only proceed if you've read and understood the following page:" ewarn "https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/database_mysql.md" if [ "${update}" = 'true' ]; then ewarn "Failing to follow those instructions may cause the upgrade to fail" fi ewarn fi ewarn "Now is a good time to create a backup of your Gitlab installation, just in case." ewarn "To do so, abort this configuration with Ctrl+C and type the following commands:" ewarn " cd /opt/gitlab" ewarn " sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production" ewarn ewarn "Press Ctrl+C to abort now or any key to continue." read ## Initialize app ## local RAILS_ENV="production" local RUBY=${RUBY:-/usr/bin/ruby} local BUNDLE="${RUBY} /usr/bin/bundle" if [ "${update}" = 'true' ]; then einfo "Migrating database ..." exec_rake db:migrate einfo "Compiling GetText PO files ..." exec_rake gettext:compile # https://github.com/gitlabhq/gitlabhq/issues/5311#issuecomment-31656496 einfo "Migrating iids ..." exec_rake migrate_iids einfo "Installing npm modules ..." exec_rake yarn:install einfo "Cleaning old precompiled assets ..." exec_rake gitlab:assets:clean einfo "Cleaning cache ..." exec_rake cache:clear else # create dummy git repo as workaround for # https://github.com/bundler/bundler/issues/2039 einfo "Initializing dummy git repository to avoid false errors from bundler" su -l ${MY_USER} -c " cd ${DEST_DIR} git init git add README.md git commit -m 'Dummy repository'" >/dev/null einfo "Initializing database ..." exec_rake gitlab:setup einfo "Compiling GetText PO files ..." exec_rake gettext:pack exec_rake gettext:po_to_json einfo "Installing npm modules ..." exec_rake yarn:install fi einfo "Precompiling assests ..." exec_rake gitlab:assets:compile if [ "${update}" = 'true' ]; then ewarn ewarn "This configuration script runs only common migration tasks." ewarn "Please read guides on" ewarn " https://github.com/gitlabhq/gitlabhq/blob/master/doc/update/" ewarn "for any additional migration tasks specific to your previous GitLab" ewarn "version." fi elog elog "If you want to make sure that the install/upgrade was successful, start" elog "Gitlab now and then run these commands (as root):" elog elog " cd /opt/gitlab" elog " sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production" elog " sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production" elog if ! use systemd ; then elog "You may also run" elog " /etc/init.d/gitlab check" elog " for convenience." fi } ryaml() { ruby -ryaml -e 'puts ARGV[1..-1].inject(YAML.load(File.read(ARGV[0]))) {|acc, key| acc[key] }' "$@" } exec_rake() { local command="${BUNDLE} exec rake $@ RAILS_ENV=${RAILS_ENV} NODE_ENV=${RAILS_ENV}" echo " ${command}" su -l ${MY_USER} -c " export LANG=en_US.UTF-8; export LC_ALL=en_US.UTF-8; export NODE_PATH=${DEST_DIR}/node_modules cd ${DEST_DIR} ${command}" \ || die "failed to run rake $@" }