bnf/typo3-project-template

TYPO3 CMS skeleton project (using git-push deployment)

dev-master 2018-10-02 21:06 UTC

Requires

• bnf/site: @dev
• bnf/typo3ctl: ~0.7.0
• typo3/cms-about: ^9.5
• typo3/cms-adminpanel: ^9.5
• typo3/cms-belog: ^9.5
• typo3/cms-beuser: ^9.5
• typo3/cms-context-help: ^9.5
• typo3/cms-extensionmanager: ^9.5
• typo3/cms-felogin: ^9.5
• typo3/cms-filelist: ^9.5
• typo3/cms-fluid-styled-content: ^9.5
• typo3/cms-form: ^9.5
• typo3/cms-impexp: ^9.5
• typo3/cms-info: ^9.5
• typo3/cms-info-pagetsconfig: ^9.5
• typo3/cms-install: ^9.5
• typo3/cms-lowlevel: ^9.5
• typo3/cms-reports: ^9.5
• typo3/cms-rsaauth: ^9.5
• typo3/cms-rte-ckeditor: ^9.5
• typo3/cms-setup: ^9.5
• typo3/cms-sys-note: ^9.5
• typo3/cms-t3editor: ^9.5
• typo3/cms-tstemplate: ^9.5
• typo3/cms-viewpage: ^9.5
• typo3/cms-wizard-crpages: ^9.5
• typo3/cms-wizard-sortpages: ^9.5

GPL-2.0+

• Benjamin Franzke

README

Installation

composer create-project --keep-vcs bnf/typo3-project-template:dev-master foo-project
cd foo-project/
composer config name your-vendor/foo-site-name
git rm README.md && git add composer.lock && git commit -m "Initialize foo-project"

# Now run a test server with
composer run --timeout=0 dev-server

touch public/FIRST_INSTALL
# Run through install tool
xdg-open http://127.0.0.1/typo3/install.php

# Add LocalConfiguration.php to git
git add public/typo3conf/LocalConfiguration.php && git commit -m "Add initial configuration"

Deployment setup

Deployment uses (a fork) of giddyup, a simple script that does fast and reliable deployment in a git hook (features symlink rotation and shared directories).

# Set to your servers hostname and path
REMOTE_HOST=user@remotehost
REMOTE_PATH=path/to/root
REMOTE_DB=whatever_prod

ssh $REMOTE_HOST "mkdir -p $REMOTE_PATH && git init --bare $REMOTE_PATH/repo && curl -s https://raw.githubusercontent.com/bnf/giddyup/master/update-hook > $REMOTE_PATH/repo/hooks/update && chmod +x $REMOTE_PATH/repo/hooks/update"
git remote add production $REMOTE_HOST:$REMOTE_PATH/repo

# Optional: In case you're using php-fpm with a custom socket path, configure the hook to use the correct fpm socket
ssh $REMOTE_HOST "git --git-dir=$REMOTE_PATH/repo config giddyup.fcgi-socket /run/php70-fpm-foo.sock"

# Upload shared content
rsync  -az -e ssh --verbose --include 'public/' --include 'public/fileadmin/***' --include='public/uploads/***' --exclude='*' ./ $REMOTE_HOST:$REMOTE_PATH/shared/

# Upload database
./vendor/bin/typo3cms database:export | ssh $REMOTE_HOST "mysql $REMOTE_DB"

# Initial code upload
git push production

Now point your webserver's document root to $REMOTE_PATH/current/public and from now on deploy with:

git push production