Commit dc30e1ab authored by Joachim Mathes's avatar Joachim Mathes

TASK: Update documentation

parent b781b4e4
......@@ -35,9 +35,9 @@ Sections
* [Prerequisites](documentation/
* [Installation](documentation/
* [Deployment](documentation/
* [PhpStorm](documentation/phpstorm/
* [PhpStorm](documentation/
* [Workflow](documentation/
* [FreeBSD](documentation/freebsd/
* [FreeBSD](documentation/
[juggling_schorsch]: documentation/juggling_schorsch.png "Juggling Schorsch"
[juggling_schorsch]: documentation/images/juggling_schorsch.png "Juggling Schorsch"
Box administration
Box update
[phpstorm_mysql_general]: images/phpstorm_mysql_general.png "PhpStorm MySQL General"
[phpstorm_mysql_ssh]: images/phpstorm_mysql_ssh.png "PhpStorm MySQL SSH"
[phpstorm_mysql_typo3]: images/phpstorm_mysql_typo3.png "PhpStorm MySQL TYPO3"
......@@ -3,8 +3,6 @@ FreeBSD
![Cool Schorsch][cool_schorsch_and_beastie]
[cool_schorsch_and_beastie]: cool_schorsch_and_beastie.png "Cool Schorsch and Beastie"
......@@ -127,3 +125,6 @@ Log files can found in
[cool_schorsch_and_beastie]: images/cool_schorsch_and_beastie.png "Cool Schorsch and Beastie"
......@@ -37,4 +37,4 @@ The shell script
3. downloads and imports the `t3o` database from ``.
4. restarts `php-fpm`
[throwing_schorsch]: throwing_schorsch.png "Throwing Schorsch"
[throwing_schorsch]: images/throwing_schorsch.png "Throwing Schorsch"
......@@ -34,8 +34,8 @@ Options configuration
* Make sure to activate _Upload external changes_, so file changes induced by `grunt` will be recognized as well.
[workspace]: workspace.png "Workspace"
[add]: deployment_add.png "PhpStorm add deployment"
[connection]: deployment_connection.png "PhpStorm deployment connection"
[mappings]: deployment_mappings.png "PhpStorm deployment mappings"
[options]: deployment_options.png "PhpStorm deployment options"
[workspace]: images/workspace.png "Workspace"
[add]: images/deployment_add.png "PhpStorm add deployment"
[connection]: images/deployment_connection.png "PhpStorm deployment connection"
[mappings]: images/deployment_mappings.png "PhpStorm deployment mappings"
[options]: images/deployment_options.png "PhpStorm deployment options"
......@@ -4,7 +4,9 @@ Workflow
* Run `composer` inside the box, since the relevant dependencies and environment is probably not provided by your host system.
* Run `composer`, `npm` and `grunt` inside the box, since the relevant dependencies and environment are probably
not provided by your host system or maybe in a wrong version.
The composer extension update workflow
......@@ -17,3 +19,104 @@ the main project is:
2. Run `composer update vendor/foobar` in the main project inside the box.
3. Download the updated `composer.lock` from the box to your host.
4. Commit and push `composer.lock` in the main project.
Grunt watch
Enter the box and run:
sudo su - proserver
cd /var/www/t3o/html/typo3conf/ext/t3olayout/Resources/Private
./node_modules/grunt-cli/bin/grunt watch
Database management systems
Besides the command line tool `mysql` there are a lot of database management systems (DBMS) like:
* [PhpStorm]( (multi-platform)
* [DBeaver]( (multi-platform)
* [Sequel Pro]( (MacOS)
The box database is probably not accessible from your host system, but all modern DBMS allow SSH tunneling.
As an example we show how to connect to the database as MySQL user `root` with PhpStorm.
1. Click the Database button on the upper right side of PhpStorm and a database connection by clicking the plus.
2. Add the general database credentials. The MySQl root password can be found inside the box in file
sudo cat /usr/local/etc/mysql-password
![PhpStorm MySQL General][phpstorm_mysql_general]
3. Enter the SSH tunnel credentials:
![PhpStorm MySQL SSH][phpstorm_mysql_ssh]
4. Test the connection and confirm you adjustments.
5. Now, you should be able to edit database tables.
![PhpStorm MySQL TYPO3][phpstorm_mysql_typo3]
Box update
![juggling schorsch][juggling_schorsch]
If you run `vagrant up` and vagrant answers with
Bringing machine 'default' up with 'virtualbox' provider...
==> default: Checking if box 'punktde/proserver-developer-box' is up to date...
==> default: A newer version of the box 'punktde/proserver-developer-box' is available! You currently
==> default: have version '1.0.0'. The latest is version '1.1.0'. Run
==> default: `vagrant box update` to update.
==> default: Machine already provisioned. Run `vagrant provision` or use the `--provision`
==> default: flag to force provisioning. Provisioners marked to run always will still run.
a new box is available for you!
As the message kindly remarks run
vagrant box update
to download the latest box version:
==> default: Checking for updates to 'punktde/proserver-developer-box'
default: Latest installed version: 1.0.0
default: Version constraints:
default: Provider: virtualbox
==> default: Updating 'punktde/proserver-developer-box' with provider 'virtualbox' from version
==> default: '1.0.0' to '1.1.0'...
==> default: Loading metadata for box ''
==> default: Adding box 'punktde/proserver-developer-box' (v1.1.0) for provider: virtualbox
default: Downloading:
default: Progress: 9% (Rate: 6911k/s, Estimated time remaining: 0:05:47)
Check, if you have any uncommitted code inside your box and make sure to store it anywhere outside the box by using
git, for example. Then run:
vagrant destroy
vagrant up
to boot the latest box.
Continue with [Installation]( to initialize the project.
Vagrant does not remove obsolete base boxes automatically. But, since they occupy quite some
space you should remove them by yourself from time to time. `vagrant box list` lists all of your
vagrant boxes:
punktde/proserver-developer-box (virtualbox, 1.0.0)
punktde/proserver-developer-box (virtualbox, 1.1.0)
As version `1.0.0` is not used anymore, remove it by running:
vagrant box remove punktde/proserver-developer-box --box-version 1.0.0
[juggling_schorsch]: documentation/images/juggling_schorsch.png "Juggling Schorsch"
[phpstorm_mysql_general]: images/phpstorm_mysql_general.png "PhpStorm MySQL General"
[phpstorm_mysql_ssh]: images/phpstorm_mysql_ssh.png "PhpStorm MySQL SSH"
[phpstorm_mysql_typo3]: images/phpstorm_mysql_typo3.png "PhpStorm MySQL TYPO3"
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment